A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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
 
using Tuple1Pack = Tuple1Value::value_type
 tuple of attribute values
 
using Tuple1Value = TupleValue< StringValue, StringValue, EnumValue >
 Tuple1 attribute value.
 
using Tuple2 = std::tuple< double, uint16_t, std::string >
 Tuple2 typedef.
 
enum  TupleTestEnum { VALUE1 , VALUE2 , VALUE3 }
 Test enum type. More...
 

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

Tuple1 m_tuple1
 first tuple
 
Tuple2 m_tuple2
 second tuple
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

Object with attribute values storing tuples.

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

Member Typedef Documentation

◆ Tuple1

tuple of values

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

◆ Tuple1Pack

tuple of attribute values

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

◆ Tuple1Value

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 69 of file tuple-value-test-suite.cc.

Member Enumeration Documentation

◆ 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 127 of file tuple-value-test-suite.cc.

◆ ~TupleObject()

TupleObject::~TupleObject ( )
override

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

Member Function Documentation

◆ GetTuple1()

TupleObject::Tuple1 TupleObject::GetTuple1 ( ) const

Get tuple1.

Returns
tuple1

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

References m_tuple1.

◆ GetTuple2()

TupleObject::Tuple2 TupleObject::GetTuple2 ( ) const

Get tuple2.

Returns
tuple2

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

References m_tuple2.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId TupleObject::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 98 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
tupletuple value

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

References m_tuple1.

◆ SetTuple2()

void TupleObject::SetTuple2 ( const Tuple2 tuple)

Set tuple2.

Parameters
tupletuple value

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

References m_tuple2.

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 93 of file tuple-value-test-suite.cc.

Referenced by GetTuple1(), GetTypeId(), and SetTuple1().

◆ m_tuple2

Tuple2 TupleObject::m_tuple2
private

second tuple

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

Referenced by GetTuple2(), and SetTuple2().


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