ns3::Channel Class Reference

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< NetDevice >	GetDevice (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)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)

Private Attributes
uint32_t	m_id

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

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

• Id: The id (unique integer) of this Channel.
  • Set with class: ns3::UintegerValue
  • Underlying type: uint32_t 0:4294967295
  • Flags: read

No TraceSources are defined for this type.

Definition at line 43 of file channel.h.

Constructor & Destructor Documentation

ns3::Channel::Channel

(

)

Definition at line 45 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 52 of file channel.cc.

References NS_LOG_FUNCTION.

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

Referenced by ns3::GlobalRouter::AnotherRouterOnLink(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::DistributedSimulatorImpl::CalculateLookAhead(), ns3::GlobalRouter::FindDesignatedRouterForLink(), ns3::GlobalRouter::GetAdjacent(), ns3::Ipv4NixVectorRouting::GetAdjacentNetDevices(), and ns3::AnimationInterface::StartAnimation().

Here is the caller graph for this function:

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 58 of file channel.cc.

References m_id, and NS_LOG_FUNCTION.

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

Referenced by ns3::GlobalRouter::AnotherRouterOnLink(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::GlobalRouter::FindDesignatedRouterForLink(), ns3::GlobalRouter::GetAdjacent(), ns3::Ipv4NixVectorRouting::GetAdjacentNetDevices(), and ns3::AnimationInterface::StartAnimation().

Here is the caller graph for this function:

TypeId ns3::Channel::GetTypeId ( void  )

static

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::ErrorChannel, ns3::BridgeChannel, ns3::SimpleChannel, and ns3::PointToPointRemoteChannel.

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

• src/network/model/channel.h
• src/network/model/channel.cc