A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::DoubleValue Class Reference

This class can be used to hold variables of floating point type such as 'double' or 'float'. More...

#include "double.h"

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

Public Member Functions

 DoubleValue ()=default
 
 DoubleValue (const double &value)
 Constructor.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
double Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Double value as type T.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const double &value)
 Set the value.
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

double m_value
 The stored Double instance.
 

Detailed Description

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

AttributeValue implementation for Double.

The internal format is 'double'.

See also
AttributeValue

Definition at line 31 of file double.h.

Constructor & Destructor Documentation

◆ DoubleValue() [1/2]

ns3::DoubleValue::DoubleValue ( )
default

◆ DoubleValue() [2/2]

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

Constructor.

Parameters
[in]valueThe Double value to use.

Definition at line 26 of file double.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 26 of file double.cc.

◆ DeserializeFromString()

bool ns3::DoubleValue::DeserializeFromString ( std::string value,
Ptr< const AttributeChecker > checker )
overridevirtual
Parameters
[in]valueA string representation of the value
[in]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.

Definition at line 26 of file double.cc.

◆ Get()

double ns3::DoubleValue::Get ( ) const

◆ GetAccessor()

template<typename T >
bool ns3::DoubleValue::GetAccessor ( T & value) const
inline

Access the Double value as type T.

Template Parameters
T[explicit] The type to cast to.
Parameters
[out]valueThe Double value, as type T.
Returns
true.

Definition at line 31 of file double.h.

◆ SerializeToString()

std::string ns3::DoubleValue::SerializeToString ( Ptr< const AttributeChecker > checker) const
overridevirtual
Parameters
[in]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.

Definition at line 26 of file double.cc.

◆ Set()

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

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 26 of file double.cc.

Member Data Documentation

◆ m_value

double ns3::DoubleValue::m_value
private

The stored Double instance.

Definition at line 31 of file double.h.


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