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