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

AttributeValue implementation for Address. More...

#include "address.h"

+ Inheritance diagram for ns3::AddressValue:
+ Collaboration diagram for ns3::AddressValue:

Public Member Functions

 AddressValue ()=default
 
 AddressValue (const Address &value)
 Constructor.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
Address Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Address value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const Address &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

Address m_value
 The stored Address instance.
 

Detailed Description

AttributeValue implementation for Address.

See also
AttributeValue

Definition at line 275 of file address.h.

Constructor & Destructor Documentation

◆ AddressValue() [1/2]

ns3::AddressValue::AddressValue ( )
default

◆ AddressValue() [2/2]

ns3::AddressValue::AddressValue ( const Address & value)

Constructor.

Parameters
[in]valueThe Address value to use.

Definition at line 169 of file address.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 169 of file address.cc.

◆ DeserializeFromString()

bool ns3::AddressValue::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 169 of file address.cc.

◆ Get()

Address ns3::AddressValue::Get ( ) const
Returns
The Address value.

Definition at line 169 of file address.cc.

◆ GetAccessor()

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

Access the Address value as type T.

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

Definition at line 275 of file address.h.

◆ SerializeToString()

std::string ns3::AddressValue::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 169 of file address.cc.

◆ Set()

void ns3::AddressValue::Set ( const Address & value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 169 of file address.cc.

Member Data Documentation

◆ m_value

Address ns3::AddressValue::m_value
private

The stored Address instance.

Definition at line 275 of file address.h.


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