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

AttributeValue implementation for Ipv4Mask. More...

#include "ipv4-address.h"

+ Inheritance diagram for ns3::Ipv4MaskValue:
+ Collaboration diagram for ns3::Ipv4MaskValue:

Public Member Functions

 Ipv4MaskValue ()
 
 Ipv4MaskValue (const Ipv4Mask &value)
 Copy constructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
Ipv4Mask Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Ipv4Mask value as type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const Ipv4Mask &value)
 Set the value. More...
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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

Ipv4Mask m_value
 The stored Ipv4Mask instance. More...
 

Detailed Description

AttributeValue implementation for Ipv4Mask.

See also
AttributeValue

Definition at line 342 of file ipv4-address.h.

Constructor & Destructor Documentation

◆ Ipv4MaskValue() [1/2]

ns3::Ipv4MaskValue::Ipv4MaskValue ( )

Definition at line 447 of file ipv4-address.cc.

◆ Ipv4MaskValue() [2/2]

Ipv4Mask ns3::Ipv4MaskValue::Ipv4MaskValue ( const Ipv4Mask value)

Copy constructor.

Parameters
[in]valueThe Ipv4Mask value to copy.

Definition at line 447 of file ipv4-address.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 447 of file ipv4-address.cc.

◆ DeserializeFromString()

bool ns3::Ipv4MaskValue::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 447 of file ipv4-address.cc.

◆ Get()

Ipv4Mask ns3::Ipv4MaskValue::Get ( void  ) const
Returns
The Ipv4Mask value.

Definition at line 447 of file ipv4-address.cc.

◆ GetAccessor()

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

Access the Ipv4Mask value as type T.

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

Definition at line 342 of file ipv4-address.h.

◆ SerializeToString()

std::string ns3::Ipv4MaskValue::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 447 of file ipv4-address.cc.

◆ Set()

void ns3::Ipv4MaskValue::Set ( const Ipv4Mask value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 447 of file ipv4-address.cc.

Member Data Documentation

◆ m_value

Ipv4Mask ns3::Ipv4MaskValue::m_value
private

The stored Ipv4Mask instance.

Definition at line 342 of file ipv4-address.h.


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