A Discrete-Event Network Simulator
API
event-impl.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #include "event-impl.h"
22 #include "log.h"
23 
30 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("EventImpl");
33 
34 EventImpl::~EventImpl ()
35 {
36  NS_LOG_FUNCTION (this);
37 }
38 
39 EventImpl::EventImpl ()
40  : m_cancel (false)
41 {
42  NS_LOG_FUNCTION (this);
43 }
44 
45 void
46 EventImpl::Invoke (void)
47 {
48  NS_LOG_FUNCTION (this);
49  if (!m_cancel)
50  {
51  Notify ();
52  }
53 }
54 
55 void
56 EventImpl::Cancel (void)
57 {
58  NS_LOG_FUNCTION (this);
59  m_cancel = true;
60 }
61 
62 bool
63 EventImpl::IsCancelled (void)
64 {
65  NS_LOG_FUNCTION (this);
66  return m_cancel;
67 }
68 
69 } // namespace ns3
ns3::EventImpl::IsCancelled
bool IsCancelled(void)
Definition: event-impl.cc:63
ns3::EventImpl::EventImpl
EventImpl()
Default constructor.
Definition: event-impl.cc:39
ns3::EventImpl::Invoke
void Invoke(void)
Called by the simulation engine to notify the event that it is time to execute.
Definition: event-impl.cc:46
ns3::EventImpl::Cancel
void Cancel(void)
Marks the event as 'canceled'.
Definition: event-impl.cc:56
ns3::EventImpl::~EventImpl
virtual ~EventImpl()=0
Destructor.
Definition: event-impl.cc:34
ns3::EventImpl::Notify
virtual void Notify(void)=0
Implementation for Invoke().
ns3::EventImpl::m_cancel
bool m_cancel
Has this event been cancelled.
Definition: event-impl.h:79
event-impl.h
ns3::EventImpl declarations.
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
log.h
Debug message logging.
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.