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 (const T &value)
	Constructor.
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
T	Get () const
bool	GetAccessor (T &value) const
	Access the Enum value as type T.
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (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
T	m_value {}
	The stored value.

Detailed Description

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

Hold variables of type enum.

AttributeValue implementation for 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));

See also

AttributeValue

Definition at line 51 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

(

const T &

value

)

Constructor.

Parameters

[in]

value

The Enum value to use.

Definition at line 73 of file enum.h.

References m_value.

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 102 of file enum.h.

References ns3::Create().

Here is the call graph for this function:

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 245 of file enum.h.

References m_value, NS_ASSERT, and ns3::PeekPointer().

Here is the call graph for this function:

Get()

template<typename T>

T ns3::EnumValue< T >::Get

(

)

const

Returns

The Enum value.

Definition at line 87 of file enum.h.

References m_value.

Referenced by ns3::EnumChecker< T >::Check(), ns3::LteHelper::InstallSingleEnbDevice(), ns3::WifiRemoteStationManager::NeedCtsToSelf(), and ns3::WifiRemoteStationManager::NeedRts().

Here is the caller graph for this function:

GetAccessor()

template<typename T>

bool ns3::EnumValue< T >::GetAccessor

(

T &

value

)

const

Access the Enum value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The Enum value, as type T.

Returns

true.

Definition at line 94 of file enum.h.

References m_value.

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 235 of file enum.h.

References m_value, NS_ASSERT, and ns3::PeekPointer().

Here is the call graph for this function:

Set()

template<typename T>

void ns3::EnumValue< T >::Set

(

T

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 80 of file enum.h.

References m_value.

Member Data Documentation

m_value

template<typename T>

T ns3::EnumValue< T >::m_value {}

private

The stored value.

The stored Enum instance.

Definition at line 66 of file enum.h.

Referenced by EnumValue(), DeserializeFromString(), Get(), GetAccessor(), SerializeToString(), and Set().

---

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

• src/core/model/enum.h
• doc/introspected-doxygen.h