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

Hold objects of type Ptr<T>. More...

#include "pointer.h"

+ Inheritance diagram for ns3::PointerValue:
+ Collaboration diagram for ns3::PointerValue:

Public Member Functions

 PointerValue ()
 
 PointerValue (Ptr< Object > object)
 Construct this PointerValue by referencing an explicit Object. More...
 
template<typename T >
 PointerValue (const Ptr< T > &object)
 Construct this PointerValue by referencing an explicit Object. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
template<typename T >
Ptr< T > Get (void) const
 
template<typename T >
bool GetAccessor (Ptr< T > &value) const
 Access the Pointer value as type T. More...
 
Ptr< ObjectGetObject (void) const
 Get the Object referenced by the PointerValue. More...
 
template<typename T >
 operator Ptr< T > () const
 Cast to an Object of type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
template<typename T >
void Set (const Ptr< T > &value)
 Set the value. More...
 
void SetObject (Ptr< Object > object)
 Set the value from by reference an Object. More...
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 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. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Ptr< Objectm_value
 The stored Pointer instance. More...
 

Additional Inherited Members

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

Detailed Description

Hold objects of type Ptr<T>.

AttributeValue implementation for Pointer.

See also
AttributeValue

Definition at line 36 of file pointer.h.

Constructor & Destructor Documentation

ns3::PointerValue::PointerValue ( )

Definition at line 35 of file pointer.cc.

References NS_LOG_FUNCTION.

ns3::PointerValue::PointerValue ( Ptr< Object object)

Construct this PointerValue by referencing an explicit Object.

Parameters
[in]objectThe object to begin with.

Definition at line 41 of file pointer.cc.

References NS_LOG_FUNCTION.

template<typename T >
ns3::PointerValue::PointerValue ( const Ptr< T > &  object)

Construct this PointerValue by referencing an explicit Object.

Template Parameters
T[deduced] The type of the object.
Parameters
[in]objectThe object to begin with.

Definition at line 180 of file pointer.h.

References m_value.

Member Function Documentation

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

Implements ns3::AttributeValue.

Definition at line 62 of file pointer.cc.

References NS_LOG_FUNCTION.

bool ns3::PointerValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
[in]valueA string representation of the value
[in]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 77 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

template<typename T >
Ptr< T > ns3::PointerValue::Get ( void  ) const
template<typename T >
bool ns3::PointerValue::GetAccessor ( Ptr< T > &  value) const

Access the Pointer value as type T.

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

Definition at line 208 of file pointer.h.

References m_value, and ns3::PeekPointer().

+ Here is the call graph for this function:

template<typename T >
ns3::PointerValue::operator Ptr< T > ( ) const

Cast to an Object of type T.

Template Parameters
T[explicit] The type to cast to.

Definition at line 201 of file pointer.h.

std::string ns3::PointerValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
[in]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 68 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

template<typename T >
void ns3::PointerValue::Set ( const Ptr< T > &  value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 187 of file pointer.h.

References m_value.

void ns3::PointerValue::SetObject ( Ptr< Object object)

Set the value from by reference an Object.

Parameters
[in]objectThe object to reference.

Definition at line 48 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

Member Data Documentation

Pointer ns3::PointerValue::m_value
private

The stored Pointer instance.

Definition at line 93 of file pointer.h.

Referenced by DeserializeFromString(), Get(), GetAccessor(), GetObject(), PointerValue(), SerializeToString(), Set(), and SetObject().


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