Definitions and library for Sound Speed Profiles. More...

Classes
class	woss::SSP
	SSP class offers multiple creation and manipulation capabilities for sound speed profile. More...

Typedefs
typedef ::std::map< PDouble, double >	woss::DepthMap

typedef DepthMap::const_iterator	woss::DConstIter

typedef DepthMap::iterator	woss::DIter

typedef DepthMap::reverse_iterator	woss::DRIter

typedef DepthMap::const_reverse_iterator	woss::DConstRIter

Functions
SSP &	woss::operator+= (SSP &left, const SSP &right)

SSP &	woss::operator-= (SSP &left, const SSP &right)

SSP &	woss::operator*= (SSP &left, const SSP &right)

SSP &	woss::operator/= (SSP &left, const SSP &right)

SSP &	woss::operator+= (SSP &left, const double right)

SSP &	woss::operator-= (SSP &left, const double right)

SSP &	woss::operator/= (SSP &left, const double right)

SSP &	woss::operator*= (SSP &left, const double right)

bool	woss::operator== (const SSP &left, const SSP &right)

bool	woss::operator!= (const SSP &left, const SSP &right)

const SSP	woss::operator+ (const SSP &left, const SSP &right)

const SSP	woss::operator- (const SSP &left, const SSP &right)

const SSP	woss::operator* (const SSP &left, const SSP &right)

const SSP	woss::operator/ (const SSP &left, const SSP &right)

const SSP	woss::operator+ (const SSP &left, const double right)

const SSP	woss::operator- (const SSP &left, const double right)

const SSP	woss::operator/ (const SSP &left, const double right)

const SSP	woss::operator* (const SSP &left, const double right)

const SSP	woss::operator+ (const double left, const SSP &right)

const SSP	woss::operator- (const double left, const SSP &right)

const SSP	woss::operator/ (const double left, const SSP &right)

const SSP	woss::operator* (const double left, const SSP &right)

inline ::std::ostream &	woss::operator<< (::std::ostream &os, const SSP &instance)

inline ::std::istream &	woss::operator>> (::std::istream &is, SSP &instance)

Detailed Description

Definitions and library for Sound Speed Profiles.

Author: Federico Guerra

Definitions and library for woss::SSP (Sound Speed profile) class

Typedef Documentation

◆ DepthMap

typedef ::std::map< PDouble, double > woss::DepthMap

Multipurpose map that links a depth [m] to a value ( temperature [C°], pressure [bar], salinity [ppu], or sound speed profile [m/s] )

Function Documentation

◆ operator!=()

bool woss::operator!=	(	const SSP &	left,
		const SSP &	right
	)

inline

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

◆ operator*() [1/3]

const SSP woss::operator*	(	const double	left,
		const SSP &	right
	)

inline

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator*() [2/3]

const SSP woss::operator*	(	const SSP &	left,
		const double	right
	)

inline

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator*() [3/3]

const SSP woss::operator*	(	const SSP &	left,
		const SSP &	right
	)

inline

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator*=() [1/2]

SSP & woss::operator*=	(	SSP &	left,
		const double	right
	)

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator*=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator*=() [2/2]

SSP & woss::operator*=	(	SSP &	left,
		const SSP &	right
	)

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator*=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator+() [1/3]

const SSP woss::operator+	(	const double	left,
		const SSP &	right
	)

inline

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+() [2/3]

const SSP woss::operator+	(	const SSP &	left,
		const double	right
	)

inline

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+() [3/3]

const SSP woss::operator+	(	const SSP &	left,
		const SSP &	right
	)

inline

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a const instance holding the operation result

◆ operator+=() [1/2]

SSP & woss::operator+=	(	SSP &	left,
		const double	right
	)

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator+=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator+=() [2/2]

SSP & woss::operator+=	(	SSP &	left,
		const SSP &	right
	)

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator+=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator-() [1/3]

const SSP woss::operator-	(	const double	left,
		const SSP &	right
	)

inline

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-() [2/3]

const SSP woss::operator-	(	const SSP &	left,
		const double	right
	)

inline

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-() [3/3]

const SSP woss::operator-	(	const SSP &	left,
		const SSP &	right
	)

inline

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-=() [1/2]

SSP & woss::operator-=	(	SSP &	left,
		const double	right
	)

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator-=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator-=() [2/2]

SSP & woss::operator-=	(	SSP &	left,
		const SSP &	right
	)

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator-=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator/() [1/3]

const SSP woss::operator/	(	const double	left,
		const SSP &	right
	)

inline

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/() [2/3]

const SSP woss::operator/	(	const SSP &	left,
		const double	right
	)

inline

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/() [3/3]

const SSP woss::operator/	(	const SSP &	left,
		const SSP &	right
	)

inline

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator/=() [1/2]

SSP & woss::operator/=	(	SSP &	left,
		const double	right
	)

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator/=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator/=() [2/2]

SSP & woss::operator/=	(	SSP &	left,
		const SSP &	right
	)

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::operator/=(), woss::SSP::pressure_map, woss::SSP::salinity_map, woss::SSP::ssp_map, and woss::SSP::temperature_map.

Here is the call graph for this function:

◆ operator==()

bool woss::operator==	(	const SSP &	left,
		const SSP &	right
	)

inline

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ DepthMap

Function Documentation

◆ operator!=()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/3]

◆ operator-() [2/3]

◆ operator-() [3/3]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator==()