Class representing QoSReq with all its properties that is primarily used by FA, RMT and RA Specification sources are http://nes.fit.vutbr.cz/ivesely/pmwiki.php/RINA/EFCP#t2._QoS-Cube_Specfic_Parameters and http://nes.fit.vutbr.cz/ivesely/pmwiki.php/RINA/ServiceDefinition. More...

#include <QoSReq.h>

Public Member Functions
	QoSReq ()
	Constructor of QoSReq with undefined values. More...

	QoSReq (int tavgBand, int tavgSDUBand, int tpeakBandDuration, int tpeakSDUBandDuration, int tburstPeriod, int tburstDuration, double tundetectedBitErr, double tpduDropProbab, int tmaxSDUsize, bool tpartDeliv, bool tincompleteDeliv, bool tforceOrder, unsigned int tmaxAllowGap, int tdelay, int tjitter, int tcosttime, int tcostbits)

	QoSReq (cXMLElementList &attrs)

virtual	~QoSReq ()
	Destructor assigning default uninitialized values. More...

bool	compare (const QoSReq &other) const

int	getAvgBand () const
	Gets Average Bandwidth parameter. More...

void	setAvgBand (int avgBand)
	Sets Average Bandwidth parameter. More...

int	getAvgSduBand () const
	Gets Average SDU Bandwidth parameter. More...

void	setAvgSduBand (int avgSduBand)
	Sets Average SDU Bandwidth parameter. More...

int	getPeakBandDuration () const
	Gets Peak Band Duration parameter. More...

void	setPeakBandDuration (int peakBandDuration)
	Sets Peak Band Duration parameter. More...

int	getPeakSduBandDuration () const
	Gets Peak SDU Duration parameter. More...

void	setPeakSduBandDuration (int peakSduBandDuration)
	Sets Peak SDU Duration parameter. More...

int	getBurstDuration () const
	Gets Burst Duration parameter. More...

void	setBurstDuration (int burstDuration)
	Sets Burst Duration parameter. More...

int	getBurstPeriod () const
	Gets Burst Period parameter. More...

void	setBurstPeriod (int burstPeriod)
	Sets Burst Period parameter. More...

int	getMaxSduSize () const
	Gets Maximum SDU Size parameter. More...

void	setMaxSduSize (int maxSdUsize)
	Sets Maximum SDU Size parameter. More...

double	getUndetectedBitErr () const
	Gets Undetected Bit Error Rate parameter. More...

void	setUndetectedBitErr (double undetectedBitErr)
	Sets Undetected Bit Error Rate parameter. More...

double	getPduDropProbability () const
	Gets PDU Dropping Probability parameter. More...

void	setPduDropProbability (double pduDropProbability)
	Sets PDU Dropping Probability parameter. More...

bool	isPartialDelivery () const
	Gets partial delivery flag. More...

void	setPartialDelivery (bool partDeliv)
	Sets partial delivery flag. More...

bool	isIncompleteDelivery () const
	Gets incomplete delivery flag. More...

void	setIncompleteDelivery (bool incompleteDeliv)
	Sets incomplete delivery flag. More...

bool	isForceOrder () const
	Gets in-order delivery flag. More...

void	setForceOrder (bool forceOrder)
	Sets in-order delivery flag. More...

int	getMaxAllowGap () const
	Gets Maximum Allowable Gap in SDUs parameter. More...

void	setMaxAllowGap (int maxAllowGap)
	Sets Maximum Allowable Gap in SDUs parameter. More...

int	getDelay () const
	Gets Delay parameter. More...

void	setDelay (int delay)
	Sets Delay parameter. More...

int	getJitter () const
	Gets Jitter parameter. More...

void	setJitter (int jitter)
	Sets Jitter parameter. More...

double	getCostTime () const
	Gets Cost-time parameter. More...

void	setCostTime (double costTime)
	Sets Cost-time parameter. More...

double	getCostBits () const
	Gets Cost-bits parameter. More...

void	setCostBits (double costBits)
	Sets Cost-bits parameter. More...

int	getResiliencyFactor () const
	Gets Resiliency Factor parameter. More...

void	setResiliencyFactor (int resiliencyFactor)
	Sets Resiliency Factor parameter. More...

std::string	info () const
	Prints QoSReq information as string. More...

Static Public Attributes
static const QoSReq	MANAGEMENT

Protected Attributes
int	avgBand
	Attribute holding average bandwidth. More...

int	avgSDUBand
	Attribute holding average SDU bandwidth. More...

int	peakBandDuration
	Attribute holding peak bandwidth duration. More...

int	peakSDUBandDuration
	Attribute holding peak SDU bandwidth duration. More...

int	burstPeriod
	Attribute holding burst period in usecs. More...

int	burstDuration
	Attribute holding burst durating as usec fraction of burst period. More...

double	undetectedBitErr
	Attribute holding probability of undetected bit error rate. More...

double	pduDropProbability
	Attribute holding probability of dropping PDUs. More...

int	maxSDUsize
	Attribute holding maximum SDU size. More...

bool	partDeliv
	Attribute holding partial delivery flag. More...

bool	incompleteDeliv
	Attribute holding incomplete delivery flag. More...

bool	forceOrder
	Attribute holding in-order delivery flag. More...

int	maxAllowGap
	Attribute holding maximum allowd gap in SDUs. More...

int	delay
	Attribute holding accepted delay. More...

int	jitter
	Attribute holding accepted jitter. More...

int	costTime
	Attribute holding connection's time price. More...

int	costBits
	Attribute holding connection's transmission size price. More...

int	resiliencyFactor
	Attribute holding resiliency information, see PRISTINE D4.3 for more. More...

Detailed Description

Class representing QoSReq with all its properties that is primarily used by FA, RMT and RA Specification sources are http://nes.fit.vutbr.cz/ivesely/pmwiki.php/RINA/EFCP#t2._QoS-Cube_Specfic_Parameters and http://nes.fit.vutbr.cz/ivesely/pmwiki.php/RINA/ServiceDefinition.

Authors: Vladimir Vesely (ivese.nosp@m.ly@f.nosp@m.it.vu.nosp@m.tbr..nosp@m.cz)

Date: Last refactorized and documented on 2015-01-12

Definition at line 44 of file QoSReq.h.

Constructor & Destructor Documentation

QoSReq::QoSReq ( )

Constructor of QoSReq with undefined values.

Definition at line 37 of file QoSReq.cc.

QoSReq::QoSReq	(	int	tavgBand,
		int	tavgSDUBand,
		int	tpeakBandDuration,
		int	tpeakSDUBandDuration,
		int	tburstPeriod,
		int	tburstDuration,
		double	tundetectedBitErr,
		double	tpduDropProbab,
		int	tmaxSDUsize,
		bool	tpartDeliv,
		bool	tincompleteDeliv,
		bool	tforceOrder,
		unsigned int	tmaxAllowGap,
		int	tdelay,
		int	tjitter,
		int	tcosttime,
		int	tcostbits
	)

Definition at line 46 of file QoSReq.cc.

QoSReq::QoSReq ( cXMLElementList & attrs )

Definition at line 99 of file QoSReq.cc.

QoSReq::~QoSReq ( )

virtual

Destructor assigning default uninitialized values.

Definition at line 202 of file QoSReq.cc.

Member Function Documentation

bool QoSReq::compare ( const QoSReq & other ) const

Comparator comparing this and other AP requirements.

Parameters

other

Returns: Returns true if other requirements are same or less than this, otherwise returns false.

Definition at line 355 of file QoSReq.cc.

Referenced by Flow::isManagementFlow(), AE::receiveAllocationRequestFromFAI(), DAFEnrollment::receiveAllocationRequestFromFAI(), LisDAFEnrollmentAllResPosi::receiveSignal(), and LisDAFEnrollmentAllReqFromFai::receiveSignal().

int QoSReq::getAvgBand ( ) const

Gets Average Bandwidth parameter.

Returns: Value measured at the application in bits/sec

Definition at line 221 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getAvgSduBand ( ) const

Gets Average SDU Bandwidth parameter.

Returns: Value measured in SDUs/sec

Definition at line 229 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getBurstDuration ( ) const

Gets Burst Duration parameter.

Returns: Value measured in usecs

Definition at line 237 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getBurstPeriod ( ) const

Gets Burst Period parameter.

Returns: Value measured as a fraction of Burst Period

Definition at line 245 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

double QoSReq::getCostBits ( ) const

Gets Cost-bits parameter.

Returns: Value measured in $/bit

Definition at line 333 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

double QoSReq::getCostTime ( ) const

Gets Cost-time parameter.

Returns: Value measured in $/ms

Definition at line 341 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getDelay ( ) const

Gets Delay parameter.

Returns: Value measured in usecs

Definition at line 253 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getJitter ( ) const

Gets Jitter parameter.

Returns: Value measured in usecs

Definition at line 277 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getMaxAllowGap ( ) const

Gets Maximum Allowable Gap in SDUs parameter.

Returns: Gap value measured in number of SDUs

Definition at line 285 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getMaxSduSize ( ) const

Gets Maximum SDU Size parameter.

Returns: Value measured in bytes

Definition at line 293 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

double QoSReq::getPduDropProbability ( ) const

Gets PDU Dropping Probability parameter.

Returns: Value in range from 0.0 to 1.0 measured as a probability

Definition at line 472 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getPeakBandDuration ( ) const

Gets Peak Band Duration parameter.

Returns: Value measured in bits/sec

Definition at line 309 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getPeakSduBandDuration ( ) const

Gets Peak SDU Duration parameter.

Returns: Value measured in SDUs/sec

Definition at line 317 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

int QoSReq::getResiliencyFactor ( ) const

inline

Gets Resiliency Factor parameter.

Parameters

costBits A new value measured in $/bit

Definition at line 374 of file QoSReq.h.

Referenced by info().

double QoSReq::getUndetectedBitErr ( ) const

Gets Undetected Bit Error Rate parameter.

Returns: Value in range from 0.0 to 1.0 measured as a probability

Definition at line 325 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

std::string QoSReq::info ( ) const

Prints QoSReq information as string.

Returns: String of QoSReq textual representation

Definition at line 368 of file QoSReq.cc.

Referenced by Flow::infoQoS(), and operator<<().

bool QoSReq::isForceOrder ( ) const

Gets in-order delivery flag.

Returns: Boolean flag value

Definition at line 261 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

bool QoSReq::isIncompleteDelivery ( ) const

Gets incomplete delivery flag.

Returns: Boolean flag value

Definition at line 269 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

bool QoSReq::isPartialDelivery ( ) const

Gets partial delivery flag.

Returns: Boolean flag value

Definition at line 301 of file QoSReq.cc.

Referenced by compare(), ScoreComparer::countFeasibilityScore(), info(), and MinComparer::isFeasibility().

void QoSReq::setAvgBand ( int avgBand )

Sets Average Bandwidth parameter.

Parameters

avgBand A new value in bits/sec

Definition at line 225 of file QoSReq.cc.

void QoSReq::setAvgSduBand ( int avgSduBand )

Sets Average SDU Bandwidth parameter.

Parameters

avgSduBand A new value in SDUs/sec

Definition at line 233 of file QoSReq.cc.

void QoSReq::setBurstDuration ( int burstDuration )

Sets Burst Duration parameter.

Parameters

burstDuration A new value in usecs

Definition at line 241 of file QoSReq.cc.

void QoSReq::setBurstPeriod ( int burstPeriod )

Sets Burst Period parameter.

Parameters

burstPeriod A new value measured as a fraction of Burst Period

Definition at line 249 of file QoSReq.cc.

void QoSReq::setCostBits ( double costBits )

Sets Cost-bits parameter.

Parameters

costBits A new value measured in $/bit

Definition at line 337 of file QoSReq.cc.

void QoSReq::setCostTime ( double costTime )

Sets Cost-time parameter.

Parameters

costTime A new value measured in $/ms

Definition at line 345 of file QoSReq.cc.

void QoSReq::setDelay ( int delay )

Sets Delay parameter.

Parameters

delay A new value measured in usecs

Definition at line 257 of file QoSReq.cc.

void QoSReq::setForceOrder ( bool forceOrder )

Sets in-order delivery flag.

Parameters

forceOrder A new in-order delivery flag value

Definition at line 265 of file QoSReq.cc.

void QoSReq::setIncompleteDelivery ( bool incompleteDeliv )

Sets incomplete delivery flag.

Parameters

incompleteDeliv A new incomplete delivery flag value

Definition at line 273 of file QoSReq.cc.

void QoSReq::setJitter ( int jitter )

Sets Jitter parameter.

Parameters

jitter A new value measured in usecs

Definition at line 281 of file QoSReq.cc.

void QoSReq::setMaxAllowGap ( int maxAllowGap )

Sets Maximum Allowable Gap in SDUs parameter.

Parameters

maxAllowGap A new gap value measured in number of SDUs

Definition at line 289 of file QoSReq.cc.

void QoSReq::setMaxSduSize ( int maxSdUsize )

Sets Maximum SDU Size parameter.

Parameters

maxSdUsize A new value measured in bytes

Definition at line 297 of file QoSReq.cc.

void QoSReq::setPartialDelivery ( bool partDeliv )

Sets partial delivery flag.

Parameters

partDeliv A new partial delivery flag value

Definition at line 305 of file QoSReq.cc.

void QoSReq::setPduDropProbability ( double pduDropProbability )

Sets PDU Dropping Probability parameter.

Parameters

pduDropProbability A new value in range from 0.0 to 1.0 measured as a probability

Definition at line 476 of file QoSReq.cc.

void QoSReq::setPeakBandDuration ( int peakBandDuration )

Sets Peak Band Duration parameter.

Parameters

peakBandDuration A new value measured in bits/sec

Definition at line 313 of file QoSReq.cc.

void QoSReq::setPeakSduBandDuration ( int peakSduBandDuration )

Sets Peak SDU Duration parameter.

Parameters

peakSduBandDuration A new value measured in SDUs/sec

Definition at line 321 of file QoSReq.cc.

void QoSReq::setResiliencyFactor ( int resiliencyFactor )

inline

Sets Resiliency Factor parameter.

Parameters

resiliencyFactor A new value measured in $/bit

Definition at line 382 of file QoSReq.h.

void QoSReq::setUndetectedBitErr ( double undetectedBitErr )

Sets Undetected Bit Error Rate parameter.

Parameters

undetectedBitErr A new value in range from 0.0 to 1.0 measured as a probability

Definition at line 329 of file QoSReq.cc.

Member Data Documentation

int QoSReq::avgBand

protected

Attribute holding average bandwidth.

Definition at line 51 of file QoSReq.h.

Referenced by compare(), getAvgBand(), QoSReq(), setAvgBand(), and ~QoSReq().

int QoSReq::avgSDUBand

protected

Attribute holding average SDU bandwidth.

Definition at line 56 of file QoSReq.h.

Referenced by compare(), getAvgSduBand(), QoSReq(), setAvgSduBand(), and ~QoSReq().

int QoSReq::burstDuration

protected

Attribute holding burst durating as usec fraction of burst period.

Definition at line 76 of file QoSReq.h.

Referenced by compare(), getBurstDuration(), QoSReq(), setBurstDuration(), and ~QoSReq().

int QoSReq::burstPeriod

protected

Attribute holding burst period in usecs.

Definition at line 71 of file QoSReq.h.

Referenced by compare(), getBurstPeriod(), QoSReq(), setBurstPeriod(), and ~QoSReq().

int QoSReq::costBits

protected

Attribute holding connection's transmission size price.

Definition at line 131 of file QoSReq.h.

Referenced by compare(), getCostBits(), QoSReq(), setCostBits(), and ~QoSReq().

int QoSReq::costTime

protected

Attribute holding connection's time price.

Definition at line 126 of file QoSReq.h.

Referenced by compare(), getCostTime(), QoSReq(), setCostTime(), and ~QoSReq().

int QoSReq::delay

protected

Attribute holding accepted delay.

Definition at line 116 of file QoSReq.h.

Referenced by compare(), getDelay(), QoSReq(), setDelay(), and ~QoSReq().

bool QoSReq::forceOrder

protected

Attribute holding in-order delivery flag.

Definition at line 106 of file QoSReq.h.

Referenced by compare(), isForceOrder(), QoSReq(), setForceOrder(), and ~QoSReq().

bool QoSReq::incompleteDeliv

protected

Attribute holding incomplete delivery flag.

Definition at line 101 of file QoSReq.h.

Referenced by compare(), isIncompleteDelivery(), QoSReq(), setIncompleteDelivery(), and ~QoSReq().

int QoSReq::jitter

protected

Attribute holding accepted jitter.

Definition at line 121 of file QoSReq.h.

Referenced by compare(), getJitter(), QoSReq(), setJitter(), and ~QoSReq().

const QoSReq QoSReq::MANAGEMENT

static

Definition at line 152 of file QoSReq.h.

Referenced by DAFEnrollment::createFlow(), Flow::dupToMgmt(), RA::initQoSCubes(), Flow::isManagementFlow(), DAFEnrollment::receiveAllocationRequestFromFAI(), FA::receiveMgmtAllocateRequest(), LisDAFEnrollmentAllResPosi::receiveSignal(), and LisDAFEnrollmentAllReqFromFai::receiveSignal().

int QoSReq::maxAllowGap

protected

Attribute holding maximum allowd gap in SDUs.

Definition at line 111 of file QoSReq.h.

Referenced by compare(), getMaxAllowGap(), QoSReq(), setMaxAllowGap(), and ~QoSReq().

int QoSReq::maxSDUsize

protected

Attribute holding maximum SDU size.

Definition at line 91 of file QoSReq.h.

Referenced by compare(), getMaxSduSize(), QoSReq(), setMaxSduSize(), and ~QoSReq().

bool QoSReq::partDeliv

protected

Attribute holding partial delivery flag.

Definition at line 96 of file QoSReq.h.

Referenced by compare(), isPartialDelivery(), QoSReq(), setPartialDelivery(), and ~QoSReq().

double QoSReq::pduDropProbability

protected

Attribute holding probability of dropping PDUs.

Definition at line 86 of file QoSReq.h.

Referenced by compare(), getPduDropProbability(), QoSReq(), and setPduDropProbability().

int QoSReq::peakBandDuration

protected

Attribute holding peak bandwidth duration.

Definition at line 61 of file QoSReq.h.

Referenced by compare(), getPeakBandDuration(), QoSReq(), setPeakBandDuration(), and ~QoSReq().

int QoSReq::peakSDUBandDuration

protected

Attribute holding peak SDU bandwidth duration.

Definition at line 66 of file QoSReq.h.

Referenced by getPeakSduBandDuration(), QoSReq(), setPeakSduBandDuration(), and ~QoSReq().

int QoSReq::resiliencyFactor

protected

Attribute holding resiliency information, see PRISTINE D4.3 for more.

Definition at line 136 of file QoSReq.h.

Referenced by getResiliencyFactor(), and setResiliencyFactor().

double QoSReq::undetectedBitErr

protected

Attribute holding probability of undetected bit error rate.

Definition at line 81 of file QoSReq.h.

Referenced by compare(), getUndetectedBitErr(), QoSReq(), setUndetectedBitErr(), and ~QoSReq().

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

src/Common/QoSReq.h
src/Common/QoSReq.cc

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation