hold variables of type 'enum' More...

#include <enum.h>

Inheritance diagram for ns3::EnumValue:

Collaboration diagram for ns3::EnumValue:

Public Member Functions
	EnumValue ()

	EnumValue (int v)

virtual Ptr< AttributeValue >	Copy (void) const

virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)

int	Get (void) const

template<typename T >
bool	GetAccessor (T &v) const

virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const

void	Set (int v)

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...

SimpleRefCount &	operator= (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
int	m_v

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

Detailed Description

hold variables of type 'enum'

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

Definition at line 37 of file enum.h.

Constructor & Destructor Documentation

ns3::EnumValue::EnumValue ( )

Definition at line 29 of file enum.cc.

References NS_LOG_FUNCTION.

ns3::EnumValue::EnumValue ( int v )

Definition at line 34 of file enum.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

virtual

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

Implements ns3::AttributeValue.

Definition at line 52 of file enum.cc.

References NS_LOG_FUNCTION.

bool ns3::EnumValue::DeserializeFromString	(	std::string	value,
		Ptr< const AttributeChecker >	checker
	)

virtual

Parameters

value	a string representation of the value
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 76 of file enum.cc.

References m_v, ns3::EnumChecker::m_valueSet, NS_ASSERT, NS_LOG_FUNCTION, and ns3::PeekPointer().

Here is the call graph for this function:

int ns3::EnumValue::Get ( void ) const

Definition at line 46 of file enum.cc.

References m_v, and NS_LOG_FUNCTION.

Referenced by ns3::EnumChecker::Check(), and ns3::LteHelper::InstallSingleEnbDevice().

Here is the caller graph for this function:

template<typename T >

bool ns3::EnumValue::GetAccessor ( T & v ) const

Definition at line 56 of file enum.h.

References m_v.

std::string ns3::EnumValue::SerializeToString ( Ptr< const AttributeChecker > checker ) const

virtual

Parameters

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 58 of file enum.cc.

References m_v, ns3::EnumChecker::m_valueSet, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::PeekPointer().

Here is the call graph for this function: