A Discrete-Event Network Simulator
API
ns3::CallbackValue Class Reference

AttributeValue implementation for Callback. More...

#include "callback.h"

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

Public Member Functions

 CallbackValue ()
 Constructor. More...
 
 CallbackValue (const CallbackBase &base)
 Copy constructor. More...
 
virtual ~CallbackValue ()
 Destructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 Deserialize from string (not implemented) More...
 
template<typename T >
bool GetAccessor (T &value) const
 Give value my callback, if type compatible. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 Serialize to string. More...
 
void Set (CallbackBase base)
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 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...
 

Private Attributes

CallbackBase m_value
 the CallbackBase More...
 

Detailed Description

AttributeValue implementation for Callback.

See also
AttributeValue

Definition at line 1880 of file callback.h.

Constructor & Destructor Documentation

ns3::CallbackValue::CallbackValue ( )

Constructor.

Definition at line 34 of file callback.cc.

References NS_LOG_FUNCTION.

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

Copy constructor.

Parameters
[in]baseCallback to copy

Definition at line 39 of file callback.cc.

ns3::CallbackValue::~CallbackValue ( )
virtual

Destructor.

Definition at line 43 of file callback.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< AttributeValue > ns3::CallbackValue::Copy ( void  ) const
virtual
Returns
A copy of this CallBack

Implements ns3::AttributeValue.

Definition at line 55 of file callback.cc.

References m_value, and NS_LOG_FUNCTION.

bool ns3::CallbackValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual

Deserialize from string (not implemented)

Parameters
[in]valueSource string
[in]checkerChecker to validate with
Returns
true if successful

Implements ns3::AttributeValue.

Definition at line 69 of file callback.cc.

References NS_LOG_FUNCTION.

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

Give value my callback, if type compatible.

Access the Callback value as type T.

Parameters
[out]valueDestination callback
Returns
true if successful
Template Parameters
T[explicit] The type to cast to.
Parameters
[out]valueThe Callback value, as type T.
Returns
true.

Definition at line 1930 of file callback.h.

References NS_FATAL_ERROR_NO_MSG.

std::string ns3::CallbackValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual

Serialize to string.

Parameters
[in]checkerThe checker to validate with
Returns
Serialized form of this Callback.

Implements ns3::AttributeValue.

Definition at line 61 of file callback.cc.

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

+ Here is the call graph for this function:

void ns3::CallbackValue::Set ( CallbackBase  base)
Parameters
[in]baseThe CallbackBase to use

Definition at line 48 of file callback.cc.

References m_value, and NS_LOG_FUNCTION.

Member Data Documentation

Callback ns3::CallbackValue::m_value
private

the CallbackBase

The stored Callback instance.

Definition at line 1919 of file callback.h.

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


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