A Discrete-Event Network Simulator
API
Public Member Functions | Private Attributes | List of all members
ns3::UintegerValue Class Reference

Hold an unsigned integer type. More...

#include "uinteger.h"

+ Inheritance diagram for ns3::UintegerValue:

Public Member Functions

 UintegerValue ()
 
 UintegerValue (const uint64_t &value)
 
Copy constructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
uint64_t Get (void) const
 
More...
 
template<typename T >
bool GetAccessor (T &value) const
 
Access the Uinteger value as type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const uint64_t &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)
 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

uint64_t m_value
 
The stored Uinteger instance. More...
 

Detailed Description

Hold an unsigned integer type.


AttributeValue implementation for Uinteger.

This class can be used to hold variables of unsigned integer type such as uint8_t, uint16_t, uint32_t, uint64_t, or, unsigned int, etc.

See also
AttributeValue

Definition at line 44 of file uinteger.h.

Constructor & Destructor Documentation

◆ UintegerValue() [1/2]

ns3::UintegerValue::UintegerValue ( )

Definition at line 35 of file uinteger.cc.

◆ UintegerValue() [2/2]

ns3::UintegerValue::UintegerValue ( const uint64_t &  value)


Copy constructor.

Parameters
[in]valueThe Uinteger value to copy.

Definition at line 35 of file uinteger.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 35 of file uinteger.cc.

◆ DeserializeFromString()

bool ns3::UintegerValue::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 35 of file uinteger.cc.

◆ Get()

uint64_t ns3::UintegerValue::Get ( void  ) const

◆ GetAccessor()

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


Access the Uinteger value as type T.

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

Definition at line 44 of file uinteger.h.

◆ SerializeToString()

std::string ns3::UintegerValue::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 35 of file uinteger.cc.

◆ Set()

void ns3::UintegerValue::Set ( const uint64_t &  value)


Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 35 of file uinteger.cc.

Member Data Documentation

◆ m_value

uint64_t ns3::UintegerValue::m_value
private


The stored Uinteger instance.

Definition at line 44 of file uinteger.h.


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