class that provides correctly initialized BellhopWoss objects More...

#include <bellhop-creator.h>

Inheritance diagram for woss::BellhopCreator:

Collaboration diagram for woss::BellhopCreator:

Public Types
typedef WossCreatorContainer< CustomAngles >	CCAngles

typedef WossCreatorContainer< CustomTransducer >	CCTransducer

typedef WossCreatorContainer< ::std::string >	CCString

Public Member Functions
	BellhopCreator ()

virtual BellhopWoss *const	createWoss (const CoordZ &tx, const CoordZ &rx, double start_frequency, double end_frequency) const

BellhopCreator &	setThorpeAttFlag (bool flag)

bool	getThorpeAttFlag ()

BellhopCreator &	setTotalRangeSteps (int steps, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setTotalRangeSteps (int steps, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseTotalRangeSteps (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseTotalRangeSteps (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

double	getTotalRangeSteps (const CoordZ &tx, const CoordZ &rx)

double	getTotalRangeSteps (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setTxMinDepthOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setTxMinDepthOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseTxMinDepthOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseTxMinDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getTxMinDepthOffset (const CoordZ &tx, const CoordZ &rx)

double	getTxMinDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setTxMaxDepthOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setTxMaxDepthOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseTxMaxDepthOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseTxMaxDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getTxMaxDepthOffset (const CoordZ &tx, const CoordZ &rx)

double	getTxMaxDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setTotalTransmitters (int sources, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setTotalTransmitters (int sources, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseTotalTransmitters (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseTotalTransmitters (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getTotalTransmitters (const CoordZ &tx, const CoordZ &rx)

int	getTotalTransmitters (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setRxMinDepthOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxMinDepthOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseRxMinDepthOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxMinDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getRxMinDepthOffset (const CoordZ &tx, const CoordZ &rx)

double	getRxMinDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setRxMaxDepthOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxMaxDepthOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseRxMaxDepthOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxMaxDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getRxMaxDepthOffset (const CoordZ &tx, const CoordZ &rx)

double	getRxMaxDepthOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setRxMinRangeOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxMinRangeOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseRxMinRangeOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxMinRangeOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getRxMinRangeOffset (const CoordZ &tx, const CoordZ &rx)

double	getRxMinRangeOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setRxMaxRangeOffset (double offset, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxMaxRangeOffset (double offset, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseRxMaxRangeOffset (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxMaxRangeOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getRxMaxRangeOffset (const CoordZ &tx, const CoordZ &rx)

double	getRxMaxRangeOffset (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setRxTotalDepths (int number, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxTotalDepths (int number, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseRxTotalDepths (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxTotalDepths (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getRxTotalDepths (const CoordZ &tx, const CoordZ &rx)

int	getRxTotalDepths (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setRxTotalRanges (int number, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRxTotalRanges (int number, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseRxTotalRanges (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRxTotalRanges (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getRxTotalRanges (const CoordZ &tx, const CoordZ &rx)

int	getRxTotalRanges (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setRaysNumber (int number, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setRaysNumber (int number, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseRaysNumber (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseRaysNumber (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getRaysNumber (const CoordZ &tx, const CoordZ &rx)

int	getRaysNumber (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setBellhopPath (const ::std::string &path)

::std::string	getBellhopPath ()

BellhopCreator &	setBellhopArrSyntax (BellhopArrSyntax syntax)

BellhopArrSyntax	getBellhopArrSyntax ()

BellhopCreator &	setBellhopShdSyntax (BellhopShdSyntax syntax)

BellhopShdSyntax	getBellhopShdSyntax ()

BellhopCreator &	setBeamOptions (const ::std::string &options, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBeamOptions (const ::std::string &options, Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	eraseBeamOptions (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBeamOptions (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

::std::string	getBeamOptions (const CoordZ &tx, const CoordZ &rx)

::std::string	getBeamOptions (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	setBhMode (const ::std::string &options, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBhMode (const ::std::string &options, Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	eraseBhMode (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBhMode (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

::std::string	getBhMode (const CoordZ &tx, const CoordZ &rx)

::std::string	getBhMode (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	setBathymetryType (const ::std::string &options, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBathymetryType (const ::std::string &options, Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	eraseBathymetryType (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBathymetryType (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

::std::string	getBathymetryType (const CoordZ &tx, const CoordZ &rx)

::std::string	getBathymetryType (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	setBathymetryMethod (const ::std::string &options, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBathymetryMethod (const ::std::string &options, Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	eraseBathymetryMethod (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBathymetryMethod (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

::std::string	getBathymetryMethod (const CoordZ &tx, const CoordZ &rx)

::std::string	getBathymetryMethod (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	setAltimetryType (const ::std::string &options, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setAltimetryType (const ::std::string &options, Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	eraseAltimetryType (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseAltimetryType (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

::std::string	getAltimetryType (const CoordZ &tx, const CoordZ &rx)

::std::string	getAltimetryType (Location const tx=CCString::ALL_LOCATIONS, Location const rx=CCString::ALL_LOCATIONS)

BellhopCreator &	setAngles (const CustomAngles &angles, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setAngles (const CustomAngles &angles, Location const tx=CCAngles::ALL_LOCATIONS, Location const rx=CCAngles::ALL_LOCATIONS)

CustomAngles	getAngles (const CoordZ &tx, const CoordZ &rx) const

CustomAngles	getAngles (Location const tx=CCAngles::ALL_LOCATIONS, Location const rx=CCAngles::ALL_LOCATIONS) const

BellhopCreator &	eraseAngles (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseAngles (Location const tx=CCAngles::ALL_LOCATIONS, Location const rx=CCAngles::ALL_LOCATIONS)

BellhopCreator &	setBoxDepth (double box_depth, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBoxDepth (double box_depth, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseBoxDepth (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBoxDepth (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getBoxDepth (const CoordZ &tx, const CoordZ &rx)

double	getBoxDepth (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setBoxRange (double box_range, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setBoxRange (double box_range, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseBoxRange (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseBoxRange (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getBoxRange (const CoordZ &tx, const CoordZ &rx)

double	getBoxRange (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setSspDepthPrecision (double ssp_precision, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setSspDepthPrecision (double ssp_precision, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	eraseSspDepthPrecision (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseSspDepthPrecision (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getSspDepthPrecision (const CoordZ &tx, const CoordZ &rx)

double	getSspDepthPrecision (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

BellhopCreator &	setSspDepthSteps (int ssp_depth_steps, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setSspDepthSteps (int ssp_depth_steps, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	eraseSspDepthSteps (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseSspDepthSteps (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getSspDepthSteps (const CoordZ &tx, const CoordZ &rx)

int	getSspDepthSteps (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

BellhopCreator &	setCustomTransducer (const CustomTransducer &type, const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	setCustomTransducer (const CustomTransducer &type, Location const tx=CCTransducer::ALL_LOCATIONS, Location const rx=CCTransducer::ALL_LOCATIONS)

CustomTransducer	getCustomTransducer (const CoordZ &tx, const CoordZ &rx) const

CustomTransducer	getCustomTransducer (Location const tx=CCTransducer::ALL_LOCATIONS, Location const rx=CCTransducer::ALL_LOCATIONS) const

BellhopCreator &	eraseCustomTransducer (const CoordZ &tx, const CoordZ &rx)

BellhopCreator &	eraseCustomTransducer (Location const tx=CCTransducer::ALL_LOCATIONS, Location const rx=CCTransducer::ALL_LOCATIONS)

Public Member Functions inherited from woss::WossCreator
	WossCreator ()

virtual Woss *const	createWoss (const CoordZ &tx, const CoordZ &rx, double start_freq, double end_freq) const =0

WossCreator &	setWossDebug (bool flag)

WossCreator &	setDebug (bool flag)

bool	usingDebug () const

bool	usingWossDebug () const

WossCreator &	setWrkDirPath (const ::std::string &path)

WossCreator &	setCleanWorkDir (bool flag)

::std::string	getWrkDirPath () const

WossCreator &	setFrequencyStep (double f_step, const CoordZ &tx, const CoordZ &rx)

WossCreator &	setFrequencyStep (double f_step, Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

double	getFrequencyStep (const CoordZ &tx, const CoordZ &rx) const

double	getFrequencyStep (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS) const

WossCreator &	eraseFrequencyStep (const CoordZ &tx, const CoordZ &rx)

WossCreator &	eraseFrequencyStep (Location const tx=CCDouble::ALL_LOCATIONS, Location const rx=CCDouble::ALL_LOCATIONS)

WossCreator &	setEvolutionTimeQuantum (double value, const CoordZ &tx, const CoordZ &rx)

WossCreator &	setEvolutionTimeQuantum (double value, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

double	getEvolutionTimeQuantum (const CoordZ &tx, const CoordZ &rx) const

double	getEvolutionTimeQuantum (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS) const

WossCreator &	eraseEvolutionTimeQuantum (const CoordZ &tx, const CoordZ &rx)

WossCreator &	eraseEvolutionTimeQuantum (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

WossCreator &	setTotalRuns (int runs, const CoordZ &tx, const CoordZ &rx)

WossCreator &	setTotalRuns (int runs, Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

int	getTotalRuns (const CoordZ &tx, const CoordZ &rx) const

int	getTotalRuns (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS) const

WossCreator &	eraseTotalRuns (const CoordZ &tx, const CoordZ &rx)

WossCreator &	eraseTotalRuns (Location const tx=CCInt::ALL_LOCATIONS, Location const rx=CCInt::ALL_LOCATIONS)

WossCreator &	setSimTime (const SimTime &simtime, const CoordZ &tx, const CoordZ &rx)

WossCreator &	setSimTime (const SimTime &simtime, Location const tx=CCSimTime::ALL_LOCATIONS, Location const rx=CCSimTime::ALL_LOCATIONS)

SimTime	getSimTime (const CoordZ &tx, const CoordZ &rx) const

SimTime	getSimTime (Location const tx=CCSimTime::ALL_LOCATIONS, Location const rx=CCSimTime::ALL_LOCATIONS) const

WossCreator &	eraseSimTime (const CoordZ &tx, const CoordZ &rx)

WossCreator &	eraseSimTime (Location const tx=CCSimTime::ALL_LOCATIONS, Location const rx=CCSimTime::ALL_LOCATIONS)

WossCreator &	setWossDbManager (const WossDbManager *const ptr)

WossCreator &	setTransducerHandler (const TransducerHandler *const ptr)

const Woss &	getWossNotValid () const

Protected Member Functions
virtual bool	initializeWoss (Woss *const woss_ptr) const

bool	initializeBhWoss (BellhopWoss *const woss_ptr) const

virtual const BellhopWoss *	createNotValidWoss () const

virtual void	updateDebugFlag ()

virtual bool	initializeWoss (Woss *const woss_ptr) const =0

virtual const Woss *	createNotValidWoss () const =0

virtual void	updateDebugFlag ()

Protected Attributes
bool	use_thorpe_att

::std::string	bellhop_path

BellhopArrSyntax	bellhop_arr_syntax

BellhopShdSyntax	bellhop_shd_syntax

CCString	ccbellhop_mode

CCString	ccbeam_options

CCString	ccbathymetry_type

CCString	ccbathymetry_method

CCString	ccaltimetry_type

CCAngles	ccangles_map

CCInt	cctotal_range_steps

CCInt	cctotal_transmitters

CCDouble	cctx_min_depth_offset

CCDouble	cctx_max_depth_offset

CCInt	cctotal_rx_depths

CCDouble	ccrx_min_depth_offset

CCDouble	ccrx_max_depth_offset

CCInt	cctotal_rx_ranges

CCDouble	ccrx_min_range_offset

CCDouble	ccrx_max_range_offset

CCInt	cctotal_rays

CCDouble	ccssp_depth_precision

CCInt	ccnormalized_ssp_depth_steps

CCTransducer	cctransducer

CCDouble	ccbox_depth

CCDouble	ccbox_range

Protected Attributes inherited from woss::WossCreator
const WossDbManager *	woss_db_manager

const TransducerHandler *	transducer_handler

::std::string	work_dir_path

CCDouble	ccevolution_time_quantum

CCInt	cctotal_runs

CCDouble	ccfrequency_step

CCSimTime	ccsimtime_map

bool	debug

bool	woss_debug

bool	woss_clean_workdir

Additional Inherited Members
Protected Types inherited from woss::WossCreator
typedef WossCreatorContainer< SimTime >	CCSimTime

typedef WossCreatorContainer< double >	CCDouble

typedef WossCreatorContainer< int >	CCInt

Static Protected Attributes inherited from woss::WossCreator
static const Woss *	woss_not_valid = NULL

Detailed Description

class that provides correctly initialized BellhopWoss objects

BellhopCreator implements WossCreator and provides interface for creation and initializiation of BellhopWoss object

Member Typedef Documentation

◆ CCAngles

typedef WossCreatorContainer< CustomAngles > woss::BellhopCreator::CCAngles

CustomAngles container. A map that links a valid CoordZ (transmitter) with its CustomAngles

Constructor & Destructor Documentation

◆ BellhopCreator()

BellhopCreator::BellhopCreator ( )

BellhopCreator default constructor

References woss::WossCreatorContainer< CustomTransducer >::accessAllLocations(), woss::BELLHOP_CREATOR_ARR_FILE_INVALID, woss::BELLHOP_CREATOR_SHD_FILE_INVALID, cctransducer, and updateDebugFlag().

Here is the call graph for this function:

Member Function Documentation

◆ createNotValidWoss()

const BellhopWoss * BellhopCreator::createNotValidWoss ( ) const

protectedvirtual

Implements woss::WossCreator.

◆ createWoss()

BellhopWoss *const BellhopCreator::createWoss	(	const CoordZ &	tx,
		const CoordZ &	rx,
		double	start_frequency,
		double	end_frequency
	)		const

virtual

Returns a pointer to valid BellhopWoss for given parameters

Parameters

tx	const reference to a valid CoordZ object ( transmitter )
rx	const reference to a valid CoordZ object ( receiver )
start_freq	start frequency [Hz]
end_freq	end frequency [Hz]

Returns: pointer to properly initialized BellhopWoss object

Implements woss::WossCreator.

References woss::WossCreator::getFrequencyStep(), woss::WossCreator::getSimTime(), initializeBhWoss(), and woss::Time::isValid().

Here is the call graph for this function:

◆ eraseAltimetryType() [1/2]

BellhopCreator & woss::BellhopCreator::eraseAltimetryType	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseAltimetryType() [2/2]

BellhopCreator & woss::BellhopCreator::eraseAltimetryType	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Erases the altimetry type ( L, C ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseAngles() [1/2]

BellhopCreator & woss::BellhopCreator::eraseAngles	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccangles_map, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseAngles() [2/2]

BellhopCreator & woss::BellhopCreator::eraseAngles	(	Location *const	tx = `CCAngles::ALL_LOCATIONS`,
		Location *const	rx = `CCAngles::ALL_LOCATIONS`
	)

inline

Erases the CustomAngles for given transmitter CoordZ, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccangles_map, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBathymetryMethod() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBathymetryMethod	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBathymetryMethod() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBathymetryMethod	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Erases the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBathymetryType() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBathymetryType	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBathymetryType() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBathymetryType	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Erases the bathymetry type ( L, C ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBeamOptions() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBeamOptions	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the beam option string for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbeam_options, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBeamOptions() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBeamOptions	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Erases the beam option string for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbeam_options, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBhMode() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBhMode	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the Bellhop run mode string for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBhMode() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBhMode	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Erases the Bellhop run mode string for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBoxDepth() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBoxDepth	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the maximum box depth [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbox_depth, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBoxDepth() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBoxDepth	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver box depth [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbox_depth, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBoxRange() [1/2]

BellhopCreator & woss::BellhopCreator::eraseBoxRange	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the maximum box depth [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbox_range, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseBoxRange() [2/2]

BellhopCreator & woss::BellhopCreator::eraseBoxRange	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver box depth [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbox_range, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseCustomTransducer() [1/2]

BellhopCreator & woss::BellhopCreator::eraseCustomTransducer	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the woss::Transducer for given transmitter woss::CoordZ, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccangles_map, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseCustomTransducer() [2/2]

BellhopCreator & woss::BellhopCreator::eraseCustomTransducer	(	Location *const	tx = `CCTransducer::ALL_LOCATIONS`,
		Location *const	rx = `CCTransducer::ALL_LOCATIONS`
	)

inline

Erases the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctransducer.

◆ eraseRaysNumber() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRaysNumber	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the number of launched rays for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rays, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRaysNumber() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRaysNumber	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases the number of launched rays for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_rays, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMaxDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxMaxDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMaxDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxMaxDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMaxRangeOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxMaxRangeOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMaxRangeOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxMaxRangeOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMinDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxMinDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMinDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxMinDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMinRangeOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxMinRangeOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxMinRangeOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxMinRangeOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the receiver mimimum range offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxTotalDepths() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxTotalDepths	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the number of receiver depths for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxTotalDepths() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxTotalDepths	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases the number of receiver depths for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxTotalRanges() [1/2]

BellhopCreator & woss::BellhopCreator::eraseRxTotalRanges	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the number of receiver ranges for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseRxTotalRanges() [2/2]

BellhopCreator & woss::BellhopCreator::eraseRxTotalRanges	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases the number of receiver ranges for given transmitter, receiver woss::Location

Parameters

tx	const reference to a valid woss::Location instance
rx	const reference to a valid woss::Location instance

Returns: reference to *this

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseSspDepthPrecision() [1/2]

BellhopCreator & woss::BellhopCreator::eraseSspDepthPrecision	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the SSP depth precision [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseSspDepthPrecision() [2/2]

BellhopCreator & woss::BellhopCreator::eraseSspDepthPrecision	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the SSP depth precision [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseSspDepthSteps() [1/2]

BellhopCreator & woss::BellhopCreator::eraseSspDepthSteps	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases depth steps for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseSspDepthSteps() [2/2]

BellhopCreator & woss::BellhopCreator::eraseSspDepthSteps	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases depth steps for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTotalRangeSteps() [1/2]

BellhopCreator & woss::BellhopCreator::eraseTotalRangeSteps	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTotalRangeSteps() [2/2]

BellhopCreator & woss::BellhopCreator::eraseTotalRangeSteps	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases the total range steps of bellhop simulation for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTotalTransmitters() [1/2]

BellhopCreator & woss::BellhopCreator::eraseTotalTransmitters	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the number of transmitters for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTotalTransmitters() [2/2]

BellhopCreator & woss::BellhopCreator::eraseTotalTransmitters	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Erases the number of transmitters for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTxMaxDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseTxMaxDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTxMaxDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseTxMaxDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTxMinDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::eraseTxMinDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Erases mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ eraseTxMinDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::eraseTxMinDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Erases mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().

Here is the call graph for this function:

◆ getAltimetryType() [1/2]

::std::string woss::BellhopCreator::getAltimetryType	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: altimetry type

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getAltimetryType() [2/2]

::std::string woss::BellhopCreator::getAltimetryType	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the altimetry type ( L, C ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: altimetry type

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getAngles() [1/2]

CustomAngles woss::BellhopCreator::getAngles	(	const CoordZ &	tx,
		const CoordZ &	rx
	)		const

inline

Returns the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: a valid CustomAngles

References ccangles_map, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getAngles() [2/2]

CustomAngles woss::BellhopCreator::getAngles	(	Location *const	tx = `CCAngles::ALL_LOCATIONS`,
		Location *const	rx = `CCAngles::ALL_LOCATIONS`
	)		const

inline

Returns the CustomAngles for given transmitter CoordZ, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: a valid CustomAngles

References ccangles_map, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBathymetryMethod() [1/2]

::std::string woss::BellhopCreator::getBathymetryMethod	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: bathymetry type

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBathymetryMethod() [2/2]

::std::string woss::BellhopCreator::getBathymetryMethod	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: bathymetry type

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBathymetryType() [1/2]

::std::string woss::BellhopCreator::getBathymetryType	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: bathymetry type

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBathymetryType() [2/2]

::std::string woss::BellhopCreator::getBathymetryType	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: bathymetry type

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBeamOptions() [1/2]

::std::string woss::BellhopCreator::getBeamOptions	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the beam option string for given transmitter, receiver woss::CoordZ

Parameters

rx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: beam options

References ccbeam_options, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBeamOptions() [2/2]

::std::string woss::BellhopCreator::getBeamOptions	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Returns the beam option string for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: beam options

References ccbeam_options, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBellhopArrSyntax()

BellhopArrSyntax woss::BellhopCreator::getBellhopArrSyntax ( )

inline

Gets the .arr file syntax

Returns: bellhop_arr_syntax

References bellhop_arr_syntax.

◆ getBellhopPath()

::std::string woss::BellhopCreator::getBellhopPath ( )

inline

Gets the path of bellhop program

Returns: path string

References bellhop_path.

◆ getBellhopShdSyntax()

BellhopShdSyntax woss::BellhopCreator::getBellhopShdSyntax ( )

inline

Gets the .shd file syntax

Returns: bellhop_shd_syntax

References bellhop_shd_syntax.

◆ getBhMode() [1/2]

::std::string woss::BellhopCreator::getBhMode	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the Bellhop run mode string for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: Bellhop run mode

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBhMode() [2/2]

::std::string woss::BellhopCreator::getBhMode	(	Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Returns the Bellhop run mode string for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: Bellhop run mode

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBoxDepth() [1/2]

double woss::BellhopCreator::getBoxDepth	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the maximum box depth [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccbox_depth, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBoxDepth() [2/2]

double woss::BellhopCreator::getBoxDepth	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the maximum box depth [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccbox_depth, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBoxRange() [1/2]

double woss::BellhopCreator::getBoxRange	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the maximum box depth [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccbox_range, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getBoxRange() [2/2]

double woss::BellhopCreator::getBoxRange	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the maximum box depth [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccbox_range, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getCustomTransducer() [1/2]

CustomTransducer woss::BellhopCreator::getCustomTransducer	(	const CoordZ &	tx,
		const CoordZ &	rx
	)		const

inline

Returns the woss::Transducer for given transmitter CoordZ, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: a valid woss::Transducer

References cctransducer, and woss::WossCreatorContainer< CustomTransducer >::get().

Here is the call graph for this function:

◆ getCustomTransducer() [2/2]

CustomTransducer woss::BellhopCreator::getCustomTransducer	(	Location *const	tx = `CCTransducer::ALL_LOCATIONS`,
		Location *const	rx = `CCTransducer::ALL_LOCATIONS`
	)		const

inline

Returns the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: a valid woss::Transducer

References cctransducer, and woss::WossCreatorContainer< CustomTransducer >::get().

Here is the call graph for this function:

◆ getRaysNumber() [1/2]

int woss::BellhopCreator::getRaysNumber	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the number of launched rays for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: number of launched rays

References cctotal_rays, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRaysNumber() [2/2]

int woss::BellhopCreator::getRaysNumber	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Returns the number of launched rays for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: number of launched rays

References cctotal_rays, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMaxDepthOffset() [1/2]

double woss::BellhopCreator::getRxMaxDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMaxDepthOffset() [2/2]

double woss::BellhopCreator::getRxMaxDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMaxRangeOffset() [1/2]

double woss::BellhopCreator::getRxMaxRangeOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMaxRangeOffset() [2/2]

double woss::BellhopCreator::getRxMaxRangeOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMinDepthOffset() [1/2]

double woss::BellhopCreator::getRxMinDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMinDepthOffset() [2/2]

double woss::BellhopCreator::getRxMinDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMinRangeOffset() [1/2]

double woss::BellhopCreator::getRxMinRangeOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxMinRangeOffset() [2/2]

double woss::BellhopCreator::getRxMinRangeOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the receiver mimimum range offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxTotalDepths() [1/2]

int woss::BellhopCreator::getRxTotalDepths	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Gets the number of receiver depths for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: number of receiver depths

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxTotalDepths() [2/2]

int woss::BellhopCreator::getRxTotalDepths	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the number of receiver depths for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: number of receiver depths

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxTotalRanges() [1/2]

int woss::BellhopCreator::getRxTotalRanges	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the number of receiver ranges for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: number of receiver ranges

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getRxTotalRanges() [2/2]

int woss::BellhopCreator::getRxTotalRanges	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Returns the number of receiver ranges for given transmitter, receiver woss::Location

Parameters

tx	const reference to a valid woss::Location instance
rx	const reference to a valid woss::Location instance

Returns: number of receiver ranges

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getSspDepthPrecision() [1/2]

double woss::BellhopCreator::getSspDepthPrecision	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the SSP depth precision [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getSspDepthPrecision() [2/2]

double woss::BellhopCreator::getSspDepthPrecision	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns the SSP depth precision [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getSspDepthSteps() [1/2]

int woss::BellhopCreator::getSspDepthSteps	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns depth steps for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
tx	const reference to a valid woss::CoordZ instance

Returns: integer value

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getSspDepthSteps() [2/2]

int woss::BellhopCreator::getSspDepthSteps	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Returns depth steps for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
tx	const pointer to a valid woss::Location instance

Returns: integer value

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getThorpeAttFlag()

bool woss::BellhopCreator::getThorpeAttFlag ( )

inline

Gets the Thorpe attenuation flag for all bellhop instances

Returns: boolean flag

References use_thorpe_att.

◆ getTotalRangeSteps() [1/2]

double woss::BellhopCreator::getTotalRangeSteps	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: int value

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTotalRangeSteps() [2/2]

double woss::BellhopCreator::getTotalRangeSteps	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Returns the total range steps of bellhop simulation for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: int value

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTotalTransmitters() [1/2]

int woss::BellhopCreator::getTotalTransmitters	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns the number of transmitters for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: total number of transmitter sources

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTotalTransmitters() [2/2]

int woss::BellhopCreator::getTotalTransmitters	(	Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Returns the number of transmitters for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: total number of transmitter sources

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTxMaxDepthOffset() [1/2]

double woss::BellhopCreator::getTxMaxDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Gets the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTxMaxDepthOffset() [2/2]

double woss::BellhopCreator::getTxMaxDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Gets the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTxMinDepthOffset() [1/2]

double woss::BellhopCreator::getTxMinDepthOffset	(	const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Returns mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ getTxMinDepthOffset() [2/2]

double woss::BellhopCreator::getTxMinDepthOffset	(	Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Returns mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().

Here is the call graph for this function:

◆ initializeBhWoss()

bool BellhopCreator::initializeBhWoss ( BellhopWoss *const woss_ptr ) const

protected

Initializes given BellhopWoss object

Parameters

woss_ptr const pointer to an unitialized BellhopWoss

Returns: true if method succeeded, false otherwise

Referenced by createWoss().

Here is the call graph for this function:

◆ initializeWoss()

bool BellhopCreator::initializeWoss ( Woss *const woss_ptr ) const

protectedvirtual

Initializes given BellhopWoss object

Parameters

woss_ptr const pointer to an unitialized BellhopWoss

Returns: true if method succeeded, false otherwise

Implements woss::WossCreator.

References woss::Woss::initialize(), and woss::WossCreator::initializeWoss().

Referenced by initializeBhWoss().

Here is the call graph for this function:

◆ setAltimetryType() [1/2]

BellhopCreator & woss::BellhopCreator::setAltimetryType	(	const ::std::string &	options,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info

Parameters

type	altimetry type
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setAltimetryType() [2/2]

BellhopCreator & woss::BellhopCreator::setAltimetryType	(	const ::std::string &	options,
		Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the altimetry type ( L, C ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info

Parameters

type	altimetry types
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccaltimetry_type, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setAngles() [1/2]

BellhopCreator & woss::BellhopCreator::setAngles	(	const CustomAngles &	angles,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ

Parameters

angles	const reference to a valid CustomAngles
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccangles_map, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setAngles() [2/2]

BellhopCreator & woss::BellhopCreator::setAngles	(	const CustomAngles &	angles,
		Location *const	tx = `CCAngles::ALL_LOCATIONS`,
		Location *const	rx = `CCAngles::ALL_LOCATIONS`
	)

inline

Sets the CustomAngles for given transmitter CoordZ, receiver woss::Location

Parameters

angles	const reference to a valid CustomAngles
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccangles_map, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBathymetryMethod() [1/2]

BellhopCreator & woss::BellhopCreator::setBathymetryMethod	(	const ::std::string &	options,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info

Parameters

type	bathymetry write method
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBathymetryMethod() [2/2]

BellhopCreator & woss::BellhopCreator::setBathymetryMethod	(	const ::std::string &	options,
		Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info

Parameters

type	bathymetry types
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbathymetry_method, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBathymetryType() [1/2]

BellhopCreator & woss::BellhopCreator::setBathymetryType	(	const ::std::string &	options,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info

Parameters

type	bathymetry type
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBathymetryType() [2/2]

BellhopCreator & woss::BellhopCreator::setBathymetryType	(	const ::std::string &	options,
		Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info

Parameters

type	bathymetry types
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbathymetry_type, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBeamOptions() [1/2]

BellhopCreator & woss::BellhopCreator::setBeamOptions	(	const ::std::string &	options,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the beam option string for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info

Parameters

options	beam options ( G, C, R , B)
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbeam_options, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBeamOptions() [2/2]

BellhopCreator & woss::BellhopCreator::setBeamOptions	(	const ::std::string &	options,
		Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the beam option string for given transmitter, receiver woss::Location. See Bellhop documentation for more info

Parameters

options	beam options ( G, C, R , B)
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbeam_options, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBellhopArrSyntax()

BellhopCreator & woss::BellhopCreator::setBellhopArrSyntax ( BellhopArrSyntax syntax )

inline

Sets the .arr file syntax to be used during file parsing

Parameters

syntax .arr file syntax

Returns: reference to *this

References bellhop_arr_syntax.

◆ setBellhopPath()

BellhopCreator & woss::BellhopCreator::setBellhopPath ( const ::std::string & path )

inline

Sets the path of bellhop program

Parameters

path	filesystem path

Returns: reference to *this

References bellhop_path.

◆ setBellhopShdSyntax()

BellhopCreator & woss::BellhopCreator::setBellhopShdSyntax ( BellhopShdSyntax syntax )

inline

Sets the .shd file syntax to be used during file parsing

Parameters

syntax .arr file syntax

Returns: reference to *this

References bellhop_shd_syntax.

◆ setBhMode() [1/2]

BellhopCreator & woss::BellhopCreator::setBhMode	(	const ::std::string &	options,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the Bellhop run mode string for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info

Parameters

mode	Bellhop run mode ( A, a , C, I , S)
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBhMode() [2/2]

BellhopCreator & woss::BellhopCreator::setBhMode	(	const ::std::string &	options,
		Location *const	tx = `CCString::ALL_LOCATIONS`,
		Location *const	rx = `CCString::ALL_LOCATIONS`
	)

inline

Sets the Bellhop run mode string for given transmitter, receiver woss::Location. See Bellhop documentation for more info

Parameters

mode	Bellhop run mode ( A, a , C, I , S)
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccbellhop_mode, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBoxDepth() [1/2]

BellhopCreator & woss::BellhopCreator::setBoxDepth	(	double	box_depth,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::CoordZ

Parameters

box_depth	[m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbox_depth, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBoxDepth() [2/2]

BellhopCreator & woss::BellhopCreator::setBoxDepth	(	double	box_depth,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::Location

Parameters

box_depth	[m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccbox_depth, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBoxRange() [1/2]

BellhopCreator & woss::BellhopCreator::setBoxRange	(	double	box_range,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the maximum Bellhop ray range [m] for given transmitter, receiver woss::CoordZ

Parameters

box_depth	[m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccbox_range, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setBoxRange() [2/2]

BellhopCreator & woss::BellhopCreator::setBoxRange	(	double	box_range,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::Location

Parameters

box_depth	[m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: value in meters

References ccbox_range, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setCustomTransducer() [1/2]

BellhopCreator & woss::BellhopCreator::setCustomTransducer	(	const CustomTransducer &	type,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the woss::Transducer for given transmitter woss::CoordZ, receiver woss::CoordZ

Parameters

angles	const reference to a valid woss::Transducer
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctransducer, and woss::WossCreatorContainer< CustomTransducer >::replace().

Here is the call graph for this function:

◆ setCustomTransducer() [2/2]

BellhopCreator & woss::BellhopCreator::setCustomTransducer	(	const CustomTransducer &	type,
		Location *const	tx = `CCTransducer::ALL_LOCATIONS`,
		Location *const	rx = `CCTransducer::ALL_LOCATIONS`
	)

inline

Sets the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location

Parameters

angles	const reference to a valid woss::Transducer
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctransducer, and woss::WossCreatorContainer< CustomTransducer >::replace().

Here is the call graph for this function:

◆ setRaysNumber() [1/2]

BellhopCreator & woss::BellhopCreator::setRaysNumber	(	int	number,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the number of launched rays for given transmitter, receiver woss::CoordZ

Parameters

number	number of launched rays (>= 0)
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rays, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRaysNumber() [2/2]

BellhopCreator & woss::BellhopCreator::setRaysNumber	(	int	number,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the number of launched rays for given transmitter, receiver woss::Location

Parameters

number	number of launched rays (>= 0)
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_rays, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMaxDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setRxMaxDepthOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMaxDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setRxMaxDepthOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMaxRangeOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setRxMaxRangeOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	-total_distance <= range offset <= total_distance [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMaxRangeOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setRxMaxRangeOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	-total_distance <= range offset <= total_distance [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMinDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setRxMinDepthOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMinDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setRxMinDepthOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMinRangeOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setRxMinRangeOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	-total_distance <= range offset <= total_distance [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxMinRangeOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setRxMinRangeOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the receiver mimimum range offset [m] for given transmitter, receiver woss::Location

Parameters

offset	-total_distance <= range offset <= total_distance [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxTotalDepths() [1/2]

BellhopCreator & woss::BellhopCreator::setRxTotalDepths	(	int	number,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the number of receiver depths for given transmitter, receiver woss::CoordZ

Parameters

number	number of receiver depths
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxTotalDepths() [2/2]

BellhopCreator & woss::BellhopCreator::setRxTotalDepths	(	int	number,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the number of receiver depths for given transmitter, receiver woss::Location

Parameters

number	number of receiver depths
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_rx_depths, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxTotalRanges() [1/2]

BellhopCreator & woss::BellhopCreator::setRxTotalRanges	(	int	number,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the number of receiver ranges for given transmitter, receiver woss::CoordZ

Parameters

number	number of receiver ranges
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setRxTotalRanges() [2/2]

BellhopCreator & woss::BellhopCreator::setRxTotalRanges	(	int	number,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the number of receiver ranges for given transmitter, receiver woss::Location

Parameters

number	number of receiver ranges
tx	const reference to a valid woss::Location instance
rx	const reference to a valid woss::Location instance

Returns: reference to *this

References cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setSspDepthPrecision() [1/2]

BellhopCreator & woss::BellhopCreator::setSspDepthPrecision	(	double	ssp_precision,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the SSP depth precision [m] for given transmitter, receiver woss::CoordZ

Parameters

ssp_precision	depth_precision [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setSspDepthPrecision() [2/2]

BellhopCreator & woss::BellhopCreator::setSspDepthPrecision	(	double	ssp_precision,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the SSP depth precision [m] for given transmitter, receiver woss::Location

Parameters

ssp_precision	depth_precision [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccssp_depth_precision, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setSspDepthSteps() [1/2]

BellhopCreator & woss::BellhopCreator::setSspDepthSteps	(	int	ssp_depth_steps,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the SSP depth steps for given transmitter, receiver woss::CoordZ

Parameters

ssp_depth_steps	depth steps
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: value in meters

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setSspDepthSteps() [2/2]

BellhopCreator & woss::BellhopCreator::setSspDepthSteps	(	int	ssp_depth_steps,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the SSP depth steps for given transmitter, receiver woss::Location

Parameters

ssp_depth_steps	depth_precision [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setThorpeAttFlag()

BellhopCreator & woss::BellhopCreator::setThorpeAttFlag ( bool flag )

inline

Sets the Thorpe attenuation flag for all bellhop instances

Parameters

flag	boolean flag

Returns: reference to *this

References use_thorpe_att.

◆ setTotalRangeSteps() [1/2]

BellhopCreator & woss::BellhopCreator::setTotalRangeSteps	(	int	steps,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ

Parameters

steps	total range steps
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTotalRangeSteps() [2/2]

BellhopCreator & woss::BellhopCreator::setTotalRangeSteps	(	int	steps,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the total range steps of bellhop simulation for given transmitter, receiver woss::Location

Parameters

steps	total range steps
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_range_steps, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTotalTransmitters() [1/2]

BellhopCreator & woss::BellhopCreator::setTotalTransmitters	(	int	sources,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the number of transmitters for given transmitter, receiver woss::CoordZ

Parameters

sources	number of transmitters
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTotalTransmitters() [2/2]

BellhopCreator & woss::BellhopCreator::setTotalTransmitters	(	int	sources,
		Location *const	tx = `CCInt::ALL_LOCATIONS`,
		Location *const	rx = `CCInt::ALL_LOCATIONS`
	)

inline

Sets the number of transmitters for given transmitter, receiver woss::Location

Parameters

sources	number of transmitters
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctotal_transmitters, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTxMaxDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setTxMaxDepthOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTxMaxDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setTxMaxDepthOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTxMinDepthOffset() [1/2]

BellhopCreator & woss::BellhopCreator::setTxMinDepthOffset	(	double	offset,
		const CoordZ &	tx,
		const CoordZ &	rx
	)

inline

Sets mimimum depth offset [m] for given transmitter, receiver woss::CoordZ

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const reference to a valid woss::CoordZ instance
rx	const reference to a valid woss::CoordZ instance

Returns: reference to *this

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ setTxMinDepthOffset() [2/2]

BellhopCreator & woss::BellhopCreator::setTxMinDepthOffset	(	double	offset,
		Location *const	tx = `CCDouble::ALL_LOCATIONS`,
		Location *const	rx = `CCDouble::ALL_LOCATIONS`
	)

inline

Sets mimimum depth offset [m] for given transmitter, receiver woss::Location

Parameters

offset	0 <= depth offset <= 0 [m]
tx	const pointer to a valid woss::Location instance
rx	const pointer to a valid woss::Location instance

Returns: reference to *this

References cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().

Here is the call graph for this function:

◆ updateDebugFlag()

void BellhopCreator::updateDebugFlag ( )

protectedvirtual

Propagates the debug flag

Reimplemented from woss::WossCreator.

References ccaltimetry_type, ccangles_map, ccbathymetry_method, ccbathymetry_type, ccbeam_options, ccbellhop_mode, ccnormalized_ssp_depth_steps, ccrx_max_depth_offset, ccrx_max_range_offset, ccrx_min_depth_offset, ccrx_min_range_offset, ccssp_depth_precision, cctotal_range_steps, cctotal_rays, cctotal_rx_depths, cctotal_rx_ranges, cctotal_transmitters, cctransducer, cctx_max_depth_offset, cctx_min_depth_offset, woss::WossCreator::debug, woss::WossCreatorContainer< Data >::setDebug(), and woss::WossCreator::updateDebugFlag().

Referenced by BellhopCreator().

Here is the call graph for this function:

Member Data Documentation

◆ bellhop_arr_syntax

BellhopArrSyntax woss::BellhopCreator::bellhop_arr_syntax

protected

Bellhop .arr file syntax to be used during parsing, factory value = invalid

Referenced by getBellhopArrSyntax(), initializeBhWoss(), and setBellhopArrSyntax().

◆ bellhop_path

::std::string woss::BellhopCreator::bellhop_path

protected

Pathname of Bellhop program

Referenced by getBellhopPath(), initializeBhWoss(), and setBellhopPath().

◆ bellhop_shd_syntax

BellhopShdSyntax woss::BellhopCreator::bellhop_shd_syntax

protected

Bellhop .shd file syntax to be used during parsing, factory value = invalid

Referenced by getBellhopShdSyntax(), initializeBhWoss(), and setBellhopShdSyntax().

◆ ccaltimetry_type

CCString woss::BellhopCreator::ccaltimetry_type

protected

Altimetry type ( L, C )

Referenced by eraseAltimetryType(), getAltimetryType(), initializeBhWoss(), setAltimetryType(), and updateDebugFlag().

◆ ccangles_map

CCAngles woss::BellhopCreator::ccangles_map

protected

CustomAngles containter for user-given transmitter CoordZ

Referenced by eraseAngles(), eraseCustomTransducer(), getAngles(), initializeBhWoss(), setAngles(), and updateDebugFlag().

◆ ccbathymetry_method

CCString woss::BellhopCreator::ccbathymetry_method

protected

Bathymetry write method ( S (slope), D (discrete )

Referenced by eraseBathymetryMethod(), getBathymetryMethod(), initializeBhWoss(), setBathymetryMethod(), and updateDebugFlag().

◆ ccbathymetry_type

CCString woss::BellhopCreator::ccbathymetry_type

protected

Bathymetry type ( L, C )

Referenced by eraseBathymetryType(), getBathymetryType(), initializeBhWoss(), setBathymetryType(), and updateDebugFlag().

◆ ccbeam_options

CCString woss::BellhopCreator::ccbeam_options

protected

Bellhop beam options ( G, C, R, B )

Referenced by eraseBeamOptions(), getBeamOptions(), initializeBhWoss(), setBeamOptions(), and updateDebugFlag().

◆ ccbellhop_mode

CCString woss::BellhopCreator::ccbellhop_mode

protected

Bellhop run mode ( A, a, C, I, S )

Referenced by eraseBhMode(), getBhMode(), initializeBhWoss(), setBhMode(), and updateDebugFlag().

◆ ccbox_depth

CCDouble woss::BellhopCreator::ccbox_depth

protected

Maximum Bellhop ray depth [m]

Referenced by eraseBoxDepth(), getBoxDepth(), initializeBhWoss(), and setBoxDepth().

◆ ccbox_range

CCDouble woss::BellhopCreator::ccbox_range

protected

Maximum Bellhop ray range [m]

Referenced by eraseBoxRange(), getBoxRange(), initializeBhWoss(), and setBoxRange().

◆ ccnormalized_ssp_depth_steps

CCInt woss::BellhopCreator::ccnormalized_ssp_depth_steps

protected

Depth steps of all SSP involved

Referenced by eraseSspDepthSteps(), getSspDepthSteps(), initializeBhWoss(), setSspDepthSteps(), and updateDebugFlag().

◆ ccrx_max_depth_offset

CCDouble woss::BellhopCreator::ccrx_max_depth_offset

protected

Receiver maximum depth offset [m]

Referenced by eraseRxMaxDepthOffset(), getRxMaxDepthOffset(), initializeBhWoss(), setRxMaxDepthOffset(), and updateDebugFlag().

◆ ccrx_max_range_offset

CCDouble woss::BellhopCreator::ccrx_max_range_offset

protected

Receiver maximum range offset [m]

Referenced by eraseRxMaxRangeOffset(), getRxMaxRangeOffset(), initializeBhWoss(), setRxMaxRangeOffset(), and updateDebugFlag().

◆ ccrx_min_depth_offset

CCDouble woss::BellhopCreator::ccrx_min_depth_offset

protected

Receiver minimum depth offset [m]

Referenced by eraseRxMinDepthOffset(), getRxMinDepthOffset(), initializeBhWoss(), setRxMinDepthOffset(), and updateDebugFlag().

◆ ccrx_min_range_offset

CCDouble woss::BellhopCreator::ccrx_min_range_offset

protected

Receiver minimum range offset [m]

Referenced by eraseRxMinRangeOffset(), getRxMinRangeOffset(), initializeBhWoss(), setRxMinRangeOffset(), and updateDebugFlag().

◆ ccssp_depth_precision

CCDouble woss::BellhopCreator::ccssp_depth_precision

protected

SSP depth precision [m]

Referenced by eraseSspDepthPrecision(), getSspDepthPrecision(), initializeBhWoss(), setSspDepthPrecision(), and updateDebugFlag().

◆ cctotal_range_steps

CCInt woss::BellhopCreator::cctotal_range_steps

protected

Number ot range steps

Referenced by eraseTotalRangeSteps(), getTotalRangeSteps(), initializeBhWoss(), setTotalRangeSteps(), and updateDebugFlag().

◆ cctotal_rays

CCInt woss::BellhopCreator::cctotal_rays

protected

Number of launched rays

Referenced by eraseRaysNumber(), getRaysNumber(), initializeBhWoss(), setRaysNumber(), and updateDebugFlag().

◆ cctotal_rx_depths

CCInt woss::BellhopCreator::cctotal_rx_depths

protected

Number of receiver depths

Referenced by eraseRxTotalDepths(), getRxTotalDepths(), initializeBhWoss(), setRxTotalDepths(), and updateDebugFlag().

◆ cctotal_rx_ranges

CCInt woss::BellhopCreator::cctotal_rx_ranges

protected

Number of receiver ranges.

On some configuration (linux distribution / cpu ) bellhop will output an empty file with a value of total_rx_ranges = 1.

Referenced by eraseRxTotalRanges(), getRxTotalRanges(), initializeBhWoss(), setRxTotalRanges(), and updateDebugFlag().

◆ cctotal_transmitters

CCInt woss::BellhopCreator::cctotal_transmitters

protected

Number of transmitter

Referenced by eraseTotalTransmitters(), getTotalTransmitters(), initializeBhWoss(), setTotalTransmitters(), and updateDebugFlag().

◆ cctransducer

CCTransducer woss::BellhopCreator::cctransducer

protected

Transmitter beam pattern

Referenced by BellhopCreator(), eraseCustomTransducer(), getCustomTransducer(), initializeBhWoss(), setCustomTransducer(), and updateDebugFlag().

◆ cctx_max_depth_offset

CCDouble woss::BellhopCreator::cctx_max_depth_offset

protected

Transmitter maximum depth offset [m]

Referenced by eraseTxMaxDepthOffset(), getTxMaxDepthOffset(), initializeBhWoss(), setTxMaxDepthOffset(), and updateDebugFlag().

◆ cctx_min_depth_offset

CCDouble woss::BellhopCreator::cctx_min_depth_offset

protected

Transmitter minimum depth offset [m]

Referenced by eraseTxMinDepthOffset(), getTxMinDepthOffset(), initializeBhWoss(), setTxMinDepthOffset(), and updateDebugFlag().

◆ use_thorpe_att

bool woss::BellhopCreator::use_thorpe_att

protected

flag that control bellhop's thorpe calculation

Referenced by getThorpeAttFlag(), initializeBhWoss(), and setThorpeAttFlag().

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

woss/bellhop-creator.h
woss/bellhop-creator.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CCAngles

Constructor & Destructor Documentation

◆ BellhopCreator()

Member Function Documentation

◆ createNotValidWoss()

◆ createWoss()

◆ eraseAltimetryType() [1/2]

◆ eraseAltimetryType() [2/2]

◆ eraseAngles() [1/2]

◆ eraseAngles() [2/2]

◆ eraseBathymetryMethod() [1/2]

◆ eraseBathymetryMethod() [2/2]

◆ eraseBathymetryType() [1/2]

◆ eraseBathymetryType() [2/2]

◆ eraseBeamOptions() [1/2]

◆ eraseBeamOptions() [2/2]

◆ eraseBhMode() [1/2]

◆ eraseBhMode() [2/2]

◆ eraseBoxDepth() [1/2]

◆ eraseBoxDepth() [2/2]

◆ eraseBoxRange() [1/2]

◆ eraseBoxRange() [2/2]

◆ eraseCustomTransducer() [1/2]

◆ eraseCustomTransducer() [2/2]

◆ eraseRaysNumber() [1/2]

◆ eraseRaysNumber() [2/2]

◆ eraseRxMaxDepthOffset() [1/2]

◆ eraseRxMaxDepthOffset() [2/2]

◆ eraseRxMaxRangeOffset() [1/2]

◆ eraseRxMaxRangeOffset() [2/2]

◆ eraseRxMinDepthOffset() [1/2]

◆ eraseRxMinDepthOffset() [2/2]

◆ eraseRxMinRangeOffset() [1/2]

◆ eraseRxMinRangeOffset() [2/2]

◆ eraseRxTotalDepths() [1/2]

◆ eraseRxTotalDepths() [2/2]

◆ eraseRxTotalRanges() [1/2]

◆ eraseRxTotalRanges() [2/2]

◆ eraseSspDepthPrecision() [1/2]

◆ eraseSspDepthPrecision() [2/2]

◆ eraseSspDepthSteps() [1/2]

◆ eraseSspDepthSteps() [2/2]

◆ eraseTotalRangeSteps() [1/2]

◆ eraseTotalRangeSteps() [2/2]

◆ eraseTotalTransmitters() [1/2]

◆ eraseTotalTransmitters() [2/2]

◆ eraseTxMaxDepthOffset() [1/2]

◆ eraseTxMaxDepthOffset() [2/2]

◆ eraseTxMinDepthOffset() [1/2]

◆ eraseTxMinDepthOffset() [2/2]

◆ getAltimetryType() [1/2]

◆ getAltimetryType() [2/2]

◆ getAngles() [1/2]

◆ getAngles() [2/2]

◆ getBathymetryMethod() [1/2]

◆ getBathymetryMethod() [2/2]

◆ getBathymetryType() [1/2]

◆ getBathymetryType() [2/2]

◆ getBeamOptions() [1/2]

◆ getBeamOptions() [2/2]

◆ getBellhopArrSyntax()

◆ getBellhopPath()

◆ getBellhopShdSyntax()

◆ getBhMode() [1/2]

◆ getBhMode() [2/2]

◆ getBoxDepth() [1/2]

◆ getBoxDepth() [2/2]

◆ getBoxRange() [1/2]

◆ getBoxRange() [2/2]

◆ getCustomTransducer() [1/2]

◆ getCustomTransducer() [2/2]

◆ getRaysNumber() [1/2]

◆ getRaysNumber() [2/2]