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

AttributeValue implementation for Waypoint. More...

#include "waypoint.h"

+ Inheritance diagram for ns3::WaypointValue:
+ Collaboration diagram for ns3::WaypointValue:

Public Member Functions

 WaypointValue ()=default
 
 WaypointValue (const Waypoint &value)
 Constructor.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
Waypoint Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Waypoint value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const Waypoint &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.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

Waypoint m_value
 The stored Waypoint instance.
 

Detailed Description

AttributeValue implementation for Waypoint.

See also
AttributeValue

Definition at line 49 of file waypoint.h.

Constructor & Destructor Documentation

◆ WaypointValue() [1/2]

ns3::WaypointValue::WaypointValue ( )
default

◆ WaypointValue() [2/2]

ns3::WaypointValue::WaypointValue ( const Waypoint & value)

Constructor.

Parameters
[in]valueThe Waypoint value to use.

Definition at line 13 of file waypoint.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 13 of file waypoint.cc.

◆ DeserializeFromString()

bool ns3::WaypointValue::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 13 of file waypoint.cc.

◆ Get()

Waypoint ns3::WaypointValue::Get ( ) const
Returns
The Waypoint value.

Definition at line 13 of file waypoint.cc.

◆ GetAccessor()

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

Access the Waypoint value as type T.

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

Definition at line 49 of file waypoint.h.

◆ SerializeToString()

std::string ns3::WaypointValue::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 13 of file waypoint.cc.

◆ Set()

void ns3::WaypointValue::Set ( const Waypoint & value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 13 of file waypoint.cc.

Member Data Documentation

◆ m_value

Waypoint ns3::WaypointValue::m_value
private

The stored Waypoint instance.

Definition at line 49 of file waypoint.h.


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