ThruputMeteringChannel Class Reference

#include <ThruputMeteringChannel.h>

List of all members.

---

Detailed Description

A cBasicChannel extended with throughput calculation. Values get displayed on the link, using the connection's "t=" display string tag.

The display can be customised with the "format" attribute. In the format string, the following characters will get expanded:

• 'N': number of packets
• 'V': volume (in bytes)
• 'p': current packet/sec
• 'b': current bandwidth
• 'u': current channel utilization ()
• 'P': average packet/sec on [0,now)
• 'B': average bandwidth on [0,now)
• 'U': average channel utilization () on [0,now) Other characters are copied verbatim.

"Current" actually means the last measurement interval, which is 10 packets or 0.1s, whichever comes first.

PROBLEM: display only gets updated if there's traffic! (For example, a high pk/sec value might stay displayed even when the link becomes idle!)

Public Member Functions
	ThruputMeteringChannel (const char *name=NULL)
	ThruputMeteringChannel (const ThruputMeteringChannel &ch)
virtual	~ThruputMeteringChannel ()
ThruputMeteringChannel &	operator= (const ThruputMeteringChannel &ch)
virtual cPolymorphic *	dup () const
virtual cPar &	addPar (const char *s)
virtual cPar &	addPar (cPar *p)
virtual bool	deliver (cMessage *msg, simtime_t at)
Protected Member Functions
void	beginNewInterval (simtime_t now)
void	updateDisplay ()
Protected Attributes
cPar *	fmtp
int	batchSize
int	maxInterval
long	numPackets
double	numBits
simtime_t	intvlStartTime
simtime_t	intvlLastPkTime
unsigned long	intvlNumPackets
unsigned long	intvlNumBits
double	currentBitPerSec
double	currentPkPerSec

---

Constructor & Destructor Documentation

ThruputMeteringChannel::ThruputMeteringChannel (  const char *  name = NULL  )  [explicit]

Constructor. : cBasicChannel(name) { fmtp = NULL; batchSize = 10; // packets maxInterval = 0.1; // seconds numPackets = 0; numBits = 0; intvlStartTime = intvlLastPkTime = 0; intvlNumPackets = intvlNumBits = 0; }

ThruputMeteringChannel::ThruputMeteringChannel (  const ThruputMeteringChannel &  ch  )

Copy constructor. : cBasicChannel() { setName(ch.name()); operator=(ch); cArray& parlist = _parList(); fmtp = (cPar *)parlist.get("format"); }

ThruputMeteringChannel::~ThruputMeteringChannel (   )  [virtual]

Destructor. { }

---

Member Function Documentation

cPar & ThruputMeteringChannel::addPar (  cPar *  p  )  [virtual]

Redefined to add an extra attribute { cBasicChannel::addPar(p); const char *s = p->name(); if (!opp_strcmp(s,"format")) fmtp = p; return *p; }

cPar & ThruputMeteringChannel::addPar (  const char *  s  )  [virtual]

Redefined to add an extra attribute { cPar *p = &cBasicChannel::addPar(s); if (!opp_strcmp(s,"format")) fmtp = p; return *p; }

void ThruputMeteringChannel::beginNewInterval (  simtime_t  now  )  [protected]

{ simtime_t duration = now - intvlStartTime; // record measurements currentBitPerSec = intvlNumBits/duration; currentPkPerSec = intvlNumPackets/duration; // restart counters intvlStartTime = now; intvlNumPackets = intvlNumBits = 0; }

bool ThruputMeteringChannel::deliver (  cMessage *  msg, simtime_t  at )  [virtual]

Performs bit error rate, delay and transmission time modelling. { bool ret = cBasicChannel::deliver(msg, t); // count packets and bits numPackets++; numBits += msg->length(); // packet should be counted to new interval if (intvlNumPackets >= batchSize || t-intvlStartTime >= maxInterval) beginNewInterval(t); intvlNumPackets++; intvlNumBits += msg->length(); intvlLastPkTime = t; // update display string updateDisplay(); return ret; }

virtual cPolymorphic* ThruputMeteringChannel::dup (   )  const [inline, virtual]

Creates and returns an exact copy of this object. See cObject for more details. {return new ThruputMeteringChannel(*this);}

ThruputMeteringChannel & ThruputMeteringChannel::operator= (  const ThruputMeteringChannel &  ch  )

Assignment { if (this==&ch) return *this; cBasicChannel::operator=(ch); numPackets = ch.numPackets; numBits = ch.numBits; return *this; }

void ThruputMeteringChannel::updateDisplay (   )  [protected]

{ // retrieve format string const char *fmt = fmtp ? fmtp->stringValue() : "B"; // produce label, based on format string char buf[200]; char *p = buf; simtime_t tt = transmissionFinishes(); if (tt==0) tt = simulation.simTime(); double bps = (tt==0) ? 0 : numBits/tt; double bytes; for (const char *fp = fmt; *fp && buf+200-p>20; fp++) { switch (*fp) { case 'N': // number of packets p += sprintf(p, "%ld", numPackets); break; case 'V': // volume (in bytes) bytes = floor(numBits/8); if (bytes<1024) p += sprintf(p, "%gB", bytes); else if (bytes<1024*1024) p += sprintf(p, "%.3gKB", bytes/1024); else p += sprintf(p, "%.3gMB", bytes/1024/1024); break; case 'p': // current packet/sec p += sprintf(p, "%.3gpps", currentPkPerSec); break; case 'b': // current bandwidth if (currentBitPerSec<1000000) p += sprintf(p, "%.3gk", currentBitPerSec/1000); else p += sprintf(p, "%.3gM", currentBitPerSec/1000000); break; case 'u': // current channel utilization (%) if (datarate()==0) p += sprintf(p, "n/a"); else p += sprintf(p, "%.3g%%", currentBitPerSec/datarate()*100.0); break; case 'P': // average packet/sec on [0,now) p += sprintf(p, "%.3gpps", tt==0 ? 0 : numPackets/tt); break; case 'B': // average bandwidth on [0,now) if (bps<1000000) p += sprintf(p, "%.3gk", bps/1000); else p += sprintf(p, "%.3gM", bps/1000000); break; case 'U': // average channel utilization (%) on [0,now) if (datarate()==0) p += sprintf(p, "n/a"); else p += sprintf(p, "%.3g%%", bps/datarate()*100.0); break; default: *p++ = *fp; } } *p = '\0'; // display label fromGate()->displayString().setTagArg("t", 0, buf); }

---

Member Data Documentation

int ThruputMeteringChannel::batchSize [protected]

double ThruputMeteringChannel::currentBitPerSec [protected]

double ThruputMeteringChannel::currentPkPerSec [protected]

cPar* ThruputMeteringChannel::fmtp [protected]

simtime_t ThruputMeteringChannel::intvlLastPkTime [protected]

unsigned long ThruputMeteringChannel::intvlNumBits [protected]

unsigned long ThruputMeteringChannel::intvlNumPackets [protected]

simtime_t ThruputMeteringChannel::intvlStartTime [protected]

int ThruputMeteringChannel::maxInterval [protected]

double ThruputMeteringChannel::numBits [protected]

long ThruputMeteringChannel::numPackets [protected]

---

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

• ThruputMeteringChannel.h
• ThruputMeteringChannel.cc

---