ns3::Vector3DValue Class Reference

AttributeValue implementation for Vector3D. More...

#include "vector.h"

Inheritance diagram for ns3::Vector3DValue:

Collaboration diagram for ns3::Vector3DValue:

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

Detailed Description

AttributeValue implementation for Vector3D.

See also

AttributeValue

Definition at line 354 of file vector.h.

Constructor & Destructor Documentation

Vector3DValue() [1/2]

ns3::Vector3DValue::Vector3DValue ( )

default

Vector3DValue() [2/2]

ns3::Vector3DValue::Vector3DValue

(

const Vector3D &

value

)

Constructor.

Parameters

[in]

value

The Vector3D value to use.

Definition at line 28 of file vector.cc.

Member Function Documentation

Copy()

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

overridevirtual

Returns

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

Implements ns3::AttributeValue.

Definition at line 28 of file vector.cc.

DeserializeFromString()

bool ns3::Vector3DValue::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 28 of file vector.cc.

Get()

Vector3D ns3::Vector3DValue::Get

(

)

const

Returns

The Vector3D value.

Definition at line 28 of file vector.cc.

GetAccessor()

template<typename T >

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

inline

Access the Vector3D value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The Vector3D value, as type T.

Returns

true.

Definition at line 354 of file vector.h.

SerializeToString()

std::string ns3::Vector3DValue::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 28 of file vector.cc.

Set()

void ns3::Vector3DValue::Set

(

const Vector3D &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 28 of file vector.cc.

Member Data Documentation

m_value

Vector3D ns3::Vector3DValue::m_value

private

The stored Vector3D instance.

Definition at line 354 of file vector.h.

---

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

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