ns3::LengthValue Class Reference

Define LengthValue class to support using Length objects as attributes. More...

#include "length.h"

Inheritance diagram for ns3::LengthValue:

Collaboration diagram for ns3::LengthValue:

Public Member Functions
	LengthValue ()
	LengthValue (const Length &value)
	Copy constructor. More...
virtual Ptr< AttributeValue >	Copy (void) const
virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
Length	Get (void) const
	More...
template<typename T >
bool	GetAccessor (T &value) const
	Access the Length value as type T. More...
virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const
void	Set (const Length &value)
	Set the value. More...
Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()
virtual	~AttributeValue ()
Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) const
	Decrement the reference count. More...

Private Attributes
Length	m_value
	The stored Length instance. More...

Detailed Description

Define LengthValue class to support using Length objects as attributes.

AttributeValue implementation for Length.

See also

AttributeValue

Definition at line 617 of file length.h.

Constructor & Destructor Documentation

LengthValue() [1/2]

ns3::LengthValue::LengthValue

(

)

Definition at line 236 of file length.cc.

LengthValue() [2/2]

Length ns3::LengthValue::LengthValue

(

const Length &

value

)

Copy constructor.

Parameters

[in]

value

The Length value to copy.

Definition at line 236 of file length.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::LengthValue::Copy ( void  ) const

virtual

Returns

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

Implements ns3::AttributeValue.

Definition at line 236 of file length.cc.

DeserializeFromString()

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

virtual

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 236 of file length.cc.

Referenced by LengthValueTestCase::TestAttributeDeserialization().

Here is the caller graph for this function:

Get()

Length ns3::LengthValue::Get

(

void

)

const

Returns

The Length value.

Definition at line 236 of file length.cc.

Referenced by LengthValueTestCase::TestAttributeConstructor(), LengthValueTestCase::TestAttributeDeserialization(), LengthValueTestCase::TestObjectAttribute(), and LengthValueTestCase::TestSetAttributeUsingStringValue().

Here is the caller graph for this function:

GetAccessor()

template<typename T >

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

inline

Access the Length value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The Length value, as type T.

Returns

true.

Definition at line 617 of file length.h.

SerializeToString()

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

virtual

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 236 of file length.cc.

Referenced by LengthValueTestCase::TestAttributeSerialization().

Here is the caller graph for this function:

Set()

void ns3::LengthValue::Set

(

const Length &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 236 of file length.cc.

Member Data Documentation

m_value

Length ns3::LengthValue::m_value

private

The stored Length instance.

Definition at line 617 of file length.h.

---

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

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