A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::TupleValue< Args > Class Template Reference

AttributeValue implementation for Tuple. More...

#include "tuple.h"

+ Inheritance diagram for ns3::TupleValue< Args >:
+ Collaboration diagram for ns3::TupleValue< Args >:

Public Types

typedef std::tuple< std::invoke_result_t< decltype(&Args::Get), Args >... > result_type
 Type returned by Get or passed in Set.
 
typedef std::tuple< Args... > value_type
 Type of value stored in the TupleValue.
 

Public Member Functions

 TupleValue ()
 
 TupleValue (const result_type &value)
 Construct this TupleValue from a std::tuple.
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
result_type Get () const
 Get the stored values as a std::tuple.
 
template<typename T >
bool GetAccessor (T &value) const
 Set the given variable to the values stored by this TupleValue object.
 
value_type GetValue () const
 Get the attribute values as a tuple.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const result_type &value)
 Set the stored values.
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
virtual Ptr< AttributeValueCopy () const =0
 
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)=0
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const =0
 
- 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 Member Functions

template<std::size_t... Is>
bool SetValueImpl (std::index_sequence< Is... >, const std::vector< Ptr< AttributeValue > > &values)
 Set the attribute values starting from the given values.
 

Private Attributes

value_type m_value
 Tuple of attribute values.
 

Detailed Description

template<class... Args>
class ns3::TupleValue< Args >

AttributeValue implementation for Tuple.

Hold objects of type std::tuple<Args...>.

Template Parameters
Args[explicit] The list of AttributeValues to be held by this TupleValue
See also
AttributeValue

Definition at line 77 of file tuple.h.

Member Typedef Documentation

◆ result_type

template<class... Args>
typedef std::tuple<std::invoke_result_t<decltype(&Args::Get), Args>...> ns3::TupleValue< Args >::result_type

Type returned by Get or passed in Set.

Definition at line 83 of file tuple.h.

◆ value_type

template<class... Args>
typedef std::tuple<Args...> ns3::TupleValue< Args >::value_type

Type of value stored in the TupleValue.

Definition at line 81 of file tuple.h.

Constructor & Destructor Documentation

◆ TupleValue() [1/2]

template<class... Args>
ns3::TupleValue< Args >::TupleValue

Definition at line 237 of file tuple.h.

◆ TupleValue() [2/2]

template<class... Args>
ns3::TupleValue< Args >::TupleValue ( const result_type value)

Construct this TupleValue from a std::tuple.

Parameters
[in]valueValue with which to construct.

Definition at line 243 of file tuple.h.

Member Function Documentation

◆ Copy()

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

Implements ns3::AttributeValue.

Definition at line 250 of file tuple.h.

References ns3::Create().

+ Here is the call graph for this function:

◆ DeserializeFromString()

template<class... Args>
bool ns3::TupleValue< Args >::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 274 of file tuple.h.

◆ Get()

template<class... Args>
TupleValue< Args... >::result_type ns3::TupleValue< Args >::Get

Get the stored values as a std::tuple.

This differs from the actual value stored in the object which is a tuple of Ptr<AV> where AV is a class derived from AttributeValue.

Returns
stored values as a std::tuple

Definition at line 333 of file tuple.h.

Referenced by TupleValueTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetAccessor()

template<class... Args>
template<typename T >
bool ns3::TupleValue< Args >::GetAccessor ( T &  value) const

Set the given variable to the values stored by this TupleValue object.

Template Parameters
T[deduced] the type of the given variable (normally, the argument type of a set method or the type of a data member)
Parameters
[out]valueThe stored value
Returns
true if the given variable was set

Definition at line 355 of file tuple.h.

◆ GetValue()

template<class... Args>
TupleValue< Args... >::value_type ns3::TupleValue< Args >::GetValue

Get the attribute values as a tuple.

Returns
the attribute values as a tuple

Definition at line 347 of file tuple.h.

◆ SerializeToString()

template<class... Args>
std::string ns3::TupleValue< Args >::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 324 of file tuple.h.

◆ Set()

template<class... Args>
void ns3::TupleValue< Args >::Set ( const result_type value)

Set the stored values.

Parameters
valueThe stored value

Definition at line 340 of file tuple.h.

Referenced by WifiPrimaryChannelsTest::DoSetup().

+ Here is the caller graph for this function:

◆ SetValueImpl()

template<class... Args>
template<std::size_t... Is>
bool ns3::TupleValue< Args >::SetValueImpl ( std::index_sequence< Is... >  ,
const std::vector< Ptr< AttributeValue > > &  values 
)
private

Set the attribute values starting from the given values.

Used by DeserializeFromString method.

Template Parameters
Is[deduced] index sequence
Parameters
valuesthe given attribute values
Returns
true if the attribute values of this object were set

Definition at line 258 of file tuple.h.

Member Data Documentation

◆ m_value

template<class... Args>
value_type ns3::TupleValue< Args >::m_value
private

Tuple of attribute values.

Definition at line 142 of file tuple.h.


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