ns3::EnumValue< T > Class Template Reference

Hold variables of type enum. More...

#include "enum.h"

Inheritance diagram for ns3::EnumValue< T >:

Collaboration diagram for ns3::EnumValue< T >:

Public Member Functions
	EnumValue ()
	EnumValue (T value)
	Construct from an explicit value. More...
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
T	Get () const
bool	GetAccessor (T &value) const
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (T value)
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 () const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...
void	Ref () const
	Increment the reference count. More...
void	Unref () const
	Decrement the reference count. More...

Private Attributes
T	m_value
	The stored value. More...

Detailed Description

template<typename T>
class ns3::EnumValue< T >

Hold variables of type enum.

This class can be used to hold variables of any kind of enum.

This is often used with ObjectFactory and Config to bind the value of a particular enum to an Attribute or Config name. For example,

Ptr<RateErrorModel> model = CreateObjectWithAttributes<RateErrorModel> (
  "ErrorRate", DoubleValue (0.05),
  "ErrorUnit", EnumValue (RateErrorModel::ERROR_UNIT_PACKET));
 
Config::SetDefault ("ns3::RipNg::SplitHorizon",
                    EnumValue (RipNg::NO_SPLIT_HORIZON));

Definition at line 61 of file enum.h.

Constructor & Destructor Documentation

EnumValue() [1/2]

template<typename T >

ns3::EnumValue< T >::EnumValue ( )

default

EnumValue() [2/2]

template<typename T >

ns3::EnumValue< T >::EnumValue

(

T

value

)

Construct from an explicit value.

Parameters

[in]

value

The value to begin with.

Definition at line 88 of file enum.h.

Member Function Documentation

Copy()

template<typename T >

Ptr< AttributeValue > ns3::EnumValue< T >::Copy ( ) const

overridevirtual

Returns

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

Implements ns3::AttributeValue.

Definition at line 117 of file enum.h.

DeserializeFromString()

template<typename T >

bool ns3::EnumValue< T >::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 260 of file enum.h.

References NS_ASSERT, and ns3::PeekPointer().

Here is the call graph for this function:

Get()

template<typename T >

T ns3::EnumValue< T >::Get

Definition at line 102 of file enum.h.

Referenced by ns3::WifiAssocManager::CanSetupMultiLink(), ns3::EnumChecker< T >::Check(), ns3::StaWifiMac::GetMultiLinkElement(), ns3::ApWifiMac::GetMultiLinkElement(), ns3::StaWifiMac::GetTidToLinkMappingElements(), ns3::LteHelper::InstallSingleEnbDevice(), and ns3::ApWifiMac::ReceiveAssocRequest().

Here is the caller graph for this function:

GetAccessor()

template<typename T >

bool ns3::EnumValue< T >::GetAccessor

(

T &

value

)

const

Definition at line 109 of file enum.h.

SerializeToString()

template<typename T >

std::string ns3::EnumValue< T >::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 250 of file enum.h.

References NS_ASSERT, and ns3::PeekPointer().

Here is the call graph for this function:

Set()

template<typename T >

void ns3::EnumValue< T >::Set

(

T

value

)

Definition at line 95 of file enum.h.

Member Data Documentation

m_value

template<typename T >

T ns3::EnumValue< T >::m_value

private

The stored value.

Definition at line 81 of file enum.h.

---

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

• src/core/model/enum.h