A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::DoubleValue Class Reference

Hold a floating point type. More...

#include <double.h>

+ Inheritance diagram for ns3::DoubleValue:
+ Collaboration diagram for ns3::DoubleValue:

Public Member Functions

 DoubleValue ()
 
 DoubleValue (const double &value)
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
double Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const double &value)
 
- 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...
 
SimpleRefCountoperator= (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

double m_value
 

Additional Inherited Members

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

Detailed Description

Hold a 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
valuea string representation of the value
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.

double ns3::DoubleValue::Get ( void  ) const

Referenced by main(), and ns3::internal::MakeDoubleChecker().

+ Here is the caller graph for this function:

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

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: