A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
 UintegerValue (const uint64_t &value)
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
uint64_t Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const uint64_t &value)
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 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. 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
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

Hold an unsigned integer type.

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.

Definition at line 46 of file uinteger.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Implements ns3::AttributeValue.

virtual bool ns3::UintegerValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
valuea string representation of the value
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.

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

Referenced by ns3::GlobalValueTestCase::DoRun(), main(), and ns3::internal::MakeUintegerChecker().

+ Here is the caller graph for this function:

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

Definition at line 46 of file uinteger.h.

virtual std::string ns3::UintegerValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
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.

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

Member Data Documentation

uint64_t ns3::UintegerValue::m_value
private

Definition at line 46 of file uinteger.h.


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