A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
template<typename T >
 PointerValue (const Ptr< T > &object)
 
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 > &v) const
 
Ptr< ObjectGetObject (void) const
 
template<typename T >
 operator Ptr< T > () const
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
template<typename T >
void Set (const Ptr< T > &object)
 
void SetObject (Ptr< Object > object)
 
- 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
 

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>

Definition at line 33 of file pointer.h.

Constructor & Destructor Documentation

ns3::PointerValue::PointerValue ( )

Definition at line 29 of file pointer.cc.

References NS_LOG_FUNCTION.

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

Definition at line 35 of file pointer.cc.

References NS_LOG_FUNCTION.

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

Definition at line 134 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 56 of file pointer.cc.

References NS_LOG_FUNCTION.

bool ns3::PointerValue::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 71 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 > &  v) const

Definition at line 162 of file pointer.h.

References m_value, and ns3::PeekPointer().

+ Here is the call graph for this function:

Ptr< Object > ns3::PointerValue::GetObject ( void  ) const

Definition at line 49 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

Referenced by ns3::cell_tooltip_callback(), and ns3::internal::APointerChecker< T >::Check().

+ Here is the caller graph for this function:

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

Definition at line 155 of file pointer.h.

std::string ns3::PointerValue::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 62 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

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

Definition at line 141 of file pointer.h.

References m_value.

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

Definition at line 42 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

Member Data Documentation

Ptr<Object> ns3::PointerValue::m_value
private

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