#include <uwgainfromdb.h>

Inheritance diagram for UnderwaterGainFromDb:

[legend]

Collaboration diagram for UnderwaterGainFromDb:

[legend]

Public Member Functions
	UnderwaterGainFromDb ()

virtual	~UnderwaterGainFromDb ()

virtual int	command (int, const char const )

Public Member Functions inherited from UnderwaterPhysical
	UnderwaterPhysical ()

virtual	~UnderwaterPhysical ()

virtual void	recv (Packet *) override

int	recvSyncClMsg (ClMessage *m) override

Protected Member Functions
virtual double	getPER (double snr, int nbits, Packet *p)

virtual void	setTimeRoughness (const int &)

virtual void	setDepthRoughness (const int &)

virtual void	setDistanceRoughness (const int &)

virtual void	setTotalTime (const int &)

virtual void	setFrequencyCorrectionFactor (const double &)

const int &	getTimeRoughness () const

const int &	getDepthRoughness () const

const int &	getDistanceRoughness () const

const int &	getTotalTime () const

const double &	getFrequencyCorrectionFactor () const

virtual double	getGain (const double &, const double &, const double &, const double &)

virtual double	retriveGainFromFile (const string &, const int &, const int &) const

virtual string	createNameFile (const int &, const int &)

const bool	isZero (const double &value) const

Protected Member Functions inherited from UnderwaterPhysical
virtual void	updateInstantaneousStats ()

virtual void	endTx (Packet *p) override

virtual void	endRx (Packet *p) override

virtual void	startRx (Packet *p) override

virtual double	consumedEnergyTx (const double &_duration) const

virtual double	consumedEnergyRx (const double &_duration) const

bool	isZero (const double &value) const

double	Get_Tx_Time () const

double	Get_Rx_Time () const

double	Get_Energy_Tx () const

double	Get_Energy_Rx () const

double	Get_Transmitted_bytes () const

void	incrTot_pkts_lost ()

void	incrTotCrtl_pkts_lost ()

void	incrErrorCtrlPktsInterf ()

void	incrCollisionDATAvsCTRL ()

void	incrCollisionCTRL ()

void	incrCollisionDATA ()

int	getTot_pkts_lost () const

int	getTot_CtrlPkts_lost () const

int	getError_CtrlPktsInterf () const

int	getCollisionsDATAvsCTRL () const

int	getCollisionsCTRL () const

int	getCollisionsDATA () const

double	log2 (const double &_input) const

double	get_prob_error_symbol_mpsk (const double &_snr, const uint32_t _M) const

Protected Attributes
char *	path_

char	token_separator_

ostringstream	osstream_

Protected Attributes inherited from UnderwaterPhysical
std::string	modulation_name_

double	time_ready_to_end_rx_

double	Tx_Time_

double	Rx_Time_

double	Energy_Tx_

double	Energy_Rx_

double	Transmitted_bytes_

double	tx_power_

double	rx_power_

int	tot_pkts_lost

int	tot_ctrl_pkts_lost

int	errorCtrlPktsInterf

int	collisionDataCTRL

int	collisionCTRL

int	collisionDATA

std::string	Interference_Model

uwinterference *	interference_

Private Attributes
int	time_roughness_

int	depth_roughness_

int	distance_roughness_

int	total_time_

double	frequency_correction_factor_

Detailed Description

Definition at line 51 of file uwgainfromdb.h.

Constructor & Destructor Documentation

◆ UnderwaterGainFromDb()

UnderwaterGainFromDb::UnderwaterGainFromDb ( )

Constructor of UnderwaterMPhyBpskDb class.

Definition at line 59 of file uwgainfromdb.cpp.

◆ ~UnderwaterGainFromDb()

virtual UnderwaterGainFromDb::~UnderwaterGainFromDb ( )

inlinevirtual

Destructor of UnderwaterMPhyBpskDb class.

Definition at line 63 of file uwgainfromdb.h.

Member Function Documentation

◆ command()

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

virtual

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 UnderwaterPhysical.

Reimplemented in UnderwaterPhysicalfromdb.

Definition at line 77 of file uwgainfromdb.cpp.

◆ createNameFile()

string UnderwaterGainFromDb::createNameFile	(	const int &	_time,
		const int &	_source_depth
	)

protectedvirtual

Creates the name of the file to load.

Parameters

time
depth

Returns: The name of the file to load.

Definition at line 246 of file uwgainfromdb.cpp.

◆ getDepthRoughness()

const int & UnderwaterGainFromDb::getDepthRoughness ( ) const

inlineprotected

Returns the depth_roughness_ parameter.

Returns: depth_roughness_

Definition at line 145 of file uwgainfromdb.h.

◆ getDistanceRoughness()

const int & UnderwaterGainFromDb::getDistanceRoughness ( ) const

inlineprotected

Returns the distance_roughness_ parameter.

Returns: distance_roughness_

Definition at line 156 of file uwgainfromdb.h.

◆ getFrequencyCorrectionFactor()

const double & UnderwaterGainFromDb::getFrequencyCorrectionFactor ( ) const

inlineprotected

Returns the frequency_correction_factor_ parameter.

Returns: frequency_correction_factor_

Definition at line 178 of file uwgainfromdb.h.

◆ getGain()

double UnderwaterGainFromDb::getGain	(	const double &	_time,
		const double &	_source_depth,
		const double &	_destination_depth,
		const double &	_destination_distance
	)

protectedvirtual

Parameters

param

Parameters

param

Returns

Reimplemented in UnderwaterPhysicalfromdb.

Definition at line 166 of file uwgainfromdb.cpp.

◆ getPER()

double UnderwaterGainFromDb::getPER	(	double	snr,
		int	nbits,
		Packet *	p
	)

protectedvirtual

Returns the packet error rate by using the length of a packet and the information contained in the packet (position of the source and the destiantion.

Parameters

snr	Calculated by nsmiracle with the Urick model (unused).
nbits	length in bit of the packet.
p	Packet by witch the module gets information about source and destination.

Returns: PER of the packet passed as parameter.

Reimplemented from UnderwaterPhysical.

Reimplemented in UnderwaterPhysicalfromdb.

Definition at line 95 of file uwgainfromdb.cpp.

◆ getTimeRoughness()

const int & UnderwaterGainFromDb::getTimeRoughness ( ) const

inlineprotected

Returns the time_roughness_ parameter.

Returns: time_roughness_

Definition at line 134 of file uwgainfromdb.h.

◆ getTotalTime()

const int & UnderwaterGainFromDb::getTotalTime ( ) const

inlineprotected

Returns the total_time_ parameter.

Returns: total_time_

Definition at line 167 of file uwgainfromdb.h.

◆ isZero()

const bool UnderwaterGainFromDb::isZero ( const double & value ) const

inlineprotected

Evaluates is the number passed as input is equal to zero.

When C++ works with double and float number you can't compare them with 0. If the absolute value of the number is smaller than eplison that means that the number is equal to zero.

Parameters

double& Number to evaluate.

Returns: true if the number passed in input is equal to zero, false otherwise.

See also: std::numeric_limits<double>::epsilon()

Definition at line 226 of file uwgainfromdb.h.

◆ retriveGainFromFile()

double UnderwaterGainFromDb::retriveGainFromFile	(	const string &	_file_name,
		const int &	_row_index,
		const int &	_column_index
	)		const

protectedvirtual

Parameters

param

Parameters

return

Definition at line 194 of file uwgainfromdb.cpp.

◆ setDepthRoughness()

void UnderwaterGainFromDb::setDepthRoughness ( const int & _depth )

protectedvirtual

Sets the depth_roughness_ parameter.

Parameters

Roughness of the depth samples.

Definition at line 133 of file uwgainfromdb.cpp.

◆ setDistanceRoughness()

void UnderwaterGainFromDb::setDistanceRoughness ( const int & _distance )

protectedvirtual

Sets the distance_roughness_ parameter.

Parameters

Roughness of the distance samples.

Definition at line 141 of file uwgainfromdb.cpp.

◆ setFrequencyCorrectionFactor()

void UnderwaterGainFromDb::setFrequencyCorrectionFactor ( const double & _frequency_correction_factor )

protectedvirtual

Sets the frequency_correction_factor_ parameter.

Parameters

Frequency correction factor.

Definition at line 157 of file uwgainfromdb.cpp.

◆ setTimeRoughness()

void UnderwaterGainFromDb::setTimeRoughness ( const int & _time )

protectedvirtual

Sets the time_roughness_ parameter.

Parameters

Roughness of the temporal samples.

Definition at line 125 of file uwgainfromdb.cpp.

◆ setTotalTime()

void UnderwaterGainFromDb::setTotalTime ( const int & _total_time )

protectedvirtual

Sets the total_time_ parameter.

Parameters

Maximum value of the temporal samples.

Definition at line 149 of file uwgainfromdb.cpp.

Member Data Documentation

◆ depth_roughness_

int UnderwaterGainFromDb::depth_roughness_

private

Roughness of the depth samples.

Definition at line 239 of file uwgainfromdb.h.

◆ distance_roughness_

int UnderwaterGainFromDb::distance_roughness_

private

Roughness of the distance samples.

Definition at line 240 of file uwgainfromdb.h.

◆ frequency_correction_factor_

double UnderwaterGainFromDb::frequency_correction_factor_

private

used to shift from a frequency value to another one.

Definition at line 243 of file uwgainfromdb.h.

◆ osstream_

ostringstream UnderwaterGainFromDb::osstream_

protected

Used to create strings.

Definition at line 234 of file uwgainfromdb.h.

◆ path_

char* UnderwaterGainFromDb::path_

protected

Name of the trace file writter for the current node.

Definition at line 231 of file uwgainfromdb.h.

◆ time_roughness_

int UnderwaterGainFromDb::time_roughness_

private

Roughness of the temporal samples.

Definition at line 238 of file uwgainfromdb.h.

◆ token_separator_

char UnderwaterGainFromDb::token_separator_

protected

Token used to parse the elements in a line of the database.

Definition at line 232 of file uwgainfromdb.h.

◆ total_time_

int UnderwaterGainFromDb::total_time_

private

Maximum value of the temporal samples, after this limit the smilulation time will be reset to zero.

Definition at line 241 of file uwgainfromdb.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UnderwaterGainFromDb()

◆ ~UnderwaterGainFromDb()

Member Function Documentation

◆ command()

◆ createNameFile()

◆ getDepthRoughness()

◆ getDistanceRoughness()

◆ getFrequencyCorrectionFactor()

◆ getGain()

◆ getPER()

◆ getTimeRoughness()

◆ getTotalTime()

◆ isZero()

◆ retriveGainFromFile()

◆ setDepthRoughness()

◆ setDistanceRoughness()

◆ setFrequencyCorrectionFactor()

◆ setTimeRoughness()

◆ setTotalTime()

Member Data Documentation

◆ depth_roughness_

◆ distance_roughness_

◆ frequency_correction_factor_

◆ osstream_

◆ path_

◆ time_roughness_

◆ token_separator_

◆ total_time_