The channel object to attach Wimax NetDevices. More...

#include "wimax-channel.h"

Inheritance diagram for ns3::WimaxChannel:

Collaboration diagram for ns3::WimaxChannel:

Public Member Functions
	WimaxChannel ()

	~WimaxChannel () override

virtual int64_t	AssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used by this model.

void	Attach (Ptr< WimaxPhy > phy)
	attach the channel to a physical layer of a device

Ptr< NetDevice >	GetDevice (std::size_t i) const override

std::size_t	GetNDevices () const override

Public Member Functions inherited from ns3::Channel
	Channel ()

	~Channel () override

uint32_t	GetId () const

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Channel
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
virtual void	DoAttach (Ptr< WimaxPhy > phy)=0
	Attach a phy to the channel.

virtual Ptr< NetDevice >	DoGetDevice (std::size_t i) const =0
	Get device corresponding to index.

virtual std::size_t	DoGetNDevices () const =0
	Get number of devices on the channel.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

The channel object to attach Wimax NetDevices.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::WimaxChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::WimaxChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel"
"/ChannelList/[i]/$ns3::WimaxChannel"

No Attributes are defined for this type.

Attributes defined in parent class ns3::Channel

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

No TraceSources are defined for this type.
Group: Wimax

Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 31 of file wimax-channel.h.

Constructor & Destructor Documentation

◆ WimaxChannel()

ns3::WimaxChannel::WimaxChannel ( )

Definition at line 30 of file wimax-channel.cc.

◆ ~WimaxChannel()

ns3::WimaxChannel::~WimaxChannel ( )

override

Definition at line 34 of file wimax-channel.cc.

Member Function Documentation

◆ AssignStreams()

virtual int64_t ns3::WimaxChannel::AssignStreams ( int64_t stream )

pure virtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implemented in ns3::SimpleOfdmWimaxChannel.

◆ Attach()

void ns3::WimaxChannel::Attach ( Ptr< WimaxPhy > phy )

attach the channel to a physical layer of a device

Parameters

phy	the physical layer to which the channel will be attached

Definition at line 39 of file wimax-channel.cc.

References DoAttach().

Here is the call graph for this function:

◆ DoAttach()

virtual void ns3::WimaxChannel::DoAttach ( Ptr< WimaxPhy > phy )

privatepure virtual

Attach a phy to the channel.

Parameters

phy	the phy object to attach

Implemented in ns3::SimpleOfdmWimaxChannel.

Referenced by Attach().

Here is the caller graph for this function:

◆ DoGetDevice()

virtual Ptr< NetDevice > ns3::WimaxChannel::DoGetDevice ( std::size_t i ) const

privatepure virtual

Get device corresponding to index.

Parameters

i	the device index

Returns: the device

Implemented in ns3::SimpleOfdmWimaxChannel.

Referenced by GetDevice().

Here is the caller graph for this function:

◆ DoGetNDevices()

virtual std::size_t ns3::WimaxChannel::DoGetNDevices ( ) const

privatepure virtual

Get number of devices on the channel.

Returns: the number of devices

Implemented in ns3::SimpleOfdmWimaxChannel.

Referenced by GetNDevices().

Here is the caller graph for this function:

◆ GetDevice()

Ptr< NetDevice > ns3::WimaxChannel::GetDevice ( std::size_t i ) const

overridevirtual

Parameters

i	the ith device

Returns: the ith attached device

Implements ns3::Channel.

Definition at line 51 of file wimax-channel.cc.

References DoGetDevice().

Here is the call graph for this function:

◆ GetNDevices()

std::size_t ns3::WimaxChannel::GetNDevices ( ) const

overridevirtual

Returns: the number of attached devices

Implements ns3::Channel.

Definition at line 45 of file wimax-channel.cc.

References DoGetNDevices().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::WimaxChannel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 24 of file wimax-channel.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

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

src/wimax/model/wimax-channel.h
src/wimax/model/wimax-channel.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Attributes defined in parent class ns3::Channel

Constructor & Destructor Documentation

◆ WimaxChannel()

◆ ~WimaxChannel()

Member Function Documentation

◆ AssignStreams()

◆ Attach()

◆ DoAttach()

◆ DoGetDevice()

◆ DoGetNDevices()

◆ GetDevice()

◆ GetNDevices()

◆ GetTypeId()