A Discrete-Event Network Simulator
API
ns3::RectangleValue Class Reference

AttributeValue implementation for Rectangle. More...

#include "rectangle.h"

+ Inheritance diagram for ns3::RectangleValue:
+ Collaboration diagram for ns3::RectangleValue:

Public Member Functions

 RectangleValue ()
 
 RectangleValue (const Rectangle &value)
 Copy constructor. More...
 
virtual Ptr< AttributeValueCopy (void) const
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)
 
Rectangle Get (void) const
 
template<typename T >
bool GetAccessor (T &value) const
 Access the Rectangle value as type T. More...
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
void Set (const Rectangle &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...
 
SimpleRefCountoperator= ([[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

Rectangle m_value
 The stored Rectangle instance. More...
 

Detailed Description

AttributeValue implementation for Rectangle.

See also
AttributeValue

Definition at line 97 of file rectangle.h.

Constructor & Destructor Documentation

◆ RectangleValue() [1/2]

ns3::RectangleValue::RectangleValue ( )

Definition at line 213 of file rectangle.cc.

◆ RectangleValue() [2/2]

Rectangle ns3::RectangleValue::RectangleValue ( const Rectangle value)

Copy constructor.

Parameters
[in]valueThe Rectangle value to copy.

Definition at line 213 of file rectangle.cc.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 213 of file rectangle.cc.

◆ DeserializeFromString()

bool ns3::RectangleValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
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 213 of file rectangle.cc.

◆ Get()

Rectangle ns3::RectangleValue::Get ( void  ) const
Returns
The Rectangle value.

Definition at line 213 of file rectangle.cc.

◆ GetAccessor()

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

Access the Rectangle value as type T.

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

Definition at line 97 of file rectangle.h.

◆ SerializeToString()

std::string ns3::RectangleValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
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 213 of file rectangle.cc.

◆ Set()

void ns3::RectangleValue::Set ( const Rectangle value)

Set the value.

Parameters
[in]valueThe value to adopt.

Definition at line 213 of file rectangle.cc.

Member Data Documentation

◆ m_value

Rectangle ns3::RectangleValue::m_value
private

The stored Rectangle instance.

Definition at line 97 of file rectangle.h.


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