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< AttributeValue >	Copy (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< Object >	GetObject (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 ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const

Private Attributes
Ptr< Object >	m_value

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

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 26 of file pointer.cc.

ns3::PointerValue::PointerValue

(

Ptr< Object >

object

)

Definition at line 31 of file pointer.cc.

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 49 of file pointer.cc.

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

virtual

Parameters

value	a string representation of the value
checker	a 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 62 of file pointer.cc.

References m_value.

template<typename T >

Ptr< T > ns3::PointerValue::Get

(

void

)

const

Definition at line 148 of file pointer.h.

References m_value, and ns3::PeekPointer().

Referenced by ns3::RandomVariableStreamHelper::AssignStreams(), ns3::WifiHelper::AssignStreams(), ns3::AttributeIterator::DoIterate(), ns3::Resolver::DoResolve(), ns3::PointerAttributeTestCase::DoRun(), main(), and ns3::QosWifiMacHelper::Setup().

Here is the call graph for this function:

Here is the caller graph for this function:

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 43 of file pointer.cc.

References m_value.

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

checker

the 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 54 of file pointer.cc.

References m_value.

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 37 of file pointer.cc.

References m_value.

Member Data Documentation

Ptr<Object> ns3::PointerValue::m_value

private

Definition at line 64 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:

• src/core/model/pointer.h
• src/core/model/pointer.cc