A Discrete-Event Network Simulator
API
anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject Class Reference

StringValue formatting example test object. More...

+ Inheritance diagram for anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject:
+ Collaboration diagram for anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject:

Public Member Functions

 FormattingTestObject ()
 Default constructor. More...
 
Ptr< RandomVariableStreamGetTestVariable (void) const
 Get the test variable. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type and get the TypeId. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Ptr< RandomVariableStreamm_testVariable
 The test variable. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

StringValue formatting example test object.

We use an attribute containing a pointer to a random variable to stress StringValue.

Definition at line 48 of file test-string-value-formatting.cc.

Constructor & Destructor Documentation

◆ FormattingTestObject()

anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject::FormattingTestObject ( )

Default constructor.

Definition at line 84 of file test-string-value-formatting.cc.

Member Function Documentation

◆ GetTestVariable()

Ptr< RandomVariableStream > anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject::GetTestVariable ( void  ) const

Get the test variable.

Returns
the test variable

Definition at line 88 of file test-string-value-formatting.cc.

◆ GetTypeId()

TypeId anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject::GetTypeId ( void  )
static

Register this type and get the TypeId.

Returns
the object TypeId

Definition at line 71 of file test-string-value-formatting.cc.

References ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_testVariable

Ptr<RandomVariableStream> anonymous_namespace{test-string-value-formatting.cc}::FormattingTestObject::m_testVariable
private

The test variable.

Definition at line 65 of file test-string-value-formatting.cc.


The documentation for this class was generated from the following file: