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

Abstract Channel Base Class. More...

#include <channel.h>

+ Inheritance diagram for ns3::Channel:
+ Collaboration diagram for ns3::Channel:

Public Member Functions

 Channel ()
 
virtual ~Channel ()
 
virtual Ptr< NetDeviceGetDevice (uint32_t i) const =0
 
uint32_t GetId (void) const
 
virtual uint32_t GetNDevices (void) const =0
 
- 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 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 Attributes

uint32_t m_id
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
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

Abstract Channel Base Class.

A channel is a logical path over which information flows. The path can be as simple as a short piece of wire, or as complicated as space-time.

Subclasses must use Simulator::ScheduleWithContext to correctly update event contexts when scheduling an event from one node to another one.

Config Paths

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

  • /ChannelList/[i]

Attributes

No TraceSources are defined for this type.

Definition at line 43 of file channel.h.

Constructor & Destructor Documentation

ns3::Channel::Channel ( )

Definition at line 46 of file channel.cc.

References ns3::ChannelList::Add(), m_id, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

ns3::Channel::~Channel ( )
virtual

Definition at line 53 of file channel.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

virtual Ptr<NetDevice> ns3::Channel::GetDevice ( uint32_t  i) const
pure virtual
Parameters
iindex of NetDevice to retrieve
Returns
one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implemented in ns3::CsmaChannel, ns3::MultiModelSpectrumChannel, ns3::PointToPointChannel, ns3::SimpleChannel, ns3::UanChannel, ns3::YansWifiChannel, ns3::SingleModelSpectrumChannel, ns3::WimaxChannel, ns3::ErrorChannelSixlow, ns3::ErrorChannel, and ns3::BridgeChannel.

uint32_t ns3::Channel::GetId ( void  ) const
Returns
the unique id of this channel

This unique id happens to be also the index of the Channel into the ChannelList.

Definition at line 59 of file channel.cc.

References m_id, and NS_LOG_FUNCTION.

virtual uint32_t ns3::Channel::GetNDevices ( void  ) const
pure virtual
TypeId ns3::Channel::GetTypeId ( void  )
static

Definition at line 34 of file channel.cc.

References ns3::TypeId::ATTR_GET, m_id, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

uint32_t ns3::Channel::m_id
private

Definition at line 74 of file channel.h.

Referenced by Channel(), GetId(), and GetTypeId().


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