A Discrete-Event Network Simulator
API
ns3::BuildingListPriv Class Reference

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)
 
BuildingList::Iterator Begin (void) const
 
BuildingList::Iterator End (void) const
 
Ptr< BuildingGetBuilding (uint32_t n)
 
uint32_t GetNBuildings (void)
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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< BuildingListPrivGet (void)
 
static TypeId GetTypeId (void)
 
- 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)
 
static Ptr< BuildingListPriv > * DoGet (void)
 

Private Attributes

std::vector< Ptr< Building > > m_buildings
 

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...
 

Detailed Description

private implementation detail of the BuildingList API.

Introspection did not find any typical Config paths.


Attributes

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

ns3::BuildingListPriv::BuildingListPriv ( )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::BuildingListPriv::~BuildingListPriv ( )

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

Member Function Documentation

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

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

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

+ Here is the call graph for this function:

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

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

References m_buildings.

void ns3::BuildingListPriv::Delete ( void  )
staticprivate

Definition at line 94 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:

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 overriden 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 110 of file building-list.cc.

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

+ Here is the call graph for this function:

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

Definition at line 82 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:

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

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

References m_buildings.

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

Definition at line 77 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:

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

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

References m_buildings, and NS_ASSERT_MSG.

uint32_t ns3::BuildingListPriv::GetNBuildings ( void  )

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

References m_buildings.

TypeId ns3::BuildingListPriv::GetTypeId ( void  )
static

Definition at line 63 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

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

Definition at line 57 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: