ns3::WifiModeValue Class Reference

AttributeValue implementation for WifiMode. More...

#include "wifi-mode.h"

Inheritance diagram for ns3::WifiModeValue:

Collaboration diagram for ns3::WifiModeValue:

Public Member Functions
	WifiModeValue ()
	WifiModeValue (const WifiMode &value)
	Copy constructor. More...
virtual Ptr< AttributeValue >	Copy (void) const
virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
WifiMode	Get (void) const
template<typename T >
bool	GetAccessor (T &value) const
	Access the WifiMode value as type T. More...
virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const
void	Set (const WifiMode &value)
	Set the value. More...
Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()
virtual	~AttributeValue ()
Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) const
	Decrement the reference count. More...

Private Attributes
WifiMode	m_value
	The stored WifiMode instance. More...

Detailed Description

AttributeValue implementation for WifiMode.

See also

AttributeValue

Definition at line 252 of file wifi-mode.h.

Constructor & Destructor Documentation

WifiModeValue() [1/2]

ns3::WifiModeValue::WifiModeValue

(

)

Definition at line 253 of file wifi-mode.cc.

WifiModeValue() [2/2]

WifiMode ns3::WifiModeValue::WifiModeValue

(

const WifiMode &

value

)

Copy constructor.

Parameters

[in]

value

The WifiMode value to copy.

Definition at line 253 of file wifi-mode.cc.

Member Function Documentation

Copy()

Ptr< AttributeValue > ns3::WifiModeValue::Copy ( void  ) const

virtual

Returns

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

Implements ns3::AttributeValue.

Definition at line 253 of file wifi-mode.cc.

DeserializeFromString()

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

virtual

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 253 of file wifi-mode.cc.

Get()

WifiMode ns3::WifiModeValue::Get

(

void

)

const

Returns

The WifiMode value.

Definition at line 253 of file wifi-mode.cc.

GetAccessor()

template<typename T >

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

inline

Access the WifiMode value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The WifiMode value, as type T.

Returns

true.

Definition at line 252 of file wifi-mode.h.

SerializeToString()

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

virtual

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 253 of file wifi-mode.cc.

Set()

void ns3::WifiModeValue::Set

(

const WifiMode &

value

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 253 of file wifi-mode.cc.

Member Data Documentation

m_value

WifiMode ns3::WifiModeValue::m_value

private

The stored WifiMode instance.

Definition at line 252 of file wifi-mode.h.

---

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

• src/wifi/model/wifi-mode.h
• src/wifi/model/wifi-mode.cc
• doc/introspected-doxygen.h