ns3::UintegerValue Class Reference

Hold an unsigned integer type. More...

#include "uinteger.h"

Inheritance diagram for ns3::UintegerValue:

Collaboration diagram for ns3::UintegerValue:

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

Private Attributes
uint64_t	m_value
	The stored Uinteger instance.

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 34 of file uinteger.h.

Constructor & Destructor Documentation

UintegerValue() [1/2]

ns3::UintegerValue::UintegerValue ( )

default

UintegerValue() [2/2]

ns3::UintegerValue::UintegerValue

(

const uint64_t &

value

)

Constructor.

Parameters

[in]

value

The Uinteger value to use.

Definition at line 26 of file uinteger.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::UintegerValue::Copy ( ) const

overridevirtual

Returns

a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 26 of file uinteger.cc.

DeserializeFromString()

bool ns3::UintegerValue::DeserializeFromString ( std::string value, Ptr< const AttributeChecker > checker )

overridevirtual

Parameters

[in]	value	A string representation of the value
[in]	checker	A 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 26 of file uinteger.cc.

Get()

uint64_t ns3::UintegerValue::Get

(

)

const

Returns

The Uinteger value.

Definition at line 26 of file uinteger.cc.

Referenced by TcpVenoTest::AdditiveIncrease(), TcpIllinoisTest::CalculateAlpha(), TcpYeahDecrementTest::CalculateSsThresh(), ns3::tests::GlobalValueTestCase::DoRun(), TcpScalableIncrementTest::DoRun(), TcpVenoTest::DoRun(), TcpBicDecrementTest::ExecuteTest(), TcpLedbatDecrementTest::ExecuteTest(), ns3::RngSeedManager::GetSeed(), TcpVegasTest::IncreaseWindow(), TcpYeahIncrementTest::IncreaseWindow(), ns3::internal::MakeUintegerChecker(), TcpVenoTest::MultiplicativeDecrease(), TcpIllinoisTest::RecalcParam(), and TcpBicIncrementTest::Update().

Here is the caller graph for this function:

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]

value

The Uinteger value, as type T.

Returns

true.

Definition at line 34 of file uinteger.h.

SerializeToString()

std::string ns3::UintegerValue::SerializeToString ( Ptr< const AttributeChecker > checker ) const

overridevirtual

Parameters

[in]

checker

The 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 26 of file uinteger.cc.

Set()

void ns3::UintegerValue::Set

(

const uint64_t &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 26 of file uinteger.cc.

Member Data Documentation

m_value

uint64_t ns3::UintegerValue::m_value

private

The stored Uinteger instance.

Definition at line 34 of file uinteger.h.

---

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

• src/core/model/uinteger.h
• src/core/model/uinteger.cc
• doc/introspected-doxygen.h