A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
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.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

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,

"ErrorRate", DoubleValue (0.05),
Config::SetDefault ("ns3::RipNg::SplitHorizon",
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition double.h:31
Hold variables of type enum.
Definition enum.h:52
Smart pointer class similar to boost::intrusive_ptr.
@ NO_SPLIT_HORIZON
No Split Horizon.
Definition ripng.h:214
void SetDefault(std::string name, const AttributeValue &value)
Definition config.cc:883
Ptr< T > CreateObjectWithAttributes(Args... args)
Allocate an Object on the heap and initialize with a set of attributes.
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]valueThe Enum value to use.

Definition at line 73 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 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]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 245 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 ( ) const
Returns
The Enum value.

Definition at line 87 of file enum.h.

Referenced by ns3::WifiAssocManager::CanSetupMultiLink(), ns3::EnumChecker< T >::Check(), ns3::ApWifiMac::GetMultiLinkElement(), ns3::StaWifiMac::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

Access the Enum value as type T.

Template Parameters
T[explicit] The type to cast to.
Parameters
[out]valueThe Enum value, as type T.
Returns
true.

Definition at line 94 of file enum.h.

◆ SerializeToString()

template<typename T >
std::string ns3::EnumValue< T >::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 235 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)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 80 of file enum.h.

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.


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