ns3::EnumValue Class Reference
[Attribute]

hold variables of type 'enum' More...

#include <enum.h>

Inheritance diagram for ns3::EnumValue:
Inheritance graph
[legend]
Collaboration diagram for ns3::EnumValue:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 EnumValue ()
 EnumValue (int v)
void Set (int v)
int Get (void) const
template<typename T >
bool GetAccessor (T &v) const
virtual Ptr< AttributeValueCopy (void) const
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)

Private Attributes

int m_v

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

ns3::EnumValue::EnumValue ( int  v  ) 

Definition at line 29 of file enum.cc.


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

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

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

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

Definition at line 38 of file enum.cc.

References m_v.

Referenced by ns3::EnumChecker::Check(), and ns3::TimeStepPrecision::Get().

template<typename T >
bool ns3::EnumValue::GetAccessor ( T &  v  )  const [inline]

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

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

void ns3::EnumValue::Set ( int  v  ) 

Definition at line 33 of file enum.cc.

References m_v.


Member Data Documentation

int ns3::EnumValue::m_v [private]

Definition at line 52 of file enum.h.

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


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:10:19 2009 for NS-3 by  doxygen 1.6.3