A Discrete-Event Network Simulator
API
ns3::WimaxChannel Class Referenceabstract

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 (void)
 
virtual ~WimaxChannel (void)
 
virtual int64_t AssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void Attach (Ptr< WimaxPhy > phy)
 attach the channel to a physical layer of a device More...
 
Ptr< NetDeviceGetDevice (std::size_t i) const
 
std::size_t GetNDevices (void) const
 
- Public Member Functions inherited from ns3::Channel
 Channel ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Channel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

virtual void DoAttach (Ptr< WimaxPhy > phy)=0
 Attach a phy to the channel. More...
 
virtual Ptr< NetDeviceDoGetDevice (std::size_t i) const =0
 Get device corresponding to index. More...
 
virtual std::size_t DoGetNDevices (void) const =0
 Get number of devices on the channel. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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::WimaxNetDevice/Phy/Channel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::WimaxChannel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::WimaxChannel"
  • "/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.

No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ WimaxChannel()

ns3::WimaxChannel::WimaxChannel ( void  )

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

◆ ~WimaxChannel()

ns3::WimaxChannel::~WimaxChannel ( void  )
virtual

Definition at line 44 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
streamfirst 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
phythe physical layer to which the channel will be attached

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

References DoAttach(), and third::phy.

+ 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
phythe 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
ithe 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 ( void  ) 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
virtual
Parameters
ithe ith device
Returns
the ith attached device

Implements ns3::Channel.

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

References DoGetDevice().

+ Here is the call graph for this function:

◆ GetNDevices()

std::size_t ns3::WimaxChannel::GetNDevices ( void  ) const
virtual
Returns
the number of attached devices

Implements ns3::Channel.

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

References DoGetNDevices().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::WimaxChannel::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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