A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 ()
 
 CallbackValue (const CallbackBase &value)
 Constructor.
 
 ~CallbackValue () override
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 Deserialize from string (not implemented)
 
CallbackBase Get ()
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Callback value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 Serialize to string.
 
void Set (const CallbackBase &value)
 Set the value.
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

CallbackBase m_value
 The stored Callback instance.
 

Detailed Description

AttributeValue implementation for Callback.

See also
AttributeValue

Definition at line 785 of file callback.h.

Constructor & Destructor Documentation

◆ CallbackValue() [1/2]

ns3::CallbackValue::CallbackValue ( )

Definition at line 24 of file callback.cc.

References NS_LOG_FUNCTION.

◆ CallbackValue() [2/2]

ns3::CallbackValue::CallbackValue ( const CallbackBase & value)

Constructor.

Parameters
[in]valueThe Callback value to use.

Definition at line 30 of file callback.cc.

◆ ~CallbackValue()

ns3::CallbackValue::~CallbackValue ( )
override

Definition at line 35 of file callback.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 55 of file callback.cc.

References ns3::Create(), m_value, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DeserializeFromString()

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

Deserialize from string (not implemented)

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

Implements ns3::AttributeValue.

Definition at line 71 of file callback.cc.

References NS_LOG_FUNCTION.

◆ Get()

CallbackBase ns3::CallbackValue::Get ( )
Returns
The Callback value.

Definition at line 48 of file callback.cc.

References m_value, and NS_LOG_FUNCTION.

◆ GetAccessor()

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

Access the Callback value as type T.

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

Definition at line 828 of file callback.h.

References m_value, and NS_FATAL_ERROR_NO_MSG.

◆ SerializeToString()

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

Serialize to string.

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

Implements ns3::AttributeValue.

Definition at line 62 of file callback.cc.

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

+ Here is the call graph for this function:

◆ Set()

void ns3::CallbackValue::Set ( const CallbackBase & value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 41 of file callback.cc.

References m_value, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_value

CallbackBase ns3::CallbackValue::m_value
private

The stored Callback instance.

Definition at line 815 of file callback.h.

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


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