altimetry-definitions.h File Reference

Definitions and library for woss::Altimetry class. More...

Go to the source code of this file.

Classes
class	woss::Altimetry
	Altimetry profile class. More...
class	woss::AltimBretschneider
	AltimBretschneider supports Bretschneider wave model. More...

Typedefs
typedef std::map< PDouble, double >	woss::AltimetryMap
typedef AltimetryMap::iterator	woss::AltIt
typedef AltimetryMap::const_iterator	woss::AltCIt
typedef AltimetryMap::reverse_iterator	woss::AltRIt
typedef AltimetryMap::const_reverse_iterator	woss::AltCRIt

Functions
const Altimetry	woss::operator+ (const Altimetry &left, const Altimetry &right)
const Altimetry	woss::operator- (const Altimetry &left, const Altimetry &right)
const Altimetry	woss::operator+ (const Altimetry &left, const double right)
const Altimetry	woss::operator- (const Altimetry &left, const double right)
const Altimetry	woss::operator/ (const Altimetry &left, const double right)
const Altimetry	woss::operator* (const Altimetry &left, const double right)
const Altimetry	woss::operator+ (const double left, const Altimetry &right)
const Altimetry	woss::operator- (const double left, const Altimetry &right)
const Altimetry	woss::operator/ (const double left, const Altimetry &right)
const Altimetry	woss::operator* (const double left, const Altimetry &right)
Altimetry &	woss::operator+= (Altimetry &left, const Altimetry &right)
Altimetry &	woss::operator-= (Altimetry &left, const Altimetry &right)
Altimetry &	woss::operator+= (Altimetry &left, double right)
Altimetry &	woss::operator-= (Altimetry &left, double right)
Altimetry &	woss::operator/= (Altimetry &left, double right)
Altimetry &	woss::operator*= (Altimetry &left, double right)
std::ostream &	woss::operator<< (std::ostream &os, const Altimetry &instance)
bool	woss::operator== (const Altimetry &left, const Altimetry &right)
bool	woss::operator!= (const Altimetry &left, const Altimetry &right)

Detailed Description

Definitions and library for woss::Altimetry class.

Author

Federico Guerra

Definitions and library for woss::Altimetry class

Typedef Documentation

AltimetryMap

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

Map that links a PDouble range [m] to a double altimetry value. Negative values ==> under water. Positive values ==> above water.

Function Documentation

operator!=()

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

inline

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

true if left != right, false otherwise

operator*() [1/2]

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

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator*().

Referenced by woss::operator*(), woss::operator*(), woss::operator*(), woss::operator*(), woss::operator*(), and woss::operator*().

Here is the call graph for this function:

operator*() [2/2]

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

Multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator*().

Here is the call graph for this function:

operator*=()

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

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator*=().

Referenced by woss::operator*=(), woss::operator*=(), woss::operator*=(), woss::operator*=(), woss::operator*=(), and woss::operator*=().

Here is the call graph for this function:

operator+() [1/3]

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

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator+().

Referenced by woss::operator+(), woss::operator+(), woss::operator+(), woss::operator+(), woss::operator+(), and woss::operator+().

Here is the call graph for this function:

operator+() [2/3]

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

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator+().

Here is the call graph for this function:

operator+() [3/3]

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

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator+().

Here is the call graph for this function:

operator+=() [1/2]

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

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator+=().

Referenced by woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), woss::operator+=(), and woss::operator+=().

Here is the call graph for this function:

operator+=() [2/2]

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

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator+=().

Here is the call graph for this function:

operator-() [1/3]

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

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator-().

Referenced by woss::operator-(), woss::operator-(), woss::operator-(), woss::operator-(), woss::operator-(), woss::operator-(), and woss::operator-().

Here is the call graph for this function:

operator-() [2/3]

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

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator-().

Here is the call graph for this function:

operator-() [3/3]

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

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator-().

Here is the call graph for this function:

operator-=() [1/2]

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

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator-=().

Referenced by woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), woss::operator-=(), and woss::operator-=().

Here is the call graph for this function:

operator-=() [2/2]

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

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator-=().

Here is the call graph for this function:

operator/() [1/2]

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

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator/().

Referenced by woss::operator/(), woss::operator/(), woss::operator/(), woss::operator/(), woss::operator/(), and woss::operator/().

Here is the call graph for this function:

operator/() [2/2]

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

Division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

a new const instance holding the operation result

References woss::operator/().

Here is the call graph for this function:

operator/=()

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

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns

left reference after the operation

References woss::Altimetry::altimetry_map, and woss::operator/=().

Referenced by woss::operator/=(), woss::operator/=(), woss::operator/=(), woss::operator/=(), woss::operator/=(), and woss::operator/=().

Here is the call graph for this function:

operator<<()

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

inline

<< operator

Parameters

os	left operand ostream reference
instance	right operand const Pressure reference

Returns

os reference after the operation

operator==()

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

inline

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns

true if left == right, false otherwise