AttributeValue implementation for Pointer. More...

#include "pointer.h"

Inheritance diagram for ns3::PointerValue:

Collaboration diagram for ns3::PointerValue:

Public Member Functions
	PointerValue ()

	PointerValue (const Ptr< Object > &object)
	Construct this PointerValue by referencing an explicit Object.

template<typename T >
	PointerValue (const Ptr< T > &object)
	Construct this PointerValue by referencing an explicit Object.

Ptr< AttributeValue >	Copy () const override

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

template<typename T >
Ptr< T >	Get () const

template<typename T >
bool	GetAccessor (Ptr< T > &value) const
	Access the Pointer value as type `T`.

Ptr< Object >	GetObject () const
	Get the Object referenced by the PointerValue.

template<typename T >
	operator Ptr< T > () const
	Cast to an Object of type `T`.

std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override

template<typename T >
void	Set (const Ptr< T > &value)
	Set the value.

void	SetObject (Ptr< Object > object)
	Set the value from by reference an Object.

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.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Private Attributes
Ptr< Object >	m_value
	The stored Pointer instance.

Detailed Description

AttributeValue implementation for Pointer.

Hold objects of type Ptr<T>.

See also: AttributeValue

Constructor & Destructor Documentation

◆ PointerValue() [1/3]

ns3::PointerValue::PointerValue ( )

Definition at line 26 of file pointer.cc.

References NS_LOG_FUNCTION.

◆ PointerValue() [2/3]

ns3::PointerValue::PointerValue ( const Ptr< Object > & object )

Construct this PointerValue by referencing an explicit Object.

Parameters

[in] object The object to begin with.

Definition at line 32 of file pointer.cc.

References NS_LOG_FUNCTION.

◆ PointerValue() [3/3]

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] object The object to begin with.

Definition at line 209 of file pointer.h.

References m_value.

Member Function Documentation

◆ Copy()

Ptr< AttributeValue > ns3::PointerValue::Copy ( ) const

overridevirtual

Returns: a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 53 of file pointer.cc.

References ns3::Create(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DeserializeFromString()

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

overridevirtual

Parameters

[in]	value	A string representation of the value
[in]	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 69 of file pointer.cc.

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

Here is the call graph for this function:

◆ Get()

template<typename T >

Ptr< T > ns3::PointerValue::Get ( ) const

Returns: The Pointer value.

Template Parameters

T	[explicit] The type to cast to.

Definition at line 223 of file pointer.h.

References m_value, and ns3::PeekPointer().

Referenced by ns3::MeshHelper::AssignStreams(), ns3::RandomVariableStreamHelper::AssignStreams(), ns3::WifiHelper::AssignStreams(), AssignWifiRandomStreams(), TcFlowControlTestCase::CheckPacketsInDeviceQueue(), TestAmpduReception::CheckPhyState(), TestInterBssConstantObssPdAlgo::CheckPhyState(), SpectrumWifiPhyMultipleInterfacesTest::CheckRxingState(), SpectrumWifiPhyMultipleInterfacesTest::DoCheckInterferences(), TestDlMuMimoPhyTransmission::DoCheckPhyState(), TestDlOfdmaPhyPuncturing::DoCheckPhyState(), TestDlOfdmaPhyTransmission::DoCheckPhyState(), TestUlMuMimoPhyTransmission::DoCheckPhyState(), TestUlOfdmaPhyTransmission::DoCheckPhyState(), WifiPhyCcaIndicationTest::DoCheckPhyState(), WifiPhyReceptionTest::DoCheckPhyState(), ns3::AttributeIterator::DoIterate(), ns3::Config::Resolver::DoResolve(), BlockAckAggregationDisabledTest::DoRun(), LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun(), PointerAttributeTestCase::DoRun(), QosFragmentationTestCase::DoRun(), WifiAcMappingTest::DoRun(), Experiment::Run(), Issue40TestCase::RunOne(), and SpectrumWifiPhyTrackedBandsTest::VerifyTrackedBands().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAccessor()

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] value The Pointer value, as type T.

Returns: true.

Definition at line 237 of file pointer.h.

References m_value, and ns3::PeekPointer().

Here is the call graph for this function:

◆ GetObject()

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

Get the Object referenced by the PointerValue.

Returns: The Object.

Definition at line 46 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

Referenced by ns3::cell_tooltip_callback(), LteCqiGenerationDlPowerControlTestCase::DoRun(), LteDownlinkPowerControlRrcConnectionReconfigurationTestCase::DoRun(), LteDownlinkPowerControlTestCase::DoRun(), LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), and LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun().

Here is the caller graph for this function:

◆ operator Ptr< T >()

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 230 of file pointer.h.

◆ SerializeToString()

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

overridevirtual

Parameters

[in] 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 60 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

◆ Set()

template<typename T >

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

Set the value.

Parameters

[in] value The value to adopt.

Definition at line 216 of file pointer.h.

References m_value.

◆ SetObject()

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

Set the value from by reference an Object.

Parameters

[in] object The object to reference.

Definition at line 39 of file pointer.cc.

References m_value, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_value

Ptr<Object> ns3::PointerValue::m_value

private

The stored Pointer instance.

Definition at line 105 of file pointer.h.

Referenced by PointerValue(), DeserializeFromString(), Get(), GetAccessor(), GetObject(), 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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PointerValue() [1/3]

◆ PointerValue() [2/3]

◆ PointerValue() [3/3]

Member Function Documentation

◆ Copy()

◆ DeserializeFromString()

◆ Get()

◆ GetAccessor()

◆ GetObject()

◆ operator Ptr< T >()

◆ SerializeToString()

◆ Set()

◆ SetObject()

Member Data Documentation

◆ m_value