private implementation detail of the ChannelList API. More...

#include "introspected-doxygen.h"

Inheritance diagram for ns3::ChannelListPriv:

Collaboration diagram for ns3::ChannelListPriv:

Public Member Functions
	ChannelListPriv ()

	~ChannelListPriv () override

uint32_t	Add (Ptr< Channel > channel)

ChannelList::Iterator	Begin () const

ChannelList::Iterator	End () const

Ptr< Channel >	GetChannel (uint32_t n)

uint32_t	GetNChannels ()

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 final
	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< Object >	GetObject () 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< Object >	GetObject (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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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.

SimpleRefCount &	operator= (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, bool permissive=false) 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.

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 Ptr< ChannelListPriv >	Get ()
	Get the channel list object.

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 Member Functions
void	DoDispose () override
	Dispose the channels in the list.

Static Private Member Functions
static void	Delete ()
	Delete the channel list object.

static Ptr< ChannelListPriv > *	DoGet ()
	Get the channel list object.

Private Attributes
std::vector< Ptr< Channel > >	m_channels
	channel objects container

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

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.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

private implementation detail of the ChannelList API.

Config Paths

ns3::ChannelListPriv is accessible through the following paths with Config::Set and Config::Connect:

""

Attributes

ChannelList: The list of all channels created during the simulation.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Channel>
- Flags: read
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Network

Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 27 of file channel-list.cc.

Constructor & Destructor Documentation

◆ ChannelListPriv()

ns3::ChannelListPriv::ChannelListPriv ( )

Definition at line 140 of file channel-list.cc.

References NS_LOG_FUNCTION.

◆ ~ChannelListPriv()

ns3::ChannelListPriv::~ChannelListPriv ( )

override

Definition at line 145 of file channel-list.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Add()

uint32_t ns3::ChannelListPriv::Add ( Ptr< Channel > channel )

Parameters

channel channel to add

Returns: index of channel in list.

This method is called automatically from Channel::Channel so the user has little reason to call it himself.

Definition at line 165 of file channel-list.cc.

References ns3::Object::Initialize(), m_channels, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Here is the call graph for this function:

◆ Begin()

ChannelList::Iterator ns3::ChannelListPriv::Begin ( ) const

Returns: a C++ iterator located at the beginning of this list.

Definition at line 175 of file channel-list.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ Delete()

void ns3::ChannelListPriv::Delete ( )

staticprivate

Delete the channel list object.

Definition at line 133 of file channel-list.cc.

References DoGet(), Get(), NS_LOG_FUNCTION_NOARGS, and ns3::Config::UnregisterRootNamespaceObject().

Referenced by DoGet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::ChannelListPriv::DoDispose ( )

overrideprivatevirtual

Dispose the channels in the list.

Reimplemented from ns3::Object.

Definition at line 151 of file channel-list.cc.

References ns3::Object::DoDispose(), m_channels, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGet()

Ptr< ChannelListPriv > * ns3::ChannelListPriv::DoGet ( )

staticprivate

Get the channel list object.

Returns: the channel list

Definition at line 119 of file channel-list.cc.

References ns3::CreateObject(), Delete(), NS_LOG_FUNCTION_NOARGS, ns3::Config::RegisterRootNamespaceObject(), and ns3::Simulator::ScheduleDestroy().

Referenced by Delete(), and Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ End()

ChannelList::Iterator ns3::ChannelListPriv::End ( ) const

Returns: a C++ iterator located at the end of this list.

Definition at line 182 of file channel-list.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ Get()

Ptr< ChannelListPriv > ns3::ChannelListPriv::Get ( )

static

Get the channel list object.

Returns: the channel list

Definition at line 112 of file channel-list.cc.

References DoGet(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::ChannelList::Add(), ns3::ChannelList::Begin(), Delete(), ns3::ChannelList::End(), ns3::ChannelList::GetChannel(), and ns3::ChannelList::GetNChannels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannel()

Ptr< Channel > ns3::ChannelListPriv::GetChannel ( uint32_t n )

Parameters

n	index of requested channel.

Returns: the Channel associated to index n.

Definition at line 196 of file channel-list.cc.

References m_channels, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ GetNChannels()

uint32_t ns3::ChannelListPriv::GetNChannels ( )

Returns: the number of channels currently in the list.

Definition at line 189 of file channel-list.cc.

References m_channels, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::ChannelListPriv::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 98 of file channel-list.cc.

References m_channels, ns3::MakeObjectVectorAccessor(), ns3::MakeObjectVectorChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

Member Data Documentation

◆ m_channels

std::vector<Ptr<Channel> > ns3::ChannelListPriv::m_channels

private

channel objects container

Definition at line 92 of file channel-list.cc.

Referenced by Add(), Begin(), DoDispose(), End(), GetChannel(), GetNChannels(), and GetTypeId().

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

src/network/model/channel-list.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ ChannelListPriv()

◆ ~ChannelListPriv()

Member Function Documentation

◆ Add()

◆ Begin()

◆ Delete()

◆ DoDispose()

◆ DoGet()

◆ End()

◆ Get()

◆ GetChannel()

◆ GetNChannels()

◆ GetTypeId()

Member Data Documentation

◆ m_channels