ns3::DataRateValue Class Reference

AttributeValue implementation for DataRate. More...

#include "data-rate.h"

Inheritance diagram for ns3::DataRateValue:

Collaboration diagram for ns3::DataRateValue:

Public Member Functions
	DataRateValue ()=default
	DataRateValue (const DataRate &value)
	Constructor.
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
DataRate	Get () const
template<typename T>
bool	GetAccessor (T &value) const
	Access the DataRate value as type T.
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (const DataRate &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.
uint32_t	GetReferenceCount () const
	Get the reference count of the object.
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.
void	Ref () const
	Increment the reference count.
void	Unref () const
	Decrement the reference count.

Private Attributes
DataRate	m_value
	The stored DataRate instance.

Detailed Description

AttributeValue implementation for DataRate.

See also

AttributeValue

Definition at line 285 of file data-rate.h.

Constructor & Destructor Documentation

DataRateValue() [1/2]

ns3::DataRateValue::DataRateValue ( )

default

DataRateValue() [2/2]

ns3::DataRateValue::DataRateValue

(

const DataRate &

value

)

Constructor.

Parameters

[in]

value

The DataRate value to use.

Definition at line 20 of file data-rate.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::DataRateValue::Copy ( ) const

overridevirtual

Returns

a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 20 of file data-rate.cc.

DeserializeFromString()

bool ns3::DataRateValue::DeserializeFromString ( std::string value, Ptr< const AttributeChecker > checker )

overridevirtual

Parameters

[in]	value	A string representation of the value
[in]	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 20 of file data-rate.cc.

Get()

DataRate ns3::DataRateValue::Get

(

)

const

Returns

The DataRate value.

Definition at line 20 of file data-rate.cc.

Referenced by LteRadioLinkFailureTestCase::DoRun().

Here is the caller graph for this function:

GetAccessor()

template<typename T>

bool ns3::DataRateValue::GetAccessor ( T & value ) const

inline

Access the DataRate value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The DataRate value, as type T.

Returns

true.

Definition at line 285 of file data-rate.h.

SerializeToString()

std::string ns3::DataRateValue::SerializeToString ( Ptr< const AttributeChecker > checker ) const

overridevirtual

Parameters

[in]

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 20 of file data-rate.cc.

Set()

void ns3::DataRateValue::Set

(

const DataRate &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 20 of file data-rate.cc.

Member Data Documentation

m_value

DataRate ns3::DataRateValue::m_value

private

The stored DataRate instance.

Definition at line 285 of file data-rate.h.

---

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

• src/network/utils/data-rate.h
• src/network/utils/data-rate.cc
• doc/introspected-doxygen.h