ns3::Channel Class Reference
[Channel]

Abstract Channel Base Class. More...

#include <channel.h>

Inheritance diagram for ns3::Channel:
Inheritance graph
[legend]
Collaboration diagram for ns3::Channel:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Channel ()
 Channel (std::string name)
virtual ~Channel ()
void SetName (std::string)
std::string GetName (void)
virtual uint32_t GetNDevices (void) const =0
virtual Ptr< NetDeviceGetDevice (uint32_t i) const =0

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Channel.

Private Attributes

std::string m_name

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.

Definition at line 40 of file channel.h.


Constructor & Destructor Documentation

ns3::Channel::Channel (  ) 

Definition at line 37 of file channel.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::Channel::Channel ( std::string  name  ) 

Definition at line 43 of file channel.cc.

References NS_LOG_FUNCTION.

ns3::Channel::~Channel (  )  [virtual]

Definition at line 49 of file channel.cc.

References NS_LOG_FUNCTION_NOARGS.


Member Function Documentation

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

This method must be implemented by subclasses.

Implemented in ns3::BridgeChannel, ns3::CsmaChannel, ns3::PointToPointChannel, ns3::Ns2ExtWifiChannel, ns3::YansWifiChannel, and ns3::SimpleChannel.

std::string ns3::Channel::GetName ( void   ) 

Definition at line 62 of file channel.cc.

References m_name, and NS_LOG_FUNCTION_NOARGS.

virtual uint32_t ns3::Channel::GetNDevices ( void   )  const [pure virtual]
Returns:
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implemented in ns3::BridgeChannel, ns3::CsmaChannel, ns3::PointToPointChannel, ns3::Ns2ExtWifiChannel, ns3::YansWifiChannel, and ns3::SimpleChannel.

TypeId ns3::Channel::GetTypeId ( void   )  [static]

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

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::BridgeChannel, ns3::CsmaChannel, ns3::PointToPointChannel, ns3::Ns2ExtWifiChannel, ns3::WifiChannel, ns3::YansWifiChannel, and ns3::SimpleChannel.

Definition at line 30 of file channel.cc.

References ns3::TypeId::SetParent().

void ns3::Channel::SetName ( std::string  name  ) 

Definition at line 55 of file channel.cc.

References m_name, and NS_LOG_FUNCTION.


Member Data Documentation

std::string ns3::Channel::m_name [private]

Definition at line 67 of file channel.h.

Referenced by GetName(), and SetName().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:59 2009 for NS-3 by  doxygen 1.6.3