ns3::TypeIdValue Class Reference

AttributeValue implementation for TypeId. More...

#include "type-id.h"

Inheritance diagram for ns3::TypeIdValue:

Collaboration diagram for ns3::TypeIdValue:

Public Member Functions
	TypeIdValue ()
	TypeIdValue (const TypeId &value)
	Constructor.
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
TypeId	Get () const
template<typename T >
bool	GetAccessor (T &value) const
	Access the TypeId value as type T.
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (const TypeId &value)
	Set the value.
Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()
virtual	~AttributeValue ()
virtual Ptr< AttributeValue >	Copy () const =0
virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)=0
virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const =0
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
TypeId	m_value
	The stored TypeId instance.

Detailed Description

AttributeValue implementation for TypeId.

See also

AttributeValue

Definition at line 598 of file type-id.h.

Constructor & Destructor Documentation

TypeIdValue() [1/2]

ns3::TypeIdValue::TypeIdValue

(

)

Definition at line 1251 of file type-id.cc.

TypeIdValue() [2/2]

ns3::TypeIdValue::TypeIdValue

(

const TypeId &

value

)

Constructor.

Parameters

[in]

value

The TypeId value to use.

Definition at line 1251 of file type-id.cc.

Member Function Documentation

Copy()

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

overridevirtual

Returns

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

Implements ns3::AttributeValue.

Definition at line 1251 of file type-id.cc.

DeserializeFromString()

bool ns3::TypeIdValue::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 1251 of file type-id.cc.

Get()

TypeId ns3::TypeIdValue::Get

(

)

const

Returns

The TypeId value.

Definition at line 1251 of file type-id.cc.

GetAccessor()

template<typename T >

bool ns3::TypeIdValue::GetAccessor ( T &  value ) const

inline

Access the TypeId value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The TypeId value, as type T.

Returns

true.

Definition at line 598 of file type-id.h.

SerializeToString()

std::string ns3::TypeIdValue::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 1251 of file type-id.cc.

Set()

void ns3::TypeIdValue::Set

(

const TypeId &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 1251 of file type-id.cc.

Member Data Documentation

m_value

TypeId ns3::TypeIdValue::m_value

private

The stored TypeId instance.

Definition at line 598 of file type-id.h.

---

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

• src/core/model/type-id.h
• src/core/model/type-id.cc
• doc/introspected-doxygen.h