ns3::DoubleValue Class Reference
[Attribute]

Hold an floating point type. More...

#include <double.h>

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

List of all members.

Public Member Functions

 DoubleValue ()
 DoubleValue (const double &value)
void Set (const double &value)
double Get (void) const
template<typename T >
bool GetAccessor (T &value) 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

double m_value

Detailed Description

Hold an floating point type.

This class can be used to hold variables of floating point type such as 'double' or 'float'. The internal format is 'double'.

Definition at line 41 of file double.h.


Constructor & Destructor Documentation

ns3::DoubleValue::DoubleValue (  ) 
ns3::DoubleValue::DoubleValue ( const double &  value  ) 

Member Function Documentation

virtual Ptr<AttributeValue> ns3::DoubleValue::Copy ( void   )  const [virtual]
Returns:
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

virtual bool ns3::DoubleValue::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.

double ns3::DoubleValue::Get ( void   )  const
template<typename T >
bool ns3::DoubleValue::GetAccessor ( T &  value  )  const [inline]

Definition at line 41 of file double.h.

virtual std::string ns3::DoubleValue::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.

void ns3::DoubleValue::Set ( const double &  value  ) 

Member Data Documentation

double ns3::DoubleValue::m_value [private]

Definition at line 41 of file double.h.


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