author | Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
Mon, 02 Oct 2006 14:37:46 +0200 | |
changeset 111 | ad64f88919b5 |
parent 110 | 9ac6d63bfe33 |
child 122 | 6b8f1eda5c57 |
permissions | -rw-r--r-- |
110
9ac6d63bfe33
fix emacs tab mode (reported by george)
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
70
diff
changeset
|
1 |
/* -*- Mode:C++; c-basic-offset:4; tab-width:4; indent-tabs-mode:nil -*- */ |
25
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
2 |
/* |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
3 |
* Copyright (c) 2005 INRIA |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
4 |
* All rights reserved. |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
5 |
* |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
6 |
* This program is free software; you can redistribute it and/or modify |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
7 |
* it under the terms of the GNU General Public License version 2 as |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
8 |
* published by the Free Software Foundation; |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
9 |
* |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
10 |
* This program is distributed in the hope that it will be useful, |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
13 |
* GNU General Public License for more details. |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
14 |
* |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
15 |
* You should have received a copy of the GNU General Public License |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
16 |
* along with this program; if not, write to the Free Software |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
17 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
18 |
* |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
19 |
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
20 |
*/ |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
21 |
#ifndef EVENT_ID_H |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
22 |
#define EVENT_ID_H |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
23 |
|
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
24 |
#include <stdint.h> |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
25 |
|
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
26 |
namespace ns3 { |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
27 |
|
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
28 |
class EventImpl; |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
29 |
|
70
fcd8da09ef75
document EventId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
54
diff
changeset
|
30 |
/** |
fcd8da09ef75
document EventId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
54
diff
changeset
|
31 |
* \brief an identifier for simulation events. |
fcd8da09ef75
document EventId
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
54
diff
changeset
|
32 |
*/ |
25
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
33 |
class EventId { |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
34 |
public: |
54
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
35 |
EventId (); |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
36 |
EventId (EventImpl *impl, uint64_t ns, uint32_t uid); |
111
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
37 |
/** |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
38 |
* This method is syntactic sugar for the ns3::Simulator::cancel |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
39 |
* method. |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
40 |
*/ |
54
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
41 |
void cancel (void); |
111
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
42 |
/** |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
43 |
* This method is syntactic sugar for the ns3::Simulator::isExpired |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
44 |
* method. |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
45 |
* \returns true if the event has expired, false otherwise. |
ad64f88919b5
try to get rid of tabs which sneaked in
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
110
diff
changeset
|
46 |
*/ |
54
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
47 |
bool isExpired (void); |
25
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
48 |
public: |
54
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
49 |
/* The following methods are semi-private |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
50 |
* they are supposed to be invoked only by |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
51 |
* subclasses of the Scheduler base class. |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
52 |
*/ |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
53 |
EventImpl *getEventImpl (void) const; |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
54 |
uint64_t getNs (void) const; |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
55 |
uint32_t getUid (void) const; |
25
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
56 |
private: |
54
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
57 |
EventImpl *m_eventImpl; |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
58 |
uint64_t m_ns; |
f860e6f94787
change indent to be 4 spaces
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
53
diff
changeset
|
59 |
uint32_t m_uid; |
25
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
60 |
}; |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
61 |
|
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
62 |
}; // namespace ns3 |
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
63 |
|
9b3bb088c560
first cut at george's ideas on api
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
64 |
#endif /* EVENT_ID_H */ |