author | Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
Sun, 02 Mar 2008 21:12:21 +0100 | |
changeset 2532 | 86a40c7cbfe9 |
parent 1409 | 47b71e613bc2 |
permissions | -rw-r--r-- |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
1 |
#ifndef TRACE_CONTEXT_ELEMENT_H |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
2 |
#define TRACE_CONTEXT_ELEMENT_H |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
3 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
4 |
#include <string> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
5 |
#include <vector> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
6 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
7 |
#define NS_TRACE_CONTEXT_ELEMENT_ENSURE_REGISTERED(x) \ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
8 |
namespace { \ |
1236
cfa5e0b39281
rework the NS_XX_ENSURE_REGISTERED macros and make sure we typecheck the input to TraceContext::Add and TraceContext::Get methods
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1235
diff
changeset
|
9 |
static class thisisaveryverylongclassname ##x \ |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
10 |
{ \ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
11 |
public: \ |
1236
cfa5e0b39281
rework the NS_XX_ENSURE_REGISTERED macros and make sure we typecheck the input to TraceContext::Add and TraceContext::Get methods
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1235
diff
changeset
|
12 |
thisisaveryverylongclassname ##x () \ |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
13 |
{ uint32_t uid; uid = x::GetUid ();} \ |
1236
cfa5e0b39281
rework the NS_XX_ENSURE_REGISTERED macros and make sure we typecheck the input to TraceContext::Add and TraceContext::Get methods
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1235
diff
changeset
|
14 |
} g_thisisanotherveryveryverylongname ##x ; \ |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
15 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
16 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
17 |
namespace ns3 { |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
18 |
|
1254
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
19 |
/** |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
20 |
* \brief an item stored in a TraceContext |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
21 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
22 |
* To store trace context information in a TraceContext instance, |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
23 |
* users must subclass this base class and store subclass instances |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
24 |
* in a TraceContext with TraceContext::Add. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
25 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
26 |
* Each subclass should define and implement: |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
27 |
* - a public default constructor: it is used by the internals |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
28 |
* of the implementation of TraceContext. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
29 |
* - a public destructor: it is also used by the internals of |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
30 |
* the implementation of TraceContext. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
31 |
* - a public static method named GetUid which returns a 16 bit |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
32 |
* integer. The integer returned from this method should be |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
33 |
* allocated with the protected AllocatedUid method. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
34 |
* - a public Print method: this method is used by the |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
35 |
* TraceContext::Print method to print the content of each |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
36 |
* of the trace context element stored in the trace context. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
37 |
* This method takes a c++ output stream and argument and is |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
38 |
* expected to write an ascii string describing its content |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
39 |
* in this output stream. |
1409
47b71e613bc2
add missing requirement to doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1401
diff
changeset
|
40 |
* - a public GetTypeName method which returns the fully-qualified |
47b71e613bc2
add missing requirement to doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1401
diff
changeset
|
41 |
* c++ type name of this subclass as a string. |
1254
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
42 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
43 |
* A typical subclass should look like this: |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
44 |
* \code |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
45 |
* class MyContext : public TraceContextElement |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
46 |
* { |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
47 |
* public: |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
48 |
* // the _required_ public API |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
49 |
* static uint16_t GetUid (void); |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
50 |
* MyContext (); |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
51 |
* ~MyContext (); |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
52 |
* void Print (std::ostream &os) const; |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
53 |
* std::string GetTypeName (void) const; |
1254
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
54 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
55 |
* // the user-specific API to manipulate the context. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
56 |
* void SetData (uint8_t data); |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
57 |
* uint8_t GetData (void) const; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
58 |
* private: |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
59 |
* uint8_t m_myContextData; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
60 |
* }; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
61 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
62 |
* uint16_t |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
63 |
* MyContext::GetUid (void) |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
64 |
* { |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
65 |
* static uint16_t uid = AllocateUid<MyContext> ("MyContext"); |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
66 |
* return uid; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
67 |
* } |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
68 |
* MyContext::MyContext () |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
69 |
* {} |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
70 |
* MyContext::~MyContext () |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
71 |
* {} |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
72 |
* void |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
73 |
* MyContext::Print (std::ostream &os) const |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
74 |
* { |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
75 |
* os << "mycontext=" << (uint32_t) m_myContextData; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
76 |
* } |
1385
e971ab85fd0d
add some doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1364
diff
changeset
|
77 |
* std::string |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
78 |
* MyContext::GetTypeName (void) const |
1385
e971ab85fd0d
add some doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1364
diff
changeset
|
79 |
* { |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
80 |
* // return a fully-qualified c++ type name |
1385
e971ab85fd0d
add some doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1364
diff
changeset
|
81 |
* return "MyContext"; |
e971ab85fd0d
add some doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1364
diff
changeset
|
82 |
* } |
1254
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
83 |
* void |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
84 |
* MyContext::SetData (uint8_t data) |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
85 |
* { |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
86 |
* m_myContextData = data; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
87 |
* } |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
88 |
* uint8_t |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
89 |
* MyContext::GetData (void) const |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
90 |
* { |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
91 |
* return m_myContextData; |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
92 |
* } |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
93 |
* \endcode |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
94 |
*/ |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
95 |
class TraceContextElement |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
96 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
97 |
protected: |
1254
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
98 |
/** |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
99 |
* \param name a string which uniquely identifies the type |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
100 |
* of the subclass which is calling this method. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
101 |
* \returns a unique 32 bit integer associated to the |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
102 |
* input string. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
103 |
* |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
104 |
* Subclasses are expected to call this method from their |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
105 |
* public static GetUid method. |
75d1b34e5c5c
doxygen API documentation for TraceContextElement base class
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1236
diff
changeset
|
106 |
*/ |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
107 |
template <typename T> |
1235
dc52ea3507ff
TraceContextElement::Register -> TraceContextElement::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1227
diff
changeset
|
108 |
static uint16_t AllocateUid (std::string name); |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
109 |
}; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
110 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
111 |
} // namespace ns3 |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
112 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
113 |
namespace ns3 { |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
114 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
115 |
/** |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
116 |
* \brief a registry of TraceContextElement subclasses |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
117 |
* \internal |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
118 |
*/ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
119 |
class ElementRegistry |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
120 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
121 |
public: |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
122 |
template <typename T> |
1235
dc52ea3507ff
TraceContextElement::Register -> TraceContextElement::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1227
diff
changeset
|
123 |
static uint16_t AllocateUid (std::string name); |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
124 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
125 |
static uint32_t GetSize (uint16_t uid); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
126 |
static void Print (uint16_t uid, uint8_t *instance, std::ostream &os); |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
127 |
static std::string GetTypeName (uint16_t uid); |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
128 |
static void Destroy (uint16_t uid, uint8_t *instance); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
129 |
private: |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
130 |
typedef std::string (*GetTypeNameCb) (void); |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
131 |
typedef void (*PrintCb) (uint8_t *instance, std::ostream &os); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
132 |
typedef void (*DestroyCb) (uint8_t *instance); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
133 |
struct Info { |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
134 |
uint32_t size; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
135 |
std::string uidString; |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
136 |
GetTypeNameCb getTypeName; |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
137 |
PrintCb print; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
138 |
DestroyCb destroy; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
139 |
}; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
140 |
typedef std::vector<struct Info> InfoVector; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
141 |
static InfoVector *GetInfoVector (void); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
142 |
template <typename T> |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
143 |
static std::string DoGetTypeName (void); |
1364
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
144 |
template <typename T> |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
145 |
static void DoPrint (uint8_t *instance, std::ostream &os); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
146 |
template <typename T> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
147 |
static void DoDestroy (uint8_t *instance); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
148 |
}; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
149 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
150 |
template <typename T> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
151 |
void |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
152 |
ElementRegistry::DoPrint (uint8_t *instance, std::ostream &os) |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
153 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
154 |
static T obj; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
155 |
// make sure we are aligned. |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
156 |
memcpy ((void*)&obj, instance, sizeof (T)); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
157 |
obj.Print (os); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
158 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
159 |
template <typename T> |
1364
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
160 |
std::string |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
161 |
ElementRegistry::DoGetTypeName (void) |
1364
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
162 |
{ |
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
163 |
static T obj; |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
164 |
return obj.GetTypeName (); |
1364
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
165 |
} |
7866d4dd9e64
add TraceContextElement::GetName method
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1334
diff
changeset
|
166 |
template <typename T> |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
167 |
void |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
168 |
ElementRegistry::DoDestroy (uint8_t *instance) |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
169 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
170 |
static T obj; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
171 |
// make sure we are aligned. |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
172 |
memcpy ((void*)&obj, instance, sizeof (T)); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
173 |
obj.~T (); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
174 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
175 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
176 |
template <typename T> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
177 |
uint16_t |
1235
dc52ea3507ff
TraceContextElement::Register -> TraceContextElement::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1227
diff
changeset
|
178 |
ElementRegistry::AllocateUid (std::string name) |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
179 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
180 |
InfoVector *vec = GetInfoVector (); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
181 |
uint16_t uid = 1; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
182 |
for (InfoVector::iterator i = vec->begin (); i != vec->end (); i++) |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
183 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
184 |
if (i->uidString == name) |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
185 |
{ |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
186 |
return uid; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
187 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
188 |
uid++; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
189 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
190 |
struct Info info; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
191 |
info.size = sizeof (T); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
192 |
info.uidString = name; |
1401
96a21130865c
GetName -> GetTypeName
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1385
diff
changeset
|
193 |
info.getTypeName = &ElementRegistry::DoGetTypeName<T>; |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
194 |
info.print = &ElementRegistry::DoPrint<T>; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
195 |
info.destroy = &ElementRegistry::DoDestroy<T>; |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
196 |
vec->push_back (info); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
197 |
return vec->size (); |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
198 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
199 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
200 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
201 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
202 |
template <typename T> |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
203 |
uint16_t |
1235
dc52ea3507ff
TraceContextElement::Register -> TraceContextElement::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1227
diff
changeset
|
204 |
TraceContextElement::AllocateUid (std::string name) |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
205 |
{ |
1235
dc52ea3507ff
TraceContextElement::Register -> TraceContextElement::AllocateUid
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
1227
diff
changeset
|
206 |
return ElementRegistry::AllocateUid<T> (name); |
1227
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
207 |
} |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
208 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
209 |
} // namespace ns3 |
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
210 |
|
268a9fc6f4a2
work in progress towards a working trace context
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff
changeset
|
211 |
#endif /* TRACE_CONTEXT_ELEMENT_H */ |