A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 ()=default
 
 IntegerValue (const int64_t &value)
 Constructor.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
int64_t Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Integer value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const int64_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.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

int64_t m_value
 The stored Integer instance.
 

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

Constructor & Destructor Documentation

◆ IntegerValue() [1/2]

ns3::IntegerValue::IntegerValue ( )
default

◆ IntegerValue() [2/2]

ns3::IntegerValue::IntegerValue ( const int64_t & value)

Constructor.

Parameters
[in]valueThe Integer value to use.

Definition at line 26 of file integer.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 26 of file integer.cc.

◆ DeserializeFromString()

bool ns3::IntegerValue::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 26 of file integer.cc.

◆ Get()

int64_t ns3::IntegerValue::Get ( ) const
Returns
The Integer value.

Definition at line 26 of file integer.cc.

Referenced by IntegerTraceSourceAttributeTestCase::DoRun(), ns3::tests::ObjectVectorConfigTestCase::DoRun(), ns3::tests::RootNamespaceConfigTestCase::DoRun(), ns3::tests::SearchAttributesOfParentObjectsTestCase::DoRun(), ns3::tests::UnderRootNamespaceConfigTestCase::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]valueThe Integer value, as type T.
Returns
true.

Definition at line 34 of file integer.h.

◆ SerializeToString()

std::string ns3::IntegerValue::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 26 of file integer.cc.

◆ Set()

void ns3::IntegerValue::Set ( const int64_t & value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 26 of file integer.cc.

Member Data Documentation

◆ m_value

int64_t ns3::IntegerValue::m_value
private

The stored Integer instance.

Definition at line 34 of file integer.h.


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