#include <uwrovctr-module.h>

Inheritance diagram for UwROVCtrModule:

[legend]

Collaboration diagram for UwROVCtrModule:

[legend]

Public Member Functions
	UwROVCtrModule ()

	UwROVCtrModule (Position p)

virtual	~UwROVCtrModule ()

virtual int	command (int argc, const char const argv)

virtual void	initPkt (Packet *p)

void	reset_retx ()

virtual void	setPosition (Position p)

Position	getPosition ()

Position	getMonitoredROVPosition ()

virtual void	recv (Packet *)

virtual void	recv (Packet p, Handler h)

virtual void	transmit ()

virtual void	start ()

Public Member Functions inherited from UwCbrModule
	UwCbrModule ()

virtual	~UwCbrModule ()

virtual int	crLayCommand (ClMessage *m)

virtual double	GetRTT () const

virtual double	GetFTT () const

virtual double	GetTxTime () const

virtual double	GetPER () const

virtual double	GetTHR () const

virtual double	GetRTTstd () const

virtual double	GetFTTstd () const

virtual void	resetStats ()

void	printIdsPkts () const

Static Public Member Functions
static int	getROVMonHeaderSize ()

static int	getROVCTRHeaderSize ()

Protected Attributes
Position	posit

float	x_rov

float	y_rov

float	z_rov

float	newX

float	newY

float	newZ

float	speed

int	sn

Packet *	p

int	adaptiveRTO

double	adaptiveRTO_parameter

Protected Attributes inherited from UwCbrModule
uint16_t	dstPort_

std::string	log_suffix

nsaddr_t	dstAddr_

char	priority_

std::ofstream	tracefile

std::string	tracefilename

bool *	sn_check

int	PoissonTraffic_

int	debug_

int	drop_out_of_order_

uint	traffic_type_

UwSendTimer	sendTmr_

int	txsn

int	hrsn

int	pkts_recv

int	pkts_ooseq

int	pkts_lost

int	pkts_invalid

int	pkts_last_reset

int	cnt

double	rftt

double	srtt

double	sftt

double	lrtime

double	sthr

double	period_

int	pktSize_

double	sumrtt

double	sumrtt2

int	rttsamples

double	sumftt

double	sumftt2

int	fttsamples

double	sumtxtimes = 0

double	sumbytes

double	sumdt

uint32_t	esn

int	tracefile_enabler_

Additional Inherited Members
Protected Member Functions inherited from UwCbrModule
virtual void	sendPkt ()

virtual void	sendPktLowPriority ()

virtual void	sendPktHighPriority ()

virtual void	stop ()

virtual void	updateRTT (const double &)

virtual void	updateFTT (const double &)

virtual void	updateThroughput (const int &, const double &)

virtual void	incrPktLost (const int &)

virtual void	incrPktRecv ()

virtual void	incrPktOoseq ()

virtual void	incrPktInvalid ()

virtual double	getTimeBeforeNextPkt ()

virtual void	printReceivedPacket (Packet *p)

Static Protected Member Functions inherited from UwCbrModule
static int	getCbrHeaderSize ()

Static Protected Attributes inherited from UwCbrModule
static int	uidcnt_ = 0

Detailed Description

UwROVCtrModule class is used to manage UWROVCtr packets and to collect statistics about them.

Definition at line 77 of file uwrovctr-module.h.

Constructor & Destructor Documentation

◆ UwROVCtrModule() [1/2]

UwROVCtrModule::UwROVCtrModule ( )

Constructor of UwROVCtrModule class.

Definition at line 93 of file uwrovctr-module.cc.

◆ UwROVCtrModule() [2/2]

UwROVCtrModule::UwROVCtrModule ( Position p )

Constructor of UwROVCtrModule class with position setting.

Definition at line 72 of file uwrovctr-module.cc.

◆ ~UwROVCtrModule()

UwROVCtrModule::~UwROVCtrModule ( )

virtual

Destructor of UwROVCtrModule class.

Definition at line 117 of file uwrovctr-module.cc.

Member Function Documentation

◆ command()

int UwROVCtrModule::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 UwCbrModule.

Reimplemented in UwSCROVCtrModule.

Definition at line 119 of file uwrovctr-module.cc.

◆ getMonitoredROVPosition()

Position UwROVCtrModule::getMonitoredROVPosition ( )

inline

Returns the last ROV position monitored.

Returns: the last ROV position monitored

Definition at line 136 of file uwrovctr-module.h.

◆ getPosition()

Position UwROVCtrModule::getPosition ( )

inline

Returns the position of the ROVCtr.

Returns: the current ROVCtr position

Definition at line 129 of file uwrovctr-module.h.

◆ getROVCTRHeaderSize()

static int UwROVCtrModule::getROVCTRHeaderSize ( )

inlinestatic

Returns the size in byte of a hdr_uwROV_ctr packet header.

Returns: The size of a hdr_uwROV_monitoring packet header.

Definition at line 183 of file uwrovctr-module.h.

◆ getROVMonHeaderSize()

static int UwROVCtrModule::getROVMonHeaderSize ( )

inlinestatic

Returns the size in byte of a hdr_uwROV_monitoring packet header.

Returns: The size of a hdr_uwROV_monitoring packet header.

Definition at line 176 of file uwrovctr-module.h.

◆ initPkt()

void UwROVCtrModule::initPkt ( Packet * p )

virtual

Initializes a control data packet passed as argument with the default values.

Parameters

Packet* Pointer to a packet already allocated to fill with the right values.

Reimplemented from UwCbrModule.

Definition at line 201 of file uwrovctr-module.cc.

◆ recv() [1/2]

void UwROVCtrModule::recv ( Packet * p )

virtual

Performs the reception of packets from upper and lower layers.

Parameters

Packet* Pointer to the packet will be received.

Reimplemented from UwCbrModule.

Reimplemented in UwSCROVCtrModule.

Definition at line 244 of file uwrovctr-module.cc.

◆ recv() [2/2]

void UwROVCtrModule::recv	(	Packet *	p,
		Handler *	h
	)

virtual

Performs the reception of packets from upper and lower layers.

Parameters

Packet*	Pointer to the packet will be received.
Handler*	Handler.

Reimplemented from UwCbrModule.

Definition at line 240 of file uwrovctr-module.cc.

◆ reset_retx()

void UwROVCtrModule::reset_retx ( )

inline

Reset retransmissions.

Definition at line 115 of file uwrovctr-module.h.

◆ setPosition()

void UwROVCtrModule::setPosition ( Position p )

virtual

Set the position of the ROVCtr.

Parameters

Position * p Pointer to the ROVCtr position

Definition at line 197 of file uwrovctr-module.cc.

◆ start()

void UwROVCtrModule::start ( )

virtual

Start the controller.

Reimplemented from UwCbrModule.

Definition at line 195 of file uwrovctr-module.cc.

◆ transmit()

void UwROVCtrModule::transmit ( )

virtual

Creates and transmits a packet.

See also: UwCbrModule::sendPkt()

Reimplemented from UwCbrModule.

Definition at line 181 of file uwrovctr-module.cc.

Member Data Documentation

◆ adaptiveRTO

int UwROVCtrModule::adaptiveRTO

protected

1 if an adaptive RTO is used, 0 if a constant RTO is used.

Definition at line 199 of file uwrovctr-module.h.

◆ adaptiveRTO_parameter

double UwROVCtrModule::adaptiveRTO_parameter

protected

Parameter for the adaptive RTO.

Definition at line 201 of file uwrovctr-module.h.

◆ newX

float UwROVCtrModule::newX

protected

X of the new position sent to the ROV.

Definition at line 193 of file uwrovctr-module.h.

◆ newY

float UwROVCtrModule::newY

protected

Y of the new position sent to the ROV.

Definition at line 194 of file uwrovctr-module.h.

◆ newZ

float UwROVCtrModule::newZ

protected

Z of the new position sent to the ROV.

Definition at line 195 of file uwrovctr-module.h.

◆ p

Packet* UwROVCtrModule::p

protected

Sequence number of the last control packet sent.

Definition at line 198 of file uwrovctr-module.h.

◆ posit

Position UwROVCtrModule::posit

protected

Controller position.

Definition at line 189 of file uwrovctr-module.h.

◆ sn

int UwROVCtrModule::sn

protected

Definition at line 197 of file uwrovctr-module.h.

◆ speed

float UwROVCtrModule::speed

protected

Moving speed sent to the ROV.

Definition at line 196 of file uwrovctr-module.h.

◆ x_rov

float UwROVCtrModule::x_rov

protected

X of the last ROV position monitored.

Definition at line 190 of file uwrovctr-module.h.

◆ y_rov

float UwROVCtrModule::y_rov

protected

Y of the last ROV position monitored.

Definition at line 191 of file uwrovctr-module.h.

◆ z_rov

float UwROVCtrModule::z_rov

protected

Z of the last ROV position monitored.

Definition at line 192 of file uwrovctr-module.h.

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UwROVCtrModule() [1/2]

◆ UwROVCtrModule() [2/2]

◆ ~UwROVCtrModule()

Member Function Documentation

◆ command()

◆ getMonitoredROVPosition()

◆ getPosition()

◆ getROVCTRHeaderSize()

◆ getROVMonHeaderSize()

◆ initPkt()

◆ recv() [1/2]

◆ recv() [2/2]

◆ reset_retx()

◆ setPosition()

◆ start()

◆ transmit()

Member Data Documentation

◆ adaptiveRTO

◆ adaptiveRTO_parameter

◆ newX

◆ newY

◆ newZ

◆ p

◆ posit

◆ sn

◆ speed

◆ x_rov

◆ y_rov

◆ z_rov