A Discrete-Event Network Simulator
API
ns3::SimpleOfdmWimaxChannel Class Reference

SimpleOfdmWimaxChannel class. More...

#include "simple-ofdm-wimax-channel.h"

+ Inheritance diagram for ns3::SimpleOfdmWimaxChannel:
+ Collaboration diagram for ns3::SimpleOfdmWimaxChannel:

Public Types

enum  PropModel { RANDOM_PROPAGATION , FRIIS_PROPAGATION , LOG_DISTANCE_PROPAGATION , COST231_PROPAGATION }
 PropModel enumeration. More...
 

Public Member Functions

 SimpleOfdmWimaxChannel (PropModel propModel)
 Creates a channel and sets the propagation model. More...
 
 SimpleOfdmWimaxChannel (void)
 
 ~SimpleOfdmWimaxChannel (void)
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
void Send (Time BlockTime, uint32_t burstSize, Ptr< WimaxPhy > phy, bool isFirstBlock, bool isLastBlock, uint64_t frequency, WimaxPhy::ModulationType modulationType, uint8_t direction, double txPowerDbm, Ptr< PacketBurst > burst)
 Sends a dummy fec block to all connected physical devices. More...
 
void SetPropagationModel (PropModel propModel)
 sets the propagation model More...
 
- Public Member Functions inherited from ns3::WimaxChannel
 WimaxChannel (void)
 
virtual ~WimaxChannel (void)
 
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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::WimaxChannel
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

void DoAttach (Ptr< WimaxPhy > phy)
 Attach functiion. More...
 
Ptr< NetDeviceDoGetDevice (std::size_t i) const
 Get device function. More...
 
std::size_t DoGetNDevices (void) const
 Get number of devices function. More...
 
void EndSendDummyBlock (Ptr< SimpleOfdmWimaxPhy > rxphy, simpleOfdmSendParam *param)
 End send dummy block function. More...
 

Private Attributes

Ptr< PropagationLossModelm_loss
 loss More...
 
std::list< Ptr< SimpleOfdmWimaxPhy > > m_phyList
 phy list 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

SimpleOfdmWimaxChannel class.

Definition at line 42 of file simple-ofdm-wimax-channel.h.

Member Enumeration Documentation

◆ PropModel

PropModel enumeration.

Enumerator
RANDOM_PROPAGATION 
FRIIS_PROPAGATION 
LOG_DISTANCE_PROPAGATION 
COST231_PROPAGATION 

Definition at line 49 of file simple-ofdm-wimax-channel.h.

Constructor & Destructor Documentation

◆ SimpleOfdmWimaxChannel() [1/2]

ns3::SimpleOfdmWimaxChannel::SimpleOfdmWimaxChannel ( void  )

Definition at line 43 of file simple-ofdm-wimax-channel.cc.

References m_loss.

◆ ~SimpleOfdmWimaxChannel()

ns3::SimpleOfdmWimaxChannel::~SimpleOfdmWimaxChannel ( void  )

Definition at line 48 of file simple-ofdm-wimax-channel.cc.

References m_phyList.

◆ SimpleOfdmWimaxChannel() [2/2]

ns3::SimpleOfdmWimaxChannel::SimpleOfdmWimaxChannel ( PropModel  propModel)

Creates a channel and sets the propagation model.

Parameters
propModelthe propagation model to use

Definition at line 65 of file simple-ofdm-wimax-channel.cc.

References COST231_PROPAGATION, FRIIS_PROPAGATION, LOG_DISTANCE_PROPAGATION, m_loss, and RANDOM_PROPAGATION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::SimpleOfdmWimaxChannel::AssignStreams ( int64_t  stream)
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

Implements ns3::WimaxChannel.

Definition at line 220 of file simple-ofdm-wimax-channel.cc.

References m_phyList.

◆ DoAttach()

void ns3::SimpleOfdmWimaxChannel::DoAttach ( Ptr< WimaxPhy phy)
privatevirtual

Attach functiion.

Parameters
phythe phy layer

Implements ns3::WimaxChannel.

Definition at line 118 of file simple-ofdm-wimax-channel.cc.

References m_phyList, and third::phy.

◆ DoGetDevice()

Ptr< NetDevice > ns3::SimpleOfdmWimaxChannel::DoGetDevice ( std::size_t  i) const
privatevirtual

Get device function.

Parameters
ithe device index
Returns
the device

Implements ns3::WimaxChannel.

Definition at line 131 of file simple-ofdm-wimax-channel.cc.

References list, m_phyList, and NS_FATAL_ERROR.

◆ DoGetNDevices()

std::size_t ns3::SimpleOfdmWimaxChannel::DoGetNDevices ( void  ) const
privatevirtual

Get number of devices function.

Returns
the number of devices

Implements ns3::WimaxChannel.

Definition at line 125 of file simple-ofdm-wimax-channel.cc.

References m_phyList.

◆ EndSendDummyBlock()

void ns3::SimpleOfdmWimaxChannel::EndSendDummyBlock ( Ptr< SimpleOfdmWimaxPhy rxphy,
simpleOfdmSendParam param 
)
private

End send dummy block function.

Parameters
rxphythe Ptr<SimpleOfdmWimaxPhy>
paramthe simpleOfdmSendParam *

Definition at line 207 of file simple-ofdm-wimax-channel.cc.

References ns3::simpleOfdmSendParam::GetBurst(), ns3::simpleOfdmSendParam::GetBurstSize(), ns3::simpleOfdmSendParam::GetDirection(), ns3::simpleOfdmSendParam::GetFrequency(), ns3::simpleOfdmSendParam::GetIsFirstBlock(), ns3::simpleOfdmSendParam::GetModulationType(), and ns3::simpleOfdmSendParam::GetRxPowerDbm().

Referenced by Send().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Send()

void ns3::SimpleOfdmWimaxChannel::Send ( Time  BlockTime,
uint32_t  burstSize,
Ptr< WimaxPhy phy,
bool  isFirstBlock,
bool  isLastBlock,
uint64_t  frequency,
WimaxPhy::ModulationType  modulationType,
uint8_t  direction,
double  txPowerDbm,
Ptr< PacketBurst burst 
)

Sends a dummy fec block to all connected physical devices.

Parameters
BlockTimethe time needed to send the block
burstSizethe size of the burst
phythe sender device
isFirstBlocktrue if this block is the first one, false otherwise
isLastBlocktrue if this block is the last one, false otherwise
frequencythe frequency on which the block is sent
modulationTypethe modulation used to send the fec block
directionuplink or downlink
txPowerDbmthe transmission power
burstthe packet burst to send

Definition at line 148 of file simple-ofdm-wimax-channel.cc.

References ns3::PropagationLossModel::CalcRxPower(), EndSendDummyBlock(), ns3::MobilityModel::GetDistanceFrom(), ns3::Object::GetObject(), list, m_loss, m_phyList, third::phy, ns3::Simulator::ScheduleWithContext(), and ns3::Seconds().

+ Here is the call graph for this function:

◆ SetPropagationModel()

void ns3::SimpleOfdmWimaxChannel::SetPropagationModel ( PropModel  propModel)

sets the propagation model

Parameters
propModelthe propagation model to used

Definition at line 91 of file simple-ofdm-wimax-channel.cc.

References COST231_PROPAGATION, FRIIS_PROPAGATION, LOG_DISTANCE_PROPAGATION, m_loss, and RANDOM_PROPAGATION.

Member Data Documentation

◆ m_loss

Ptr<PropagationLossModel> ns3::SimpleOfdmWimaxChannel::m_loss
private

loss

Definition at line 127 of file simple-ofdm-wimax-channel.h.

Referenced by SimpleOfdmWimaxChannel(), Send(), and SetPropagationModel().

◆ m_phyList

std::list<Ptr<SimpleOfdmWimaxPhy> > ns3::SimpleOfdmWimaxChannel::m_phyList
private

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