ns-3
ns3::Channel Class Reference

Abstract Channel Base Class. More...

#include <channel.h>

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

List of all members.

Public Member Functions

uint32_t GetId (void) const
virtual uint32_t GetNDevices (void) const =0
virtual Ptr< NetDeviceGetDevice (uint32_t i) const =0
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::Channel.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

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.


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::UanChannel, ns3::SingleModelSpectrumChannel, ns3::YansWifiChannel, ns3::WimaxChannel, ns3::SimpleChannel, and ns3::BridgeChannel.

Referenced by ns3::AnimationInterface::StartAnimation().

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.

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

This method returns the TypeId associated to ns3::Channel.

Attributes defined for this type:

No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::MultiModelSpectrumChannel, ns3::CsmaChannel, ns3::UanChannel, ns3::YansWifiChannel, ns3::PointToPointChannel, ns3::SpectrumChannel, ns3::SingleModelSpectrumChannel, ns3::WifiChannel, ns3::WimaxChannel, ns3::BridgeChannel, ns3::SimpleChannel, and ns3::PointToPointRemoteChannel.

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


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