TupleObject Class Reference

Object with attribute values storing tuples. More...

Inheritance diagram for TupleObject:

Collaboration diagram for TupleObject:

Public Types
using	Tuple1 = Tuple1Value::result_type
	tuple of values More...
using	Tuple1Pack = Tuple1Value::value_type
	tuple of attribute values More...
using	Tuple1Value = TupleValue< StringValue, StringValue, EnumValue< TupleTestEnum > >
	Tuple1 attribute value. More...
using	Tuple2 = std::tuple< double, uint16_t, std::string >
	Tuple2 typedef. More...
enum	TupleTestEnum { VALUE1 , VALUE2 , VALUE3 }
	Test enum type. More...

Public Member Functions
	TupleObject ()
	~TupleObject () override
Tuple1	GetTuple1 () const
	Get tuple1. More...
Tuple2	GetTuple2 () const
	Get tuple2. More...
void	SetTuple1 (const Tuple1 &tuple)
	Set tuple1. More...
void	SetTuple2 (const Tuple2 &tuple)
	Set tuple2. More...
Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...
	~Object () override
	Destructor. More...
void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...
void	Dispose ()
	Dispose of this Object. More...
AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...
TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...
template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...
template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...
template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...
void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...
bool	IsInitialized () const
	Check if the object has been initialized. More...
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...
uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...
void	Ref () const
	Increment the reference count. More...
void	Unref () const
	Decrement the reference count. More...
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...
bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...
void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Attributes
Tuple1	m_tuple1
	first tuple More...
Tuple2	m_tuple2
	second tuple More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...
virtual void	DoDispose ()
	Destructor implementation. More...
virtual void	DoInitialize ()
	Initialize() implementation. More...
virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...
virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Object with attribute values storing tuples.

Definition at line 41 of file tuple-value-test-suite.cc.

Member Typedef Documentation

Tuple1

using TupleObject::Tuple1 = Tuple1Value::result_type

tuple of values

Definition at line 67 of file tuple-value-test-suite.cc.

Tuple1Pack

using TupleObject::Tuple1Pack = Tuple1Value::value_type

tuple of attribute values

Definition at line 68 of file tuple-value-test-suite.cc.

Tuple1Value

using TupleObject::Tuple1Value = TupleValue<StringValue, StringValue, EnumValue<TupleTestEnum> >

Tuple1 attribute value.

Definition at line 65 of file tuple-value-test-suite.cc.

Tuple2

using TupleObject::Tuple2 = std::tuple<double, uint16_t, std::string>

Tuple2 typedef.

Definition at line 70 of file tuple-value-test-suite.cc.

Member Enumeration Documentation

TupleTestEnum

enum TupleObject::TupleTestEnum

Test enum type.

Enumerator
VALUE1
VALUE2
VALUE3

Definition at line 47 of file tuple-value-test-suite.cc.

Constructor & Destructor Documentation

TupleObject()

TupleObject::TupleObject

(

)

Definition at line 128 of file tuple-value-test-suite.cc.

~TupleObject()

TupleObject::~TupleObject ( )

override

Definition at line 132 of file tuple-value-test-suite.cc.

Member Function Documentation

GetTuple1()

TupleObject::Tuple1 TupleObject::GetTuple1

(

)

const

Get tuple1.

Returns

tuple1

Definition at line 143 of file tuple-value-test-suite.cc.

GetTuple2()

TupleObject::Tuple2 TupleObject::GetTuple2

(

)

const

Get tuple2.

Returns

tuple2

Definition at line 155 of file tuple-value-test-suite.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

GetTypeId()

TypeId TupleObject::GetTypeId ( void  )

static

Get the type ID.

Returns

the object TypeId

Definition at line 99 of file tuple-value-test-suite.cc.

References GetTuple2(), m_tuple1, ns3::MakeEnumChecker(), ns3::MakeStringChecker(), ns3::TypeId::SetParent(), SetTuple2(), VALUE1, and VALUE2.

Here is the call graph for this function:

SetTuple1()

void TupleObject::SetTuple1

(

const Tuple1 &

tuple

)

Set tuple1.

Parameters

tuple

tuple value

Definition at line 137 of file tuple-value-test-suite.cc.

SetTuple2()

void TupleObject::SetTuple2

(

const Tuple2 &

tuple

)

Set tuple2.

Parameters

tuple

tuple value

Definition at line 149 of file tuple-value-test-suite.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

m_tuple1

Tuple1 TupleObject::m_tuple1

private

first tuple

Definition at line 94 of file tuple-value-test-suite.cc.

Referenced by GetTypeId().

m_tuple2

Tuple2 TupleObject::m_tuple2

private

second tuple

Definition at line 95 of file tuple-value-test-suite.cc.

---

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

• src/core/test/tuple-value-test-suite.cc