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

Classes
class	woss::Sediment
	Surficial sediment geoacoustic parameters definitions. More...

class	woss::SedimentGravel
	Gravel type implementation. More...

class	woss::SedimentSand
	Sand type implementation. More...

class	woss::SedimentSilt
	Silt type implementation. More...

class	woss::SedimentClay
	Clay type implementation. More...

class	woss::SedimentOoze
	Ooze type implementation. More...

class	woss::SedimentMud
	Mud type implementation. More...

class	woss::SedimentRocks
	Rocks type implementation. More...

class	woss::SedimentOrganic
	Organic type implementation. More...

class	woss::SedimentNodules
	Deck41 nodules type implementation. More...

class	woss::SedimentHardBottom
	Hard bottom type implementation. More...

Typedefs
typedef ::std::pair< int, int >	woss::Deck41Types

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Definitions and library for woss::Sediment class.

Author: Federico Guerra

Definitions and library for surficial sediment

Function Documentation

◆ operator!=()

bool woss::operator!=	(	const Sediment &	left,
		const Sediment &	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 Sediment woss::operator*	(	const double	left,
		const Sediment &	right
	)

Scalar multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator*(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator*() [2/3]

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

Scalar multiplication operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator*(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator*() [3/3]

const Sediment woss::operator*	(	const Sediment &	left,
		const Sediment &	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]

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

Compound assignment multiplication operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator*=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator*=() [2/2]

Sediment & woss::operator*=	(	Sediment &	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::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator*=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator+()

const Sediment woss::operator+	(	const Sediment &	left,
		const Sediment &	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+=() [1/2]

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

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator+=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator+=() [2/2]

Sediment & woss::operator+=	(	Sediment &	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::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator+=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator-()

const Sediment woss::operator-	(	const Sediment &	left,
		const Sediment &	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]

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

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator-=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator-=() [2/2]

Sediment & woss::operator-=	(	Sediment &	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::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator-=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator/() [1/3]

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

Scalar division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator/(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator/() [2/3]

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

Scalar division operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator/(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator/() [3/3]

const Sediment woss::operator/	(	const Sediment &	left,
		const Sediment &	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]

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

Compound assignment division operator

Parameters

left	left operand reference
right	right operand const reference

Returns: left reference after the operation

References woss::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator/=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator/=() [2/2]

Sediment & woss::operator/=	(	Sediment &	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::Sediment::att_c, woss::Sediment::att_s, woss::Sediment::density, woss::operator/=(), woss::Sediment::type, woss::Sediment::vel_c, and woss::Sediment::vel_s.

Here is the call graph for this function:

◆ operator==()

bool woss::operator==	(	const Sediment &	left,
		const Sediment &	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

Function Documentation

◆ operator!=()

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-()

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/3]

◆ operator/() [2/3]

◆ operator/() [3/3]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator==()