A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ObjectPtrContainerValue Class Reference

Container for a set of ns3::Object pointers. More...

#include "object-ptr-container.h"

+ Inheritance diagram for ns3::ObjectPtrContainerValue:
+ Collaboration diagram for ns3::ObjectPtrContainerValue:

Public Types

typedef std::map< std::size_t, Ptr< Object > >::const_iterator Iterator
 Iterator type for traversing this container.
 

Public Member Functions

 ObjectPtrContainerValue ()
 Default constructor.
 
Iterator Begin () const
 Get an iterator to the first Object.
 
Ptr< AttributeValueCopy () const override
 Get a copy of this container.
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 Deserialize from a string.
 
Iterator End () const
 Get an iterator to the past-the-end Object.
 
Ptr< ObjectGet (std::size_t i) const
 Get a specific Object.
 
std::size_t GetN () const
 Get the number of Objects.
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 Serialize each of the Object pointers to a string.
 
- 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 Attributes

std::map< std::size_t, Ptr< Object > > m_objects
 The container implementation.
 

Friends

class ObjectPtrContainerAccessor
 ObjectPtrContainerAccessor::Get() needs access.
 

Detailed Description

Container for a set of ns3::Object pointers.

This class it used to get attribute access to an array of ns3::Object pointers.

See also
AttributeValue

Call graph was not generated because of its size.

Definition at line 56 of file object-ptr-container.h.

Member Typedef Documentation

◆ Iterator

typedef std::map<std::size_t,Ptr<Object>>::const_iterator ns3::ObjectPtrContainerValue::Iterator

Iterator type for traversing this container.

Definition at line 60 of file object-ptr-container.h.

Constructor & Destructor Documentation

◆ ObjectPtrContainerValue()

ns3::ObjectPtrContainerValue::ObjectPtrContainerValue ( )

Default constructor.

Definition at line 34 of file object-ptr-container.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Begin()

ObjectPtrContainerValue::Iterator ns3::ObjectPtrContainerValue::Begin ( ) const

Get an iterator to the first Object.

Returns
An iterator to the first Object.

Definition at line 40 of file object-ptr-container.cc.

References m_objects, and NS_LOG_FUNCTION.

Referenced by LteRadioLinkFailureTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), LteX2HandoverTestCase::CheckConnected(), ns3::AttributeIterator::DoIterate(), ObjectMapAttributeTestCase::DoRun(), and SerializeToString().

+ Here is the caller graph for this function:

◆ Copy()

Ptr< AttributeValue > ns3::ObjectPtrContainerValue::Copy ( ) const
overridevirtual

Get a copy of this container.

Returns
A copy of this container.

Implements ns3::AttributeValue.

Definition at line 74 of file object-ptr-container.cc.

References NS_LOG_FUNCTION.

◆ DeserializeFromString()

bool ns3::ObjectPtrContainerValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
overridevirtual

Deserialize from a string.

(Not implemented; raises a fatal error.)

Parameters
[in]valueThe serialized string form.
[in]checkerThe checker to use.
Returns
true.

Implements ns3::AttributeValue.

Definition at line 98 of file object-ptr-container.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ End()

ObjectPtrContainerValue::Iterator ns3::ObjectPtrContainerValue::End ( ) const

Get an iterator to the past-the-end Object.

Returns
An iterator to the past-the-end Object.

Definition at line 47 of file object-ptr-container.cc.

References m_objects, and NS_LOG_FUNCTION.

Referenced by LteRadioLinkFailureTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), LteX2HandoverTestCase::CheckConnected(), ns3::AttributeIterator::DoIterate(), and SerializeToString().

+ Here is the caller graph for this function:

◆ Get()

Ptr< Object > ns3::ObjectPtrContainerValue::Get ( std::size_t  i) const

Get a specific Object.

Parameters
[in]iThe index of the requested object.
Returns
The requested object

Definition at line 61 of file object-ptr-container.cc.

References m_objects, and NS_LOG_FUNCTION.

Referenced by ObjectVectorAttributeTestCase::DoRun(), and ObjectMapAttributeTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetN()

std::size_t ns3::ObjectPtrContainerValue::GetN ( ) const

Get the number of Objects.

Returns
The number of objects.

Definition at line 54 of file object-ptr-container.cc.

References m_objects, and NS_LOG_FUNCTION.

Referenced by LteRadioLinkFailureTestCase::CheckConnected(), LteRrcConnectionEstablishmentTestCase::CheckConnected(), LteX2HandoverMeasuresTestCase::CheckConnected(), LteX2HandoverTestCase::CheckConnected(), ObjectVectorAttributeTestCase::DoRun(), and ObjectMapAttributeTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SerializeToString()

std::string ns3::ObjectPtrContainerValue::SerializeToString ( Ptr< const AttributeChecker checker) const
overridevirtual

Serialize each of the Object pointers to a string.

Note this serializes the Ptr values, not the Objects themselves.

Parameters
[in]checkerThe checker to use (currently not used.)
Returns
The string form of the Objects.

Implements ns3::AttributeValue.

Definition at line 81 of file object-ptr-container.cc.

References Begin(), End(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ ObjectPtrContainerAccessor

friend class ObjectPtrContainerAccessor
friend

ObjectPtrContainerAccessor::Get() needs access.

Definition at line 117 of file object-ptr-container.h.

Member Data Documentation

◆ m_objects

std::map<std::size_t, Ptr<Object> > ns3::ObjectPtrContainerValue::m_objects
private

The container implementation.

Definition at line 119 of file object-ptr-container.h.

Referenced by Begin(), End(), ns3::ObjectPtrContainerAccessor::Get(), Get(), and GetN().


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