ns3::IntegerValue Class Reference

Hold a signed integer type. More...

#include "integer.h"

Inheritance diagram for ns3::IntegerValue:

Collaboration diagram for ns3::IntegerValue:

Public Member Functions
	IntegerValue ()
	IntegerValue (const int64_t &value)
	Copy constructor. More...
virtual Ptr< AttributeValue >	Copy (void) const
virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
int64_t	Get (void) const
template<typename T >
bool	GetAccessor (T &value) const
	Access the Integer value as type T. More...
virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const
void	Set (const int64_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[[maybe_unused]])
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= ([[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
int64_t	m_value
	The stored Integer instance. More...

Detailed Description

Hold a signed integer type.

AttributeValue implementation for Integer.

This class can be used to hold variables of signed integer type such as int8_t, int16_t, int32_t, int64_t, or, int, etc.

See also

AttributeValue

Definition at line 44 of file integer.h.

Constructor & Destructor Documentation

IntegerValue() [1/2]

ns3::IntegerValue::IntegerValue

(

)

Definition at line 35 of file integer.cc.

IntegerValue() [2/2]

Integer ns3::IntegerValue::IntegerValue

(

const int64_t &

value

)

Copy constructor.

Parameters

[in]

value

The Integer value to copy.

Definition at line 35 of file integer.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::IntegerValue::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 integer.cc.

DeserializeFromString()

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

virtual

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 35 of file integer.cc.

Get()

int64_t ns3::IntegerValue::Get

(

void

)

const

Returns

The Integer value.

Definition at line 35 of file integer.cc.

Referenced by IntegerTraceSourceAttributeTestCase::DoRun(), ns3::tests::RootNamespaceConfigTestCase::DoRun(), ns3::tests::UnderRootNamespaceConfigTestCase::DoRun(), ns3::tests::ObjectVectorConfigTestCase::DoRun(), ns3::tests::SearchAttributesOfParentObjectsTestCase::DoRun(), and ns3::internal::MakeIntegerChecker().

Here is the caller graph for this function:

GetAccessor()

template<typename T >

bool ns3::IntegerValue::GetAccessor ( T &  value ) const

inline

Access the Integer value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The Integer value, as type T.

Returns

true.

Definition at line 44 of file integer.h.

SerializeToString()

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

virtual

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 35 of file integer.cc.

Set()

void ns3::IntegerValue::Set

(

const int64_t &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 35 of file integer.cc.

Member Data Documentation

m_value

int64_t ns3::IntegerValue::m_value

private

The stored Integer instance.

Definition at line 44 of file integer.h.

---

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

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