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

#include "introspected-doxygen.h"

Inheritance diagram for ns3::BuildingListPriv:

Collaboration diagram for ns3::BuildingListPriv:

Public Member Functions
	BuildingListPriv ()

	~BuildingListPriv ()

uint32_t	Add (Ptr< Building > building)
	Add a Building to the list. More...

BuildingList::Iterator	Begin (void) const
	Returns an interator to the start of the list. More...

BuildingList::Iterator	End (void) const
	Returns an interator to the end of the list. More...

Ptr< Building >	GetBuilding (uint32_t n)
	Gets the n-th Building in the container. More...

uint32_t	GetNBuildings (void)
	Gets the number of Building in the container. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this 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...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) 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 (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) 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 erros. 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 Ptr< BuildingListPriv >	Get (void)
	Get the Singleton instance of BuildingListPriv (or create one) More...

static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

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

Private Member Functions
virtual void	DoDispose (void)
	Destructor implementation. More...

Static Private Member Functions
static void	Delete (void)
	Dispose the Singleton instance of BuildingListPriv. More...

static Ptr< BuildingListPriv > *	DoGet (void)
	Get the Singleton instance of BuildingListPriv (or create one) More...

Private Attributes
std::vector< Ptr< Building > >	m_buildings
	Container of Building. More...

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

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

private implementation detail of the BuildingList API.

Introspection did not find any typical Config paths.

Attributes

BuildingList: The list of all buildings created during the simulation.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Building>
- Flags: read

No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 38 of file building-list.cc.

Constructor & Destructor Documentation

◆ BuildingListPriv()

ns3::BuildingListPriv::BuildingListPriv ( )

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

References NS_LOG_FUNCTION_NOARGS.

◆ ~BuildingListPriv()

ns3::BuildingListPriv::~BuildingListPriv ( )

Definition at line 149 of file building-list.cc.

Member Function Documentation

◆ Add()

uint32_t ns3::BuildingListPriv::Add ( Ptr< Building > building )

Add a Building to the list.

Parameters

building building to add

Returns: index of building in list.

Definition at line 169 of file building-list.cc.

References ns3::Object::Initialize(), m_buildings, and ns3::Simulator::ScheduleWithContext().

Here is the call graph for this function:

◆ Begin()

BuildingList::Iterator ns3::BuildingListPriv::Begin ( void ) const

Returns an interator to the start of the list.

Returns: iterator to the begin of the container.

Definition at line 178 of file building-list.cc.

References m_buildings.

◆ Delete()

void ns3::BuildingListPriv::Delete ( void )

staticprivate

Dispose the Singleton instance of BuildingListPriv.

Note: : this function is automatically called at the simulation end.

Definition at line 137 of file building-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::BuildingListPriv::DoDispose ( void )

privatevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 153 of file building-list.cc.

References ns3::Object::DoDispose(), m_buildings, and NS_LOG_FUNCTION_NOARGS.

Here is the call graph for this function:

◆ DoGet()

Ptr< BuildingListPriv > * ns3::BuildingListPriv::DoGet ( void )

staticprivate

Get the Singleton instance of BuildingListPriv (or create one)

Returns: the BuildingListPriv instance

Definition at line 125 of file building-list.cc.

References Delete(), 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()

BuildingList::Iterator ns3::BuildingListPriv::End ( void ) const

Returns an interator to the end of the list.

Returns: iterator to the end of the container.

Definition at line 183 of file building-list.cc.

References m_buildings.

◆ Get()

Ptr< BuildingListPriv > ns3::BuildingListPriv::Get ( void )

static

Get the Singleton instance of BuildingListPriv (or create one)

Returns: the BuildingListPriv instance

Definition at line 120 of file building-list.cc.

References DoGet().

Referenced by ns3::BuildingList::Add(), ns3::BuildingList::Begin(), Delete(), ns3::BuildingList::End(), ns3::BuildingList::GetBuilding(), and ns3::BuildingList::GetNBuildings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBuilding()

Ptr< Building > ns3::BuildingListPriv::GetBuilding ( uint32_t n )

Gets the n-th Building in the container.

Parameters

n	Building position

Returns: a pointer to the Building

Definition at line 194 of file building-list.cc.

References m_buildings, and NS_ASSERT_MSG.

◆ GetNBuildings()

uint32_t ns3::BuildingListPriv::GetNBuildings ( void )

Gets the number of Building in the container.

Returns: the container size

Definition at line 188 of file building-list.cc.

References m_buildings.

◆ GetTypeId()

TypeId ns3::BuildingListPriv::GetTypeId ( void )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 106 of file building-list.cc.

References m_buildings, ns3::MakeObjectVectorAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

Member Data Documentation

◆ m_buildings

std::vector<Ptr<Building> > ns3::BuildingListPriv::m_buildings

private

Container of Building.

Definition at line 100 of file building-list.cc.

Referenced by Add(), Begin(), DoDispose(), End(), GetBuilding(), GetNBuildings(), and GetTypeId().

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

src/buildings/model/building-list.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ BuildingListPriv()

◆ ~BuildingListPriv()

Member Function Documentation

◆ Add()

◆ Begin()

◆ Delete()

◆ DoDispose()

◆ DoGet()

◆ End()

◆ Get()

◆ GetBuilding()

◆ GetNBuildings()

◆ GetTypeId()

Member Data Documentation

◆ m_buildings