ns3::EnumChecker Class Reference

#include <enum.h>

Inheritance diagram for ns3::EnumChecker:

Collaboration diagram for ns3::EnumChecker:

Public Member Functions
	EnumChecker ()
void	Add (int v, std::string name)
void	AddDefault (int v, std::string name)
virtual bool	Check (const AttributeValue &value) const
virtual bool	Copy (const AttributeValue &src, AttributeValue &dst) const
	Copy the source to the destination. More...
virtual Ptr< AttributeValue >	Create (void) const
virtual std::string	GetUnderlyingTypeInformation (void) const
virtual std::string	GetValueTypeName (void) const
virtual bool	HasUnderlyingTypeInformation (void) const
Public Member Functions inherited from ns3::AttributeChecker
	AttributeChecker ()
virtual	~AttributeChecker ()
Ptr< AttributeValue >	CreateValidValue (const AttributeValue &value) const
	Create a valid value from the argument value, or reinterpret the argument as a string. More...
Public Member Functions inherited from ns3::SimpleRefCount< AttributeChecker >
	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 Types
typedef std::list< std::pair < int, std::string > >	ValueSet

Private Attributes
ValueSet	m_valueSet

Friends
class	EnumValue

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

Detailed Description

Definition at line 62 of file enum.h.

Member Typedef Documentation

typedef std::list<std::pair<int,std::string> > ns3::EnumChecker::ValueSet

private

Definition at line 79 of file enum.h.

Constructor & Destructor Documentation

ns3::EnumChecker::EnumChecker

(

)

Definition at line 92 of file enum.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::EnumChecker::Add	(	int	v,
		std::string	name
	)

Definition at line 104 of file enum.cc.

References m_valueSet, and NS_LOG_FUNCTION.

Referenced by ns3::MakeEnumChecker().

Here is the caller graph for this function:

void ns3::EnumChecker::AddDefault	(	int	v,
		std::string	name
	)

Definition at line 98 of file enum.cc.

References m_valueSet, and NS_LOG_FUNCTION.

Referenced by ns3::MakeEnumChecker().

Here is the caller graph for this function:

bool ns3::EnumChecker::Check ( const AttributeValue &  value ) const

virtual

Parameters

value

a pointer to the value to check

Returns

true if the input value is both of the right type and if its value is within the requested range. Returns false otherwise.

Implements ns3::AttributeChecker.

Definition at line 110 of file enum.cc.

References ns3::EnumValue::Get(), m_valueSet, and NS_LOG_FUNCTION.

Here is the call graph for this function:

bool ns3::EnumChecker::Copy ( const AttributeValue &  source, AttributeValue &  destination  ) const

virtual

Copy the source to the destination.

Parameters

source	source AttributeValue
destination	destination AttributeValue

Returns

true if copy was successful

Implements ns3::AttributeChecker.

Definition at line 163 of file enum.cc.

References NS_LOG_FUNCTION.

Ptr< AttributeValue > ns3::EnumChecker::Create ( void  ) const

virtual

Returns

a new instance of an AttributeValue (wrapper in an Attribute instance) which matches the type of the underlying attribute.

This method is typically used to create a temporary variable prior to calling Attribute::DeserializeFromString.

Implements ns3::AttributeChecker.

Definition at line 156 of file enum.cc.

References NS_LOG_FUNCTION.

std::string ns3::EnumChecker::GetUnderlyingTypeInformation ( void  ) const

virtual

Returns

a human-readable representation of information about the underlying C++ type.

Implements ns3::AttributeChecker.

Definition at line 140 of file enum.cc.

References m_valueSet, and NS_LOG_FUNCTION.

std::string ns3::EnumChecker::GetValueTypeName ( void  ) const

virtual

Returns

the c++ fully-qualified typename of the subclass of the ns3::AttributeValue base class which is associated to this checker.

A typical return value here is FooValue where Foo is the name of the type being wrapped.

Implements ns3::AttributeChecker.

Definition at line 128 of file enum.cc.

References NS_LOG_FUNCTION.

bool ns3::EnumChecker::HasUnderlyingTypeInformation ( void  ) const

virtual

Returns

true if this checker has information about the underlying C++ type, false otherwise.

If this method returns false, the return value of the GetUnderlyingTypeInformation method cannot be relied upon.

Implements ns3::AttributeChecker.

Definition at line 134 of file enum.cc.

References NS_LOG_FUNCTION.

Friends And Related Function Documentation

friend class EnumValue

friend

Definition at line 78 of file enum.h.

Member Data Documentation

ValueSet ns3::EnumChecker::m_valueSet

private

Definition at line 80 of file enum.h.

Referenced by Add(), AddDefault(), Check(), ns3::EnumValue::DeserializeFromString(), GetUnderlyingTypeInformation(), and ns3::EnumValue::SerializeToString().

---

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

• src/core/model/enum.h
• src/core/model/enum.cc