A Discrete-Event Network Simulator
API
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)
 Copy constructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
Vector2D Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Vector2D value as type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const Vector2D &value)
 Set the value. More...
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Attributes

Vector2D m_value
 The stored Vector2D instance. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

AttributeValue implementation for Vector2D.

See also
AttributeValue

Definition at line 117 of file vector.h.

Constructor & Destructor Documentation

ns3::Vector2DValue::Vector2DValue ( )

Definition at line 37 of file vector.cc.

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

Copy constructor.

Parameters
[in]valueThe Vector2D value to copy.

Definition at line 37 of file vector.cc.

Member Function Documentation

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

Implements ns3::AttributeValue.

Definition at line 37 of file vector.cc.

bool ns3::Vector2DValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
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 37 of file vector.cc.

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

Definition at line 37 of file vector.cc.

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 117 of file vector.h.

std::string ns3::Vector2DValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
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 37 of file vector.cc.

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

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 37 of file vector.cc.

Member Data Documentation

Vector2D ns3::Vector2DValue::m_value
private

The stored Vector2D instance.

Definition at line 117 of file vector.h.


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