A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::ChannelListPriv Class Reference

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 ()
 
uint32_t Add (Ptr< Channel > channel)
 
ChannelList::Iterator Begin (void) const
 
ChannelList::Iterator End (void) const
 
Ptr< ChannelGetChannel (uint32_t n)
 
uint32_t GetNChannels (void)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static Ptr< ChannelListPrivGet (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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. 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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 

Static Private Member Functions

static void Delete (void)
 
static Ptr< ChannelListPriv > * DoGet (void)
 

Private Attributes

std::vector< Ptr< Channel > > m_channels
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

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

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::ChannelListPriv::ChannelListPriv ( )

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

References NS_LOG_FUNCTION.

ns3::ChannelListPriv::~ChannelListPriv ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

References m_channels, and NS_LOG_FUNCTION.

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

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

References m_channels, and NS_LOG_FUNCTION.

void ns3::ChannelListPriv::Delete ( void  )
staticprivate

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

void ns3::ChannelListPriv::DoDispose ( void  )
privatevirtual

This method is called by Object::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 114 of file channel-list.cc.

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

+ Here is the call graph for this function:

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

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

References 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:

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

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

References m_channels, and NS_LOG_FUNCTION.

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

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

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

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

References m_channels, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

uint32_t ns3::ChannelListPriv::GetNChannels ( void  )

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

References m_channels, and NS_LOG_FUNCTION.

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

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

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

+ Here is the call graph for this function:

Member Data Documentation

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

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