A Discrete-Event Network Simulator
API
ns3::LengthValue Class Reference

AttributeValue implementation for Length. 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< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
Length Get (void) const
 
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 ()
 
virtual Ptr< AttributeValueCopy (void) 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. 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 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

AttributeValue implementation for Length.

See also
AttributeValue

Definition at line 622 of file length.h.

Constructor & Destructor Documentation

◆ LengthValue() [1/2]

ns3::LengthValue::LengthValue ( )

◆ LengthValue() [2/2]

Length ns3::LengthValue::LengthValue ( const Length value)

Copy constructor.

Parameters
[in]valueThe Length value to copy.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

◆ DeserializeFromString()

virtual bool ns3::LengthValue::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.

Referenced by LengthValueTestCase::TestAttributeDeserialization().

+ Here is the caller graph for this function:

◆ Get()

◆ 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]valueThe Length value, as type T.
Returns
true.

Definition at line 622 of file length.h.

◆ SerializeToString()

virtual std::string ns3::LengthValue::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.

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]valueThe value to adopt.

Member Data Documentation

◆ m_value

Length ns3::LengthValue::m_value
private

The stored Length instance.

Definition at line 622 of file length.h.


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