wimac::Component Class Reference

Component represents the wimac component, virtually being the jacket for all functional units.

#include <Component.hpp>

Inheritance diagram for wimac::Component:

[legend]

Collaboration diagram for wimac::Component:

[legend]

List of all members.

Public Types
typedef ConnectionIdentifier::QoSCategory	QoSCategory
typedef ConnectionIdentifier::StationID	StationID
Public Member Functions
	Component (wns::node::Interface *, const wns::pyconfig::View &)
void	doVisit (wns::probe::bus::IContext &) const
	Implementation of the virtual method in ContextProvider.
unsigned int	getCellID () const
	Get the ID of the cell which is the station ID of the base station.
wns::service::dll::UnicastAddress	getDLLAddress () const
	Access to the DLL Address.
wns::ldk::fun::Main *	getFUN ()
	Returns the functional unit network of this component.
unsigned int	getID () const
	Get the ID of this station.
wns::service::dll::UnicastAddress	getMACAddress () const
	Returns the MAC address of this component.
std::string	getName () const
int	getNumberOfQueuedPDUs (ConnectionIdentifiers cis)
	Used by class PseudoBWreqGenerator for BWreq shortcut.
unsigned int	getRing () const
	Distance measure from the associated BS to be used as probe instance id.
int	getStationType () const
	Indicate the station type, i.e. access point or user terminal.
virtual void	onNodeCreated ()
	Called by the parent node after all components of the parent node have been created.
virtual void	onShutdown ()
	Called by the parent node after simulation end event occured.
virtual void	onWorldCreated ()
	Called by the parent node after all nodes have been setup and all components have executed onNodeCreated().
Private Member Functions
	Component (const Component &)
virtual void	doStartup ()
	Virtual backend of startup().
Component &	operator= (const Component &)
Private Attributes
wns::service::dll::UnicastAddress	address_
wns::probe::bus::ContextProviderCollection	contextProviders_
wns::ldk::fun::Main *	fun_
unsigned int	id_
unsigned int	ring_
int	stationType_

---

Detailed Description

Definition at line 84 of file Component.hpp.

---

Member Typedef Documentation

typedef ConnectionIdentifier::QoSCategory wimac::Component::QoSCategory

Definition at line 91 of file Component.hpp.

typedef ConnectionIdentifier::StationID wimac::Component::StationID

Definition at line 90 of file Component.hpp.

---

Constructor & Destructor Documentation

wimac::Component::Component	(	wns::node::Interface *	_node,
		const wns::pyconfig::View &	_pyco
	)

Parameters:

[in]	_name	The name of this component as used in the Node
[in]	_node	The Node this Component belongs to

Reimplemented from wns::node::component::Component.

wimac::Component::Component

(

const Component &

)

[private]

---

Member Function Documentation

virtual void wimac::Component::doStartup

(

)

[private, virtual]

Implements wns::node::component::Interface.

void wimac::Component::doVisit

(

wns::probe::bus::IContext &

)

const [virtual]

Implements wns::probe::bus::ContextProvider.

unsigned int wimac::Component::getCellID

(

)

const

wns::service::dll::UnicastAddress wimac::Component::getDLLAddress

(

)

const [inline]

Definition at line 130 of file Component.hpp.

wns::ldk::fun::Main* wimac::Component::getFUN

(

)

unsigned int wimac::Component::getID

(

)

const [inline]

Definition at line 107 of file Component.hpp.

wns::service::dll::UnicastAddress wimac::Component::getMACAddress

(

)

const [inline]

Definition at line 176 of file Component.hpp.

std::string wimac::Component::getName

(

)

const [virtual]

Returns:

The name of this component as used in a Node

Note:

This is used to address Components in a Node

Reimplemented from wns::node::component::Component.

int wimac::Component::getNumberOfQueuedPDUs

(

ConnectionIdentifiers

cis

)

Todo:

Replace getNumberOfQueuedPDUs with a better solution.

unsigned int wimac::Component::getRing

(

)

const

For a AP, ring is always 1 For a FRS, ring is always the ring of the next station in uplink + 2 For a UT, ring is always the ring of the RAP + 1

BS(1) <--> RS(3) <--> RS(5) <--> UT(6) ^ ^ ^ | | | v v v UT(2) UT(4) UT(6)

int wimac::Component::getStationType

(

)

const [inline]

The station type IDs correspond to the enum StationType. Here we do not use the IEEE 802.16 terminology. Instead we use the terms access point (AP) and user terminal (UT).

Definition at line 161 of file Component.hpp.

virtual void wimac::Component::onNodeCreated

(

)

[virtual]

Note:

Intra-Node dependencies like connecting components within the node to each other must be handled here. It is forbidden to try to resolve dependencies to other nodes here. Not all nodes have been setup yet.

Implements wns::node::component::Interface.

virtual void wimac::Component::onShutdown

(

)

[virtual]

Implements wns::node::component::Interface.

virtual void wimac::Component::onWorldCreated

(

)

[virtual]

Note:

Resolve Inter-Node dependencies here. There are no restrictions on what you do here.

Implements wns::node::component::Interface.

Component& wimac::Component::operator=

(

const Component &

)

[private]

---

Member Data Documentation

wns::service::dll::UnicastAddress wimac::Component::address_ [private]

Definition at line 194 of file Component.hpp.

wns::probe::bus::ContextProviderCollection wimac::Component::contextProviders_ [private]

Definition at line 197 of file Component.hpp.

wns::ldk::fun::Main* wimac::Component::fun_ [private]

Definition at line 189 of file Component.hpp.

unsigned int wimac::Component::id_ [private]

Definition at line 193 of file Component.hpp.

unsigned int wimac::Component::ring_ [private]

Definition at line 195 of file Component.hpp.

int wimac::Component::stationType_ [private]

Definition at line 192 of file Component.hpp.

---

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

• modules/tl/tcp/src/Component.hpp