ChannelControl Class Reference

#include <ChannelControl.h>

List of all members.

---

Detailed Description

Monitors which hosts are "in range".

Author:

Andras Varga

See also:

ChannelAccess

Public Types
typedef HostEntry *	HostRef
typedef std::vector< cModule * >	ModuleList
Public Member Functions
HostRef	registerHost (cModule *host, const Coord &initialPos)
	Registers the given host.
HostRef	lookupHost (cModule *host)
	Returns the "handle" of a previously registered host.
void	updateHostPosition (HostRef h, const Coord &pos)
	To be called when the host moved; updates proximity info.
const Coord &	getHostPosition (HostRef h)
	Returns the host's position.
const ModuleList &	getNeighbors (HostRef h)
	Get the list of modules in range of the given host.
double	getCommunicationRange (HostRef h)
	Reads init parameters and calculates a maximal interference distance.
const Coord *	getPgs ()
	Returns the playground size.
Protected Member Functions
void	updateConnections (HostRef h)
virtual double	calcInterfDist ()
	Calculate interference distance.
void	updateDisplayString (cModule *playgroundMod)
	Set up playground module's display string.
virtual void	initialize ()
	Reads init parameters and calculates a maximal interference distance.
Protected Attributes
typedef std::list< HostEntry >	HostList
HostList	hosts
bool	coreDebug
	Set debugging for the basic module.
Coord	playgroundSize
	x and y size of the area the nodes are in (in meters)
double	maxInterferenceDistance
	the biggest interference distance in the network.
Friends
std::ostream &	operator<< (std::ostream &, const HostEntry &)
Classes
struct	HostEntry

---

Member Typedef Documentation

typedef HostEntry* ChannelControl::HostRef

typedef std::vector<cModule*> ChannelControl::ModuleList

---

Member Function Documentation

double ChannelControl::calcInterfDist (   )  [protected, virtual]

Calculate interference distance. Calculation of the interference distance based on the transmitter power, wavelength, pathloss coefficient and a threshold for the minimal receive Power You may want to overwrite this function in order to do your own interference calculation { double SPEED_OF_LIGHT = 300000000.0; double interfDistance; //the carrier frequency used double carrierFrequency = par("carrierFrequency"); //maximum transmission power possible double pMax = par("pMax"); //signal attenuation threshold double sat = par("sat"); //path loss coefficient double alpha = par("alpha"); double waveLength = (SPEED_OF_LIGHT / carrierFrequency); //minimum power level to be able to physically receive a signal double minReceivePower = pow(10.0, sat / 10.0); interfDistance = pow(waveLength * waveLength * pMax / (16.0 * M_PI * M_PI * minReceivePower), 1.0 / alpha); coreEV << "max interference distance:" << interfDistance << endl; return interfDistance; }

double ChannelControl::getCommunicationRange (  HostRef  h  )  [inline]

Reads init parameters and calculates a maximal interference distance. { return maxInterferenceDistance; // FIXME this is rather the max... }

const Coord& ChannelControl::getHostPosition (  HostRef  h  )  [inline]

Returns the host's position. {return h->pos;}

const ChannelControl::ModuleList & ChannelControl::getNeighbors (  HostRef  h  )

Get the list of modules in range of the given host. { if (!h->isModuleListValid) { h->neighborModules.clear(); for (std::set<HostRef>::const_iterator it = h->neighbors.begin(); it != h->neighbors.end(); it++) h->neighborModules.push_back((*it)->host); h->isModuleListValid = true; } return h->neighborModules; }

const Coord* ChannelControl::getPgs (   )  [inline]

Returns the playground size. {return &playgroundSize;}

void ChannelControl::initialize (   )  [protected, virtual]

Reads init parameters and calculates a maximal interference distance. Sets up the playgroundSize and calculates the maxInterferenceDistance calcInterfDist { coreDebug = hasPar("coreDebug") ? (bool) par("coreDebug") : false; coreEV << "initializing ChannelControl\n"; playgroundSize.x = par("playgroundSizeX"); playgroundSize.y = par("playgroundSizeY"); maxInterferenceDistance = calcInterfDist(); WATCH(maxInterferenceDistance); WATCH_LIST(hosts); updateDisplayString(parentModule()); }

ChannelControl::HostRef ChannelControl::lookupHost (  cModule *  host  )

Returns the "handle" of a previously registered host. { for (HostList::iterator it = hosts.begin(); it != hosts.end(); it++) if (it->host == host) return &(*it); return 0; }

ChannelControl::HostRef ChannelControl::registerHost (  cModule *  host, const Coord &  initialPos )

Registers the given host. { if (lookupHost(host) != NULL) error("ChannelControl::registerHost(): host (%s)%s already registered", host->className(), host->fullPath().c_str()); HostEntry he; he.host = host; he.pos = initialPos; he.isModuleListValid = false; hosts.push_back(he); return &hosts.back(); // last element }

void ChannelControl::updateConnections (  HostRef  h  )  [protected]

{ Coord& hpos = h->pos; double maxDistSquared = maxInterferenceDistance * maxInterferenceDistance; for (HostList::iterator it = hosts.begin(); it != hosts.end(); ++it) { HostEntry *hi = &(*it); if (hi == h) continue; // get the distance between the two hosts. // (omitting the square root (calling sqrdist() instead of distance()) saves about 5% CPU) bool inRange = hpos.sqrdist(hi->pos) < maxDistSquared; if (inRange) { // nodes within communication range: connect if (h->neighbors.insert(hi).second == true) { hi->neighbors.insert(h); h->isModuleListValid = hi->isModuleListValid = false; } } else { // out of range: disconnect if (h->neighbors.erase(hi)) { hi->neighbors.erase(h); h->isModuleListValid = hi->isModuleListValid = false; } } } }

void ChannelControl::updateDisplayString (  cModule *  playgroundMod  )  [protected]

Set up playground module's display string. Sets up background size by adding the following tags: "p=0,0;b=$playgroundSizeX,$playgroundSizeY" { cDisplayString& d = playgroundMod->backgroundDisplayString(); d.setTagArg("p", 0, 0L); d.setTagArg("p", 1, 0L); d.setTagArg("b", 0, playgroundSize.x); d.setTagArg("b", 1, playgroundSize.y); }

void ChannelControl::updateHostPosition (  HostRef  h, const Coord &  pos )  [inline]

To be called when the host moved; updates proximity info. { h->pos = pos; updateConnections(h); }

---

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  os, const HostEntry &  h )  [friend]

{ os << h.host->fullPath() << " (x=" << h.pos.x << ",y=" << h.pos.y << "), " << h.neighbors.size() << " neighbor(s)"; return os; }

---

Member Data Documentation

bool ChannelControl::coreDebug [protected]

Set debugging for the basic module.

struct typedef std::list<HostEntry> ChannelControl::HostList [protected]

HostList ChannelControl::hosts [protected]

double ChannelControl::maxInterferenceDistance [protected]

the biggest interference distance in the network.

Coord ChannelControl::playgroundSize [protected]

x and y size of the area the nodes are in (in meters)

---

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

• ChannelControl.h
• ChannelControl.cc

---