A Discrete-Event Network Simulator
API
event-id.h
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 #ifndef EVENT_ID_H
21 #define EVENT_ID_H
22 
23 #include <stdint.h>
24 #include "ptr.h"
25 #include "event-impl.h"
26 
33 namespace ns3 {
34 
35 class EventImpl;
36 
53 class EventId
54 {
55 public:
57  EventId ();
66  EventId (const Ptr<EventImpl> &impl, uint64_t ts, uint32_t context, uint32_t uid);
71  void Cancel (void);
77  bool IsExpired (void) const;
83  bool IsRunning (void) const;
84 
85 public:
93  EventImpl * PeekEventImpl (void) const;
95  uint64_t GetTs (void) const;
97  uint32_t GetContext (void) const;
99  uint32_t GetUid (void) const;
108  friend bool operator == (const EventId &a, const EventId &b);
115  friend bool operator != (const EventId &a, const EventId &b);
122  friend bool operator < (const EventId &a, const EventId &b);
123 
124 private:
126  uint64_t m_ts;
127  uint32_t m_context;
128  uint32_t m_uid;
129 };
130 
131 /*************************************************
132  ** Inline implementations
133  ************************************************/
134 
135 inline
136 bool
137 operator == (const EventId &a, const EventId &b)
138 {
139  return
140  a.m_uid == b.m_uid
141  && a.m_context == b.m_context
142  && a.m_ts == b.m_ts
143  && a.m_eventImpl == b.m_eventImpl;
144 }
145 
146 inline
147 bool
148 operator != (const EventId &a, const EventId &b)
149 {
150  return !(a == b);
151 }
152 
153 inline
154 bool
155 operator < (const EventId &a, const EventId &b)
156 {
157  return (a.GetTs () < b.GetTs ());
158 }
159 
160 } // namespace ns3
161 
162 #endif /* EVENT_ID_H */
uint32_t m_uid
The unique id.
Definition: event-id.h:128
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
ns3::EventImpl declarations.
uint64_t m_ts
The virtual time stamp.
Definition: event-id.h:126
ns3::Ptr smart pointer declaration and implementation.
EventImpl * PeekEventImpl(void) const
Definition: event-id.cc:71
bool IsExpired(void) const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
Definition: event-id.cc:59
bool operator<(const EventId &a, const EventId &b)
Definition: event-id.h:155
EventId()
Default constructor.
Definition: event-id.cc:35
Ptr< EventImpl > m_eventImpl
The underlying event implementation.
Definition: event-id.h:125
friend bool operator!=(const EventId &a, const EventId &b)
Test if two EventId&#39;s are not equal.
Definition: event-id.h:148
uint64_t GetTs(void) const
Definition: event-id.cc:77
bool operator!=(Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > a, Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 > b)
Inequality test.
Definition: callback.h:1592
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint32_t GetUid(void) const
Definition: event-id.cc:89
uint32_t GetContext(void) const
Definition: event-id.cc:83
A simulation event.
Definition: event-impl.h:44
An identifier for simulation events.
Definition: event-id.h:53
bool operator==(const EventId &a, const EventId &b)
Definition: event-id.h:137
bool IsRunning(void) const
This method is syntactic sugar for !IsExpired().
Definition: event-id.cc:65
void Cancel(void)
This method is syntactic sugar for the ns3::Simulator::Cancel method.
Definition: event-id.cc:53
friend bool operator<(const EventId &a, const EventId &b)
Less than operator for two EventId&#39;s, based on time stamps.
Definition: event-id.h:155
friend bool operator==(const EventId &a, const EventId &b)
Test if two EventId&#39;s are equal.
Definition: event-id.h:137
uint32_t m_context
The context.
Definition: event-id.h:127