A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::Vector2DValue Class Reference

AttributeValue implementation for Vector2D. More...

#include "vector.h"

+ Inheritance diagram for ns3::Vector2DValue:
+ Collaboration diagram for ns3::Vector2DValue:

Public Member Functions

 Vector2DValue ()
 
 Vector2DValue (const Vector2D &value)
 Constructor.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
Vector2D Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Vector2D value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const Vector2D &value)
 Set the value.
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
virtual Ptr< AttributeValueCopy () 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.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

Vector2D m_value
 The stored Vector2D instance.
 

Detailed Description

AttributeValue implementation for Vector2D.

See also
AttributeValue

Definition at line 318 of file vector.h.

Constructor & Destructor Documentation

◆ Vector2DValue() [1/2]

ns3::Vector2DValue::Vector2DValue ( )

Definition at line 40 of file vector.cc.

◆ Vector2DValue() [2/2]

ns3::Vector2DValue::Vector2DValue ( const Vector2D value)

Constructor.

Parameters
[in]valueThe Vector2D value to use.

Definition at line 40 of file vector.cc.

Member Function Documentation

◆ Copy()

Ptr< AttributeValue > ns3::Vector2DValue::Copy ( ) const
overridevirtual
Returns
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 40 of file vector.cc.

◆ DeserializeFromString()

bool ns3::Vector2DValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
overridevirtual
Parameters
[in]valueA string representation of the value
[in]checkerA 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 40 of file vector.cc.

◆ Get()

Vector2D ns3::Vector2DValue::Get ( ) const
Returns
The Vector2D value.

Definition at line 40 of file vector.cc.

◆ GetAccessor()

template<typename T >
bool ns3::Vector2DValue::GetAccessor ( T &  value) const
inline

Access the Vector2D value as type T.

Template Parameters
T[explicit] The type to cast to.
Parameters
[out]valueThe Vector2D value, as type T.
Returns
true.

Definition at line 318 of file vector.h.

◆ SerializeToString()

std::string ns3::Vector2DValue::SerializeToString ( Ptr< const AttributeChecker checker) const
overridevirtual
Parameters
[in]checkerThe 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 40 of file vector.cc.

◆ Set()

void ns3::Vector2DValue::Set ( const Vector2D value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 40 of file vector.cc.

Member Data Documentation

◆ m_value

Vector2D ns3::Vector2DValue::m_value
private

The stored Vector2D instance.

Definition at line 318 of file vector.h.


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