A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::CallbackValue Class Reference

#include <callback.h>

+ Inheritance diagram for ns3::CallbackValue:
+ Collaboration diagram for ns3::CallbackValue:

Public Member Functions

 CallbackValue ()
 CallbackValue (const CallbackBase &base)
virtual ~CallbackValue ()
virtual Ptr< AttributeValueCopy (void) const
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
template<typename T >
bool GetAccessor (T &value) const
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
void Set (CallbackBase base)
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
virtual ~AttributeValue ()
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const

Private Attributes

CallbackBase m_value

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void Cleanup (void)

Detailed Description

Definition at line 961 of file callback.h.

Constructor & Destructor Documentation

ns3::CallbackValue::CallbackValue ( )

Definition at line 5 of file callback.cc.

ns3::CallbackValue::CallbackValue ( const CallbackBase base)

Definition at line 9 of file callback.cc.

ns3::CallbackValue::~CallbackValue ( )
virtual

Definition at line 13 of file callback.cc.

Member Function Documentation

Ptr< AttributeValue > ns3::CallbackValue::Copy ( void  ) const
virtual
Returns
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 22 of file callback.cc.

References m_value.

bool ns3::CallbackValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
valuea string representation of the value
checkera pointer to the checker associated to the attribute.
Returns
true if the input string was correctly-formatted and could be successfully deserialized, false otherwise.

Upon return of this function, this AttributeValue instance contains the deserialized value. In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implements ns3::AttributeValue.

Definition at line 34 of file callback.cc.

template<typename T >
bool ns3::CallbackValue::GetAccessor ( T &  value) const

Definition at line 985 of file callback.h.

References m_value.

std::string ns3::CallbackValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
checkerthe checker associated to the attribute
Returns
a string representation of this value.

In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implements ns3::AttributeValue.

Definition at line 27 of file callback.cc.

References ns3::CallbackBase::GetImpl(), m_value, and ns3::PeekPointer().

+ Here is the call graph for this function:

void ns3::CallbackValue::Set ( CallbackBase  base)

Definition at line 17 of file callback.cc.

References m_value.

Member Data Documentation

CallbackBase ns3::CallbackValue::m_value
private

Definition at line 974 of file callback.h.

Referenced by Copy(), GetAccessor(), SerializeToString(), and Set().


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