ns3::WimaxHelper Class Reference

helps to manage and create WimaxNetDevice objects More...

#include <wimax-helper.h>

Inheritance diagram for ns3::WimaxHelper:

[legend]

Collaboration diagram for ns3::WimaxHelper:

[legend]

List of all members.

Public Types
enum	NetDeviceType { DEVICE_TYPE_SUBSCRIBER_STATION, DEVICE_TYPE_BASE_STATION }
enum	PhyType { SIMPLE_PHY_TYPE_OFDM }
enum	SchedulerType { SCHED_TYPE_SIMPLE, SCHED_TYPE_RTPS, SCHED_TYPE_MBQOS }
Public Member Functions
	WimaxHelper (void)
	Create a Wimax helper in an empty state.
Ptr< WimaxPhy >	CreatePhy (PhyType phyType)
Ptr< UplinkScheduler >	CreateUplinkScheduler (SchedulerType schedulerType)
Ptr< BSScheduler >	CreateBSScheduler (SchedulerType schedulerType)
NetDeviceContainer	Install (NodeContainer c, NetDeviceType type, PhyType phyType, SchedulerType schedulerType)
NetDeviceContainer	Install (NodeContainer c, NetDeviceType deviceType, PhyType phyType, Ptr< WimaxChannel > channel, SchedulerType schedulerType)
NetDeviceContainer	Install (NodeContainer c, NetDeviceType deviceType, PhyType phyType, SchedulerType schedulerType, double frameDuration)
void	SetPropagationLossModel (SimpleOfdmWimaxChannel::PropModel propagationModel)
	Set the propagation and loss model of the channel. By default the channel uses a COST231 propagation and loss model.
Ptr< WimaxPhy >	CreatePhyWithoutChannel (PhyType phyType)
Ptr< WimaxPhy >	CreatePhyWithoutChannel (PhyType phyType, char *SNRTraceFilePath, bool activateLoss)
Ptr< WimaxPhy >	CreatePhy (PhyType phyType, char *SNRTraceFilePath, bool activateLoss)
Ptr< WimaxNetDevice >	Install (Ptr< Node > node, NetDeviceType deviceType, PhyType phyType, Ptr< WimaxChannel > channel, SchedulerType schedulerType)
ServiceFlow	CreateServiceFlow (ServiceFlow::Direction direction, ServiceFlow::SchedulingType schedulinType, IpcsClassifierRecord classifier)
	Creates a transport service flow.
Static Public Member Functions
static void	EnableAsciiForConnection (Ptr< OutputStreamWrapper > oss, uint32_t nodeid, uint32_t deviceid, char netdevice, char connection)
	Enable ascii trace output on the indicated net device for a given connection.
static void	EnableLogComponents (void)

Detailed Description

helps to manage and create WimaxNetDevice objects

This class can help to create a large set of similar WimaxNetDevice objects and to configure their attributes during creation.

Member Enumeration Documentation

enum ns3::WimaxHelper::NetDeviceType

Net Device Type Distinguish a subscriber station(SS) device from base station(BS) device

Enumerator:

DEVICE_TYPE_SUBSCRIBER_STATION	Subscriber station(SS) device
DEVICE_TYPE_BASE_STATION	Base station(BS) device

enum ns3::WimaxHelper::PhyType

WiMAX Physical layer WiMAX Physical layers with different levels of detail

enum ns3::WimaxHelper::SchedulerType

Scheduler Type Different implementations of uplink/downlink scheduler

Enumerator:

SCHED_TYPE_SIMPLE	A simple priority-based FCFS scheduler
SCHED_TYPE_RTPS	A simple scheduler - rtPS based scheduler
SCHED_TYPE_MBQOS	An migration-based uplink scheduler

Member Function Documentation

Ptr<BSScheduler> ns3::WimaxHelper::CreateBSScheduler ( SchedulerType schedulerType )

Parameters:

schedulerType

Scheduling mechanism

Returns:: Downlink scheduler

Creates a downlink scheduler to be used by base station according to selected scheduling mechanism.

Ptr<WimaxPhy> ns3::WimaxHelper::CreatePhy	(	PhyType	phyType,
		char *	SNRTraceFilePath,
		bool	activateLoss
	)

Parameters:

	phyType	WiMAX Physical layer type
	SNRTraceFilePath	the path to the repository containing the SNR traces files
	activateLoss	set to 1 if you want ton activate losses 0 otherwise

Returns:: WiMAX Phy object

Creates a physical layer

Ptr<WimaxPhy> ns3::WimaxHelper::CreatePhy ( PhyType phyType )

Parameters:

phyType

WiMAX Physical layer type

Returns:: WiMAX Phy object

Creates a physical layer object to be used in simulation.

Ptr<WimaxPhy> ns3::WimaxHelper::CreatePhyWithoutChannel	(	PhyType	phyType,
		char *	SNRTraceFilePath,
		bool	activateLoss
	)

Parameters:

	phyType	WiMAX Physical layer type
	SNRTraceFilePath	of the repository containing the SNR traces files
	activateLoss	set to 1 to activate losses 0 otherwise

Returns:: WiMAX Phy object

Creates a physical layer without creating a channel

Ptr<WimaxPhy> ns3::WimaxHelper::CreatePhyWithoutChannel ( PhyType phyType )

Parameters:

phyType

WiMAX Physical layer type

Returns:: WiMAX Phy object

Creates a physical layer without a channel

ServiceFlow ns3::WimaxHelper::CreateServiceFlow	(	ServiceFlow::Direction	direction,
		ServiceFlow::SchedulingType	schedulinType,
		IpcsClassifierRecord	classifier
	)

Creates a transport service flow.

Parameters:

	direction	the direction of the service flow: UP or DOWN.
	schedulinType	The service scheduling type to be used: UGS, RTPS, NRTPS, BE
	classifier	The classifier to be used for this service flow

Ptr<UplinkScheduler> ns3::WimaxHelper::CreateUplinkScheduler ( SchedulerType schedulerType )

Parameters:

schedulerType

Scheduling mechanism

Returns:: Uplink scheduler

Creates a uplink scheduler to be used by base station according to selected scheduling mechanism.

static void ns3::WimaxHelper::EnableAsciiForConnection	(	Ptr< OutputStreamWrapper >	oss,
		uint32_t	nodeid,
		uint32_t	deviceid,
		char *	netdevice,
		char *	connection
	)			`[static]`

Enable ascii trace output on the indicated net device for a given connection.

Parameters:

	oss	The output stream object to use when logging ascii traces.
	nodeid	the id of the node for which you want to enable tracing.
	deviceid	the id of the net device for which you want to enable tracing.
	netdevice	the type of net device for which you want to enable tracing (SubscriberStationNetDevice, BaseStationNetDevice or WimaxNetDevice)
	connection	the connection for which you want to enable tracing (InitialRangingConnection, BroadcastConnection, BasicConnection, PrimaryConnection).

static void ns3::WimaxHelper::EnableLogComponents ( void ) [static]

Helper to enable all WimaxNetDevice log components with one statement

Ptr<WimaxNetDevice> ns3::WimaxHelper::Install	(	Ptr< Node >	node,
		NetDeviceType	deviceType,
		PhyType	phyType,
		Ptr< WimaxChannel >	channel,
		SchedulerType	schedulerType
	)

Parameters:

	node	Node to be installed.
	deviceType	Device type to create.
	phyType	PHY type to create.
	channel	A channel to use.
	schedulerType	The scheduling mechanism to install on the device.

For each of the input nodes, a new WiMAX net device (either ns3::SubscriberStationNetDevice or ns3::BaseStationNetDevice depending on the type parameter) is attached to the shared input channel.

NetDeviceContainer ns3::WimaxHelper::Install	(	NodeContainer	c,
		NetDeviceType	deviceType,
		PhyType	phyType,
		SchedulerType	schedulerType,
		double	frameDuration
	)

Parameters:

	c	A set of nodes.
	deviceType	Device type to create.
	phyType	PHY type to create.
	schedulerType	The scheduling mechanism.
	frameDuration	the farme duration in seconds

For each of the input nodes, a new WiMAX net device (either ns3::SubscriberStationNetDevice or ns3::BaseStationNetDevice depending on the type parameter) is attached to the shared input channel.

NetDeviceContainer ns3::WimaxHelper::Install	(	NodeContainer	c,
		NetDeviceType	deviceType,
		PhyType	phyType,
		Ptr< WimaxChannel >	channel,
		SchedulerType	schedulerType
	)

Parameters:

	c	A set of nodes.
	deviceType	Device type to create.
	phyType	PHY type to create.
	channel	A channel to use.
	schedulerType	The scheduling mechanism.

For each of the input nodes, a new WiMAX net device (either ns3::SubscriberStationNetDevice or ns3::BaseStationNetDevice depending on the type parameter) is attached to the shared input channel.

NetDeviceContainer ns3::WimaxHelper::Install	(	NodeContainer	c,
		NetDeviceType	type,
		PhyType	phyType,
		SchedulerType	schedulerType
	)

Parameters:

	c	a set of nodes
	type	device type to create
	phyType	a phy to use
	schedulerType	the type of the scheduling algorithm to install

For each of the input nodes, a new WiMAX net device (either ns3::SubscriberStationNetDevice or ns3::BaseStationNetDevice depending on the type parameter) is attached to the shared input channel.

void ns3::WimaxHelper::SetPropagationLossModel ( SimpleOfdmWimaxChannel::PropModel propagationModel )

Set the propagation and loss model of the channel. By default the channel uses a COST231 propagation and loss model.

Parameters:

propagationModel

The propagation and loss model to set

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

src/helper/wimax-helper.h

ns3::WimaxHelper Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation