#include <mclinkextended.h>

Inheritance diagram for MCLinkExtended:

[legend]

Collaboration diagram for MCLinkExtended:

[legend]

Public Member Functions
	MCLinkExtended ()

	MCLinkExtended (double ber_good, double ber_medium, double ber_bad, double p_gb, double p_gm, double p_mg, double p_mb, double p_bg, double p_bm, double step_period, ChState ch_state=MCLink::GOOD)

virtual	~MCLinkExtended ()

virtual int	command (int, const char const ) override

virtual ChState	updateChState () override

virtual double	getBER () override

Public Member Functions inherited from MCLink
	MCLink ()

	MCLink (double ber_good, double ber_bad, double p_gb, double p_bg, double step_period, ChState ch_state=MCLink::GOOD)

virtual	~MCLink ()

ChState	getChState ()

Protected Member Functions
void	mul_matrix (double(&A)[3][3], const double(&B)[3][3])

void	pow_matrix (const double(&A)[3][3], int n, double(&R)[3][3])

Protected Attributes
double	ber_medium

double	p_gm

double	p_mg

double	p_mb

double	p_bm

double	P [3][3]

Protected Attributes inherited from MCLink
double	ber_good

double	ber_bad

double	p_gb

double	p_bg

double	last_update

double	step_period

ChState	ch_state

Additional Inherited Members
Public Types inherited from MCLink
enum	ChState { NOT_DEFINED = 0 , GOOD = 1 , MEDIUM = 2 , BAD = 3 }

Detailed Description

MCLinkExtended class stores and updates the probabilities and the channel state for UnderwaterHMMPhysicalExt.

Definition at line 48 of file mclinkextended.h.

Constructor & Destructor Documentation

◆ MCLinkExtended() [1/2]

MCLinkExtended::MCLinkExtended ( )

Default constructor of MCLinkExtended class.

Definition at line 92 of file mclinkextended.cpp.

◆ MCLinkExtended() [2/2]

MCLinkExtended::MCLinkExtended	(	double	ber_good,
		double	ber_medium,
		double	ber_bad,
		double	p_gb,
		double	p_gm,
		double	p_mg,
		double	p_mb,
		double	p_bg,
		double	p_bm,
		double	step_period,
		ChState	ch_state = `MCLink::GOOD`
	)

Constructor of MCLinkExtended class.

Parameters

ber_good	BER with channel in GOOD state
ber_medium	BER with channel in MEDIUM state
ber_bad	BER with channel in BAD state
p_gb	Probability of transition from GOOD to BAD in one step
p_gm	Probability of transition from GOOD to MEDIUM in one step
p_mg	Probability of transition from MEDIUM to GOOD in one step
p_mb	Probability of transition from MEDIUM to BAD in one step
p_bg	Probability of transition from BAD to GOOD in one step
p_bm	Probability of transition from BAD to MEDIUM in one step
step_period	period (s) for state transitions
ch_state	Optional initial channel state (default = GOOD) of type MCLink::{GOOD \| MEDIUM \| BAD}

Definition at line 104 of file mclinkextended.cpp.

◆ ~MCLinkExtended()

virtual MCLinkExtended::~MCLinkExtended ( )

inlinevirtual

Default destructor of MCLinkExtended class.

Definition at line 81 of file mclinkextended.h.

Member Function Documentation

◆ command()

int MCLinkExtended::command	(	int	argc,
		const char const	argv
	)

overridevirtual

TCL command interpreter.

It implements the following OTcl methods:

Parameters

argc	Number of arguments in argv.
argv	Array of strings which are the command parameters (Note that argv[0] is the name of the object).

Returns: TCL_OK or TCL_ERROR whether the command has been dispatched successfully or not.

Reimplemented from MCLink.

Definition at line 224 of file mclinkextended.cpp.

◆ getBER()

double MCLinkExtended::getBER ( )

overridevirtual

Returns: BER with current channel state

Reimplemented from MCLink.

Definition at line 211 of file mclinkextended.cpp.

◆ mul_matrix()

void MCLinkExtended::mul_matrix	(	double(&)	A[3][3],
		const double(&)	B[3][3]
	)

protected

Auxiliary function calculating the result of a 3x3 matrix multiplication; result is stored in first argument.

Parameters

A	the first factor of matrix multiplication
B	the second factor of matrix multiplication

Definition at line 125 of file mclinkextended.cpp.

◆ pow_matrix()

void MCLinkExtended::pow_matrix	(	const double(&)	A[3][3],
		int	n,
		double(&)	R[3][3]
	)

protected

Auxiliary function raising a 3x3 matrix to the power of n.

Parameters

A	the matrix to be elevated to the n-th power
n	the exponent of the operation
R	the matrix that stores the result of the operation

Definition at line 145 of file mclinkextended.cpp.

◆ updateChState()

MCLink::ChState MCLinkExtended::updateChState ( )

overridevirtual

Called upon packet reception, decides and returns the new channel state updates the members state and last_step.

Parameters

curr_step current step number at packet arrival

Returns: the channel state at curr_step as MCLink::{GOOD | MEDIUM | BAD}

Reimplemented from MCLink.

Definition at line 168 of file mclinkextended.cpp.

Member Data Documentation

◆ ber_medium

double MCLinkExtended::ber_medium

protected

BER with medium channel.

Definition at line 131 of file mclinkextended.h.

◆ P

double MCLinkExtended::P[3][3]

protected

Transition matrix for the channel.

Definition at line 136 of file mclinkextended.h.

◆ p_bm

double MCLinkExtended::p_bm

protected

Prob of transition from bad to medium channel.

Definition at line 135 of file mclinkextended.h.

◆ p_gm

double MCLinkExtended::p_gm

protected

Prob of transition from good to medium channel.

Definition at line 132 of file mclinkextended.h.

◆ p_mb

double MCLinkExtended::p_mb

protected

Prob of transition from medium to bad channel.

Definition at line 134 of file mclinkextended.h.

◆ p_mg

double MCLinkExtended::p_mg

protected

Prob of transition from medium to good channel.

Definition at line 133 of file mclinkextended.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MCLinkExtended() [1/2]

◆ MCLinkExtended() [2/2]

◆ ~MCLinkExtended()

Member Function Documentation

◆ command()

◆ getBER()

◆ mul_matrix()

◆ pow_matrix()

◆ updateChState()

Member Data Documentation

◆ ber_medium

◆ P

◆ p_bm

◆ p_gm

◆ p_mb

◆ p_mg