WossTest provides the framework for the WOSS library test binaries. More...

#include <woss-test.h>

Inheritance diagram for woss::WossTest:

Collaboration diagram for woss::WossTest:

Public Member Functions
	WossTest ()

virtual	~WossTest ()=default

	WossTest (const WossTest &copy)=delete

	WossTest (WossTest &&tmp)=delete

WossTest &	operator= (const WossTest &copy)=delete

WossTest &	operator= (WossTest &&tmp)=delete

void	run ()

WossTest &	setWossTestDebug (bool flag)

bool	getWossTestDebug () const

WossTest &	setWossRandomGenStream (int stream)

int	getWossRandomGenStream () const

WossTest &	setResDbCreatorDebug (bool flag)

bool	getResDbCreatorDebug () const

WossTest &	setResDbDebug (bool flag)

bool	getResDbDebug () const

WossTest &	setResDbUseBinary (bool flag)

bool	getResDbUseBinary () const

WossTest &	setResDbUseTimeArr (bool flag)

bool	getResDbUseTimeArr () const

WossTest &	setResDbUsePressure (bool flag)

bool	getResDbUsePressure () const

WossTest &	setResDbSpaceSampling (double sampling)

double	getResDbSpaceSampling () const

WossTest &	setResDbFilePath (const std::string &path)

std::string	getResDbFilePath () const

WossTest &	setResDbFileName (const std::string &file_name)

std::string	getResDbFileName () const

WossTest &	setSedimDeck41DbType (DECK41DbType type)

DECK41DbType	getSedimDeck41DbType () const

WossTest &	setSedimDbCreatorDebug (bool flag)

bool	getSedimDbCreatorDebug () const

WossTest &	setSedimDbDebug (bool flag)

bool	getSedimDbDebug () const

WossTest &	setSedimDbCoordFilePath (const std::string &path)

std::string	getSedimDbCoordFilePath () const

WossTest &	setSedimDbMarsdenFilePath (const std::string &path)

std::string	getSedimDbMarsdenFilePath () const

WossTest &	setSedimDbMarsdenOneFilePath (const std::string &path)

std::string	getSedimDbMarsdenOneFilePath () const

WossTest &	setSspDbCreatorDebug (bool flag)

bool	getSspDbCreatorDebug () const

WossTest &	setSspDbDebug (bool flag)

bool	getSspDbDebug () const

WossTest &	setSspDbFilePath (const std::string &path)

std::string	getSspDbFilePath () const

WossTest &	setSspWoaDbType (WOADbType type)

WOADbType	getSspWoaDbType () const

WossTest &	setBathyDbCreatorDebug (bool flag)

bool	getBathyDbCreatorDebug () const

WossTest &	setBathyDbDebug (bool flag)

bool	getBathyDbDebug () const

WossTest &	setBathyDbGebcoFormat (GEBCO_BATHY_TYPE type)

GEBCO_BATHY_TYPE	getBathyDbGebcoFormat () const

WossTest &	setBathyDbFilePath (const std::string &path)

std::string	getBathyDbFilePath () const

WossTest &	setWossDbManagerDebug (bool flag)

bool	getWossDbManagerDebug () const

WossTest &	setWossCreatorDebug (bool flag)

bool	getWossCreatorDebug () const

WossTest &	setWossDebug (bool flag)

bool	getWossDebug () const

WossTest &	setWossClearWorkDir (bool flag)

bool	getWossClearWorkDir () const

WossTest &	setWossEvolutionTimeQuantum (double time)

double	getWossEvolutionTimeQuantum () const

WossTest &	setWossTotalRuns (int runs)

int	getWossTotalRuns () const

WossTest &	setWossFrequencyStep (double step)

double	getWossFrequencyStep () const

WossTest &	setWossTotalRangeSteps (double step)

double	getWossTotalRangeSteps () const

WossTest &	setWossTxMinDepthOffset (double offset)

double	getWossTxMinDepthOffset () const

WossTest &	setWossTxMaxDepthOffset (double offset)

double	getWossTxMaxDepthOffset () const

WossTest &	setWossTotalTransmitters (int transmitters)

int	getWossTotalTransmitters () const

WossTest &	setWossTotalRxDepths (int rx_depths)

int	getWossTotalRxDepths () const

WossTest &	setWossRxMinDepthOffset (double offset)

double	getWossRxMinDepthOffset () const

WossTest &	setWossRxMaxDepthOffset (double offset)

double	getWossRxMaxDepthOffset () const

WossTest &	setWossTotalRxRanges (int rx_ranges)

int	getWossTotalRxRanges () const

WossTest &	setWossRxMinRangeOffset (double offset)

double	getWossRxMinRangeOffset () const

WossTest &	setWossRxMaxRangeOffset (double offset)

double	getWossRxMaxRangeOffset () const

WossTest &	setWossTotalRays (double rays)

double	getWossTotalRays () const

WossTest &	setWossMinAngle (double angle)

double	getWossMinAngle () const

WossTest &	setWossMaxAngle (double angle)

double	getWossMaxAngle () const

WossTest &	setWossUseThorpeAtt (bool flag)

bool	getWossUseThorpeAtt () const

WossTest &	setWossSspDepthPrecision (double precision)

double	getWossSspDepthPrecision () const

WossTest &	setWossNormalizedSspDepthSteps (double steps)

double	getWossNormalizedSspDepthSteps () const

WossTest &	setWossWorkDirPath (const std::string &path)

std::string	getWossWorkDirPath () const

WossTest &	setWossBellhopPath (const std::string &path)

std::string	getWossBellhopPath () const

WossTest &	setWossBellhopMode (const std::string &mode)

std::string	getWossBellhopMode () const

WossTest &	setWossBellhopBeamOptions (const std::string &options)

std::string	getWossBellhopBeamOptions () const

WossTest &	setWossBellhopBathyType (const std::string &type)

std::string	getWossBellhopBathyType () const

WossTest &	setWossBellhopBathyMethod (const std::string &type)

std::string	getWossBellhopBathyMethod () const

WossTest &	setWossBellhopAltimType (const std::string &type)

std::string	getWossBellhopAltimType () const

WossTest &	setWossBellhopArraySyntax (BellhopArrSyntax syntax)

BellhopArrSyntax	getWossBellhopArraySyntax () const

WossTest &	setWossBellhopShdSyntax (BellhopShdSyntax syntax)

BellhopShdSyntax	getWossBellhopShdSyntax () const

WossTest &	setWossSimTime (const SimTime &time)

SimTime	getWossSimTime () const

WossTest &	setWossBoxDepth (double depth)

double	getWossBoxDepth () const

WossTest &	setWossBoxRange (double range)

double	getWossBoxRange () const

WossTest &	setWossManagerDebug (bool flag)

bool	getWossManagerDebug () const

WossTest &	setWossManagerTimeEvoActive (bool flag)

bool	getWossManagerTimeEvoActive () const

WossTest &	setWossManagerThreads (unsigned int threads)

int	getWossManagerThreads () const

WossTest &	setWossManagerSpaceSampling (double sampling)

double	getWossManagerSpaceSampling () const

WossTest &	setWossManagerUseMultiThread (bool flag)

bool	getWossManagerUseMultiThread () const

WossTest &	setWossManagerUseThreadPool (bool flag)

bool	getWossManagerUseThreadPool () const

WossTest &	setWossTransducerHandlerDebug (bool flag)

bool	getWossTransducerHandlerDebug () const

WossTest &	setWossControllerDebug (bool flag)

bool	getWossControllerDebug () const

Protected Member Functions
void	config ()

void	init ()

virtual void	doConfig ()=0

virtual void	doInit ()=0

virtual void	doRun ()=0

Protected Attributes
bool	debug
	debug flag

std::unique_ptr< SSP >	ssp_proto
	SSP prototype which will be plugged into the WOSS framework.

std::unique_ptr< Sediment >	sediment_proto
	Sediment prototype which will be plugged into the WOSS framework.

std::unique_ptr< Pressure >	pressure_proto
	Pressure prototype which will be plugged into the WOSS framework.

std::unique_ptr< TimeArr >	time_arr_proto
	TimeArr prototype which will be plugged into the WOSS framework.

std::unique_ptr< Transducer >	transducer_proto
	Transducer prototype which will be plugged into the WOSS framework.

std::unique_ptr< AltimBretschneider >	altim_bret_proto
	AltimBretschneider prototype which will be plugged into the WOSS framework.

std::unique_ptr< Location >	location_proto
	Location prototype which will be plugged into the WOSS framework.

int	woss_random_gen_stream
	random generator used by the WOSS framework.

std::unique_ptr< RandomGenerator >	random_gen_proto
	RandomGenerator prototype which will be plugged into the WOSS framework.

std::unique_ptr< TimeReference >	time_ref_proto
	TimeReference prototype which will be plugged into the WOSS framework.

DefHandler &	def_handler
	Definition Handler object allocated by the helper.

bool	res_db_creator_debug
	enable/disable the debug prints of the woss results database creator.

bool	res_db_debug
	enable/disable the debug prints of the woss result databases.

bool	res_db_use_binary
	set up the woss result database format: binary or textual.

bool	res_db_use_time_arr
	set up the woss result databases data format: power delay profile.

bool	res_db_use_pressure
	set up the woss result databases data format: single pressure tap.

double	res_db_space_sampling
	set up the woss result database 2D spatial sampling

std::string	res_db_file_path
	set up the woss result database file path

std::string	res_db_file_name
	set up the woss result database file name (without path)

std::shared_ptr< ResPressureBinDbCreator >	res_db_creator_press_bin
	the helper will automatically allocate the desired result database creator based on current configuration.

std::shared_ptr< ResPressureTxtDbCreator >	res_db_creator_press_txt
	the helper will automatically allocate the desired result database creator based on current configuration.

std::shared_ptr< ResTimeArrBinDbCreator >	res_db_creator_time_arr_bin
	the helper will automatically allocate the desired result database creator based on current configuration.

std::shared_ptr< ResTimeArrTxtDbCreator >	res_db_creator_time_arr_txt
	the helper will automatically allocate the desired result database creator based on current configuration.

DECK41DbType	sedim_deck41_db_type
	DECK41 db data format type.

bool	sedim_db_creator_debug
	enable/disable the debug prints of the woss sediment database creator.

bool	sedim_db_debug
	enable/disable the debug prints of the woss sediment database.

std::string	sedim_db_coord_file_path
	setup the path of the sediment database indexed by geographical coordinates with decimal degrees resolution

std::string	sedim_db_marsden_file_path
	setup the path of the sediment database indexed by geographical coordinates with marsden square resolution

std::string	sedim_db_marsden_one_file_path
	setup the path of the sediment database indexed by geographical coordinates with marsden one square resolution

std::shared_ptr< SedimDeck41DbCreator >	sedim_db_creator
	the helper will automatically allocate the woss sediment database creator

bool	ssp_db_creator_debug
	enable/disable the debug prints of the woss SSP database creator.

bool	ssp_db_debug
	enable/disable the debug prints of the woss SSP database.

std::string	ssp_db_file_path
	setup the path of the woss monthly SSP database indexed by geographical coordinates

WOADbType	ssp_woa_db_type
	WOA SSP Db Type.

std::shared_ptr< SspWoa2005DbCreator >	ssp_db_creator
	the helper will automatically allocate the woss sediment database creator

bool	bathy_db_creator_debug
	enable/disable the debug prints of the woss Bathymetry database creator.

bool	bathy_db_debug
	enable/disable the debug prints of the woss Bathymetry database (GEBCO).

GEBCO_BATHY_TYPE	bathy_db_gebco_format
	setup the the GEBCO database format

std::string	bathy_db_file_path
	setup the path of the woss GEBCO database

std::shared_ptr< BathyGebcoDbCreator >	bathy_db_creator
	the helper will automatically allocate the woss GEBCO bathymetry db creator

bool	woss_db_manager_debug
	enable/disable the debug prints of the woss DB manager object.

std::shared_ptr< WossDbManager >	woss_db_manager
	the helper will automatically allocate the woss DB manager

bool	woss_creator_debug
	enable/disable the debug prints of the woss creator.

bool	woss_debug
	enable/disable the debug prints of all woss objects

bool	woss_clear_work_dir
	woss object configuration: clear the temporary files created by the underlying channel simulator

double	evolution_time_quantum
	woss object configuration: evolution time quantum

int	total_runs
	woss object configuration: total number of channel simulator runs

double	frequency_step
	woss object configuration: number of frequency steps

double	total_range_steps
	woss object configuration: tx - rx range sampling in meters

double	tx_min_depth_offset
	woss object configuration: transmitter min offset in meters

double	tx_max_depth_offset
	woss object configuration: transmitter max offset in meters

int	total_transmitters
	woss object configuration: total number of transmitting sources

int	total_rx_depths
	woss object configuration: receiver depth sampling

double	rx_min_depth_offset
	woss object configuration: receiver min depth offset in meters

double	rx_max_depth_offset
	woss object configuration: receiver max depth offset in meters

int	total_rx_ranges
	woss object configuration: receiver range sampling

double	rx_min_range_offset
	woss object configuration: receiver min range offset in meters

double	rx_max_range_offset
	woss object configuration: receiver max range offset in meters

double	total_rays
	woss object configuration: total number of rays (0 = automatic)

double	min_angle
	woss object configuration: minimum vertical angle in decimal degrees

double	max_angle
	woss object configuration: maximum vertical angle in decimal degrees

bool	use_thorpe_att
	woss object configuration: use thorpe attenuation in channel computation

double	ssp_depth_precision
	woss object configuration: SSP depth precision in meters

double	normalized_ssp_depth_steps
	woss object configuration: SSP depth quantization steps

std::string	work_dir_path
	woss object configuration: path of the temporary directory

std::string	bellhop_path
	woss object configuration: path of the Bellhop executable

std::string	bellhop_mode
	woss object configuration: Bellhop mode string

std::string	bellhop_beam_options
	woss object configuration: Bellhop beam option string

std::string	bellhop_bathy_type
	woss object configuration: Bellhop bathymetry type string

std::string	bellhop_bathy_method
	woss object configuration: Bathymetry write method string

std::string	bellhop_altim_type
	woss object configuration: Bellhop Altimetry type string

BellhopArrSyntax	bellhop_arr_syntax
	woss object configration: Bellhop Arr file syntax to be used during .arr file parsing

BellhopShdSyntax	bellhop_shd_syntax
	woss object configration: Bellhop Shd file syntax to be used during .shd file parsing

SimTime	sim_time
	woss object configuration: woss simulation times (start and end sim times)

std::shared_ptr< BellhopCreator >	bellhop_creator
	the helper will automatically allocate the woss creator

double	box_depth
	woss object configuration: maximum depth to trace rays to; deeper rays will be ignored

double	box_range
	woss object configuration: maximum range to trace rats to; longer rays will be ignored

bool	woss_manager_debug
	enable/disable the debug prints of the woss manager.

bool	time_evolution_active
	enable/disable the time evolution feature.

unsigned int	concurrent_threads
	number of concurrent threads (0 = auto).

double	woss_manager_space_sampling
	woss manager space sampling in meters

bool	woss_manager_use_multithread
	enable/disable the multithread feature

bool	woss_manager_use_thread_pool
	enable/disable woss::ThreadPool usage

std::shared_ptr< WossManagerSimple< WossManagerResDb > >	woss_manager_simple
	the helper will automatically allocate the desired woss manager based on current configuration.

std::shared_ptr< WossManagerSimple< WossManagerResDbMT > >	woss_manager_multi
	the helper will automatically allocate the desired woss manaeger based on current configuration.

bool	woss_transducer_handler_debug
	enable/disable the debug prints of the woss transducer handler.

std::shared_ptr< TransducerHandler >	woss_transducer_handler
	the helper will automatically allocate the woss Transducer handler.

bool	woss_controller_debug
	enable/disable the debug prints of the woss conteroller

std::shared_ptr< WossController >	woss_controller
	the helper will automatically allocate the woss controller.

bool	initialized
	initialization complete flag.

Detailed Description

WossTest provides the framework for the WOSS library test binaries.

WossTest provides the framework for the WOSS library test binaries

Constructor & Destructor Documentation

◆ WossTest() [1/3]

WossTest::WossTest ( )

default constructor

References altim_bret_proto, def_handler, location_proto, pressure_proto, sediment_proto, woss::DefHandler::setAltimetry(), woss::DefHandler::setLocation(), woss::DefHandler::setPressure(), woss::DefHandler::setSediment(), woss::DefHandler::setSSP(), woss::DefHandler::setTimeArr(), woss::DefHandler::setTimeReference(), woss::DefHandler::setTransducer(), ssp_proto, time_arr_proto, time_ref_proto, and transducer_proto.

Here is the call graph for this function:

◆ ~WossTest()

virtual woss::WossTest::~WossTest ( )

virtualdefault

◆ WossTest() [2/3]

woss::WossTest::WossTest ( const WossTest & copy )

delete

Deleted copy constructor

Parameters

copy	const reference to a WossTest object

◆ WossTest() [3/3]

woss::WossTest::WossTest ( WossTest && tmp )

delete

Deleted move constructor

Parameters

tmp	rvalue reference to a WossTest object

Member Function Documentation

◆ config()

void WossTest::config ( )

protected

Perform the configuration phase. Must be run before the initialization phase.

References doConfig().

Referenced by run().

Here is the call graph for this function:

◆ doConfig()

virtual void woss::WossTest::doConfig ( )

protectedpure virtual

Virtual function that allows the derived class to perform its custom configuration phase

Implemented in WossBellhopScript, WossBellhopTest, and WossCoordDefTest.

Referenced by config().

◆ doInit()

virtual void woss::WossTest::doInit ( )

protectedpure virtual

Virtual function that allows the derived class to perform its custom initialization phase

Implemented in WossBellhopScript, WossBellhopTest, and WossCoordDefTest.

Referenced by init().

◆ doRun()

virtual void woss::WossTest::doRun ( )

protectedpure virtual

Virtual function that allows the derived class to perform its custom run phase

Implemented in WossBellhopScript, WossBellhopTest, and WossCoordDefTest.

Referenced by run().

◆ getBathyDbCreatorDebug()

bool woss::WossTest::getBathyDbCreatorDebug ( ) const

inline

Gets the BathyGebcoDbCreator debug flag

Returns: debug boolean value

References bathy_db_creator_debug.

◆ getBathyDbDebug()

bool woss::WossTest::getBathyDbDebug ( ) const

inline

Gets the Bathy Db debug flag

Returns: debug boolean value

References bathy_db_debug.

◆ getBathyDbFilePath()

std::string woss::WossTest::getBathyDbFilePath ( ) const

inline

Gets the Bathy Db file path

Parameters

path	path to db file

Returns: string containing the path to Bathy Db file

References bathy_db_file_path.

◆ getBathyDbGebcoFormat()

GEBCO_BATHY_TYPE woss::WossTest::getBathyDbGebcoFormat ( ) const

inline

Gets the Bathy Db GEBCO_BATHY_TYPE format type

Returns: GEBCO_BATHY_TYPE of the file db path

References bathy_db_gebco_format.

◆ getResDbCreatorDebug()

bool woss::WossTest::getResDbCreatorDebug ( ) const

inline

Gets the Result Db Creator debug flag

Returns: debug flag

References res_db_creator_debug.

◆ getResDbDebug()

bool woss::WossTest::getResDbDebug ( ) const

inline

Gets the Result Db debug flag

Returns: debug flag

References res_db_debug.

◆ getResDbFileName()

std::string woss::WossTest::getResDbFileName ( ) const

inline

Gets the ResDb'file name

Returns: file name

References res_db_file_name.

◆ getResDbFilePath()

std::string woss::WossTest::getResDbFilePath ( ) const

inline

Gets the ResDb'file path

Returns: file path

References res_db_file_path.

◆ getResDbSpaceSampling()

double woss::WossTest::getResDbSpaceSampling ( ) const

inline

Gets the ResDb's space sampling

Returns: space sampling in [m]

References res_db_space_sampling.

◆ getResDbUseBinary()

bool woss::WossTest::getResDbUseBinary ( ) const

inline

Gets the use binary flag

Returns: use binary flag

References res_db_use_binary.

◆ getResDbUsePressure()

bool woss::WossTest::getResDbUsePressure ( ) const

inline

Gets the res db pressure flag

Returns: use Pressure flag

References res_db_use_pressure.

◆ getResDbUseTimeArr()

bool woss::WossTest::getResDbUseTimeArr ( ) const

inline

Gets the time arrival flag

Returns: use TimeArrival flag

References res_db_use_time_arr.

◆ getSedimDbCoordFilePath()

std::string woss::WossTest::getSedimDbCoordFilePath ( ) const

inline

Gets the Sediment DECK41 Db indexed by coordinates path

Returns: string containing the file path

References sedim_db_coord_file_path.

◆ getSedimDbCreatorDebug()

bool woss::WossTest::getSedimDbCreatorDebug ( ) const

inline

Gets the SedimDeck41DbCreator debug flag

Returns: debug boolean value

References sedim_db_creator_debug.

◆ getSedimDbDebug()

bool woss::WossTest::getSedimDbDebug ( ) const

inline

Gets the Sediment db debug flag

Returns: debug boolean value

References sedim_db_debug.

◆ getSedimDbMarsdenFilePath()

std::string woss::WossTest::getSedimDbMarsdenFilePath ( ) const

inline

Gets the Sediment DECK41 Db indexed by Marsden squares file path

Returns: string containing the file path

References sedim_db_marsden_file_path.

◆ getSedimDbMarsdenOneFilePath()

std::string woss::WossTest::getSedimDbMarsdenOneFilePath ( ) const

inline

Gets the Sediment DECK41 Db indexed by Marsden one squares file path

Returns: string containing the file path

References sedim_db_marsden_one_file_path.

◆ getSedimDeck41DbType()

DECK41DbType woss::WossTest::getSedimDeck41DbType ( ) const

inline

Gets the DECK41DbType db type

Returns: DECK41DbType db type

References sedim_deck41_db_type.

◆ getSspDbCreatorDebug()

bool woss::WossTest::getSspDbCreatorDebug ( ) const

inline

Gets the SspWoa2005DbCreator debug flag

Returns: boolean debug flag value

References ssp_db_creator_debug.

◆ getSspDbDebug()

bool woss::WossTest::getSspDbDebug ( ) const

inline

Gets the Ssp Db debug flag

Returns: boolean debug flag value

References ssp_db_debug.

◆ getSspDbFilePath()

std::string woss::WossTest::getSspDbFilePath ( ) const

inline

Gets the SSP Db file path

Returns: string containing the path to db file

References ssp_db_file_path.

◆ getSspWoaDbType()

WOADbType woss::WossTest::getSspWoaDbType ( ) const

inline

Gets the SSP Db WOADbType type

Returns: WOADbType of the db path

References ssp_woa_db_type.

◆ getWossBellhopAltimType()

std::string woss::WossTest::getWossBellhopAltimType ( ) const

inline

Gets the Woss channel simulator bellhop altimetry type

Returns: bellhop altimetry type

References bellhop_altim_type.

◆ getWossBellhopArraySyntax()

BellhopArrSyntax woss::WossTest::getWossBellhopArraySyntax ( ) const

inline

Gets the Woss channel bellhop array model result syntax

Returns: bellhop array model result syntax

References bellhop_arr_syntax.

◆ getWossBellhopBathyMethod()

std::string woss::WossTest::getWossBellhopBathyMethod ( ) const

inline

Gets the Woss channel simulator bellhop bathymetry method

Returns: bellhop bathymetry method

References bellhop_bathy_method.

◆ getWossBellhopBathyType()

std::string woss::WossTest::getWossBellhopBathyType ( ) const

inline

Gets the Woss channel simulator bellhop bathymetry type

Returns: bellhop bathymetry type

References bellhop_bathy_type.

◆ getWossBellhopBeamOptions()

std::string woss::WossTest::getWossBellhopBeamOptions ( ) const

inline

Gets the Woss channel simulator bellhop beam options

Returns: bellhop beam options

References bellhop_beam_options.

◆ getWossBellhopMode()

std::string woss::WossTest::getWossBellhopMode ( ) const

inline

Gets the Woss channel simulator bellhop running mode

Returns: bellhop running mode

References bellhop_mode.

◆ getWossBellhopPath()

std::string woss::WossTest::getWossBellhopPath ( ) const

inline

Gets the Woss channel simulator bellhop executable file path

Returns: a string containing the path of the bellhop executable file

References bellhop_path.

◆ getWossBellhopShdSyntax()

BellhopShdSyntax woss::WossTest::getWossBellhopShdSyntax ( ) const

inline

Gets the Woss channel bellhop pressure model result syntax

Returns: bellhop pressure model result syntax

References bellhop_shd_syntax.

◆ getWossBoxDepth()

double woss::WossTest::getWossBoxDepth ( ) const

inline

Gets the Woss channel simulation box max depth

Returns: simulation box max depth [m]

References box_depth.

◆ getWossBoxRange()

double woss::WossTest::getWossBoxRange ( ) const

inline

Gets the Woss channel simulation box max range

Returns: simulation box max range [m]

References box_range.

◆ getWossClearWorkDir()

bool woss::WossTest::getWossClearWorkDir ( ) const

inline

Gets the Woss clean dir flag., if the Woss channel simulator working dir should be freed or kept

Returns: clean work dir boolean flag

References woss_clear_work_dir.

◆ getWossControllerDebug()

bool woss::WossTest::getWossControllerDebug ( ) const

inline

Gets the WossController debug flag

Returns: debug flag

References woss_controller_debug.

◆ getWossCreatorDebug()

bool woss::WossTest::getWossCreatorDebug ( ) const

inline

Gets the WossCreator debug flag

Returns: boolean debug flag

References woss_creator_debug.

◆ getWossDbManagerDebug()

bool woss::WossTest::getWossDbManagerDebug ( ) const

inline

Gets the WossDbManager debug flag

Returns: boolean debug flag

References woss_db_manager_debug.

◆ getWossDebug()

bool woss::WossTest::getWossDebug ( ) const

inline

Gets the Woss channel simulator debug flag

Returns: boolean debug flag

References woss_debug.

◆ getWossEvolutionTimeQuantum()

double woss::WossTest::getWossEvolutionTimeQuantum ( ) const

inline

Gets the Woss channel simulator time quantum which is used by time dependent simulations

Returns: evolution time quantum of the channel model, in [s]

References evolution_time_quantum.

◆ getWossFrequencyStep()

double woss::WossTest::getWossFrequencyStep ( ) const

inline

Gets the Woss channel simulator frequencies frequency steps

Returns: frequency step in [hZ]

References frequency_step.

◆ getWossManagerDebug()

bool woss::WossTest::getWossManagerDebug ( ) const

inline

Gets the WossManager debug flag

Returns: debug flag

References woss_manager_debug.

◆ getWossManagerSpaceSampling()

double woss::WossTest::getWossManagerSpaceSampling ( ) const

inline

Gets the WossManager space sampling

Returns: space sampling in [m]

References woss_manager_space_sampling.

◆ getWossManagerThreads()

int woss::WossTest::getWossManagerThreads ( ) const

inline

Gets the WossManager number of threads

Returns: number of threads

References concurrent_threads.

◆ getWossManagerTimeEvoActive()

bool woss::WossTest::getWossManagerTimeEvoActive ( ) const

inline

Gets the WossManager time evolution feature active

Returns: time evolution active flag

References time_evolution_active.

◆ getWossManagerUseMultiThread()

bool woss::WossTest::getWossManagerUseMultiThread ( ) const

inline

Gets the WossManager multithread flag

Returns: use multithread flag

References woss_manager_use_multithread.

◆ getWossManagerUseThreadPool()

bool woss::WossTest::getWossManagerUseThreadPool ( ) const

inline

Gets the WossManager thread pool flag

Returns: use thread pool flag

References woss_manager_use_thread_pool.

◆ getWossMaxAngle()

double woss::WossTest::getWossMaxAngle ( ) const

inline

Gets the Woss channel simulator ray tracing maximum angle

Returns: ray tracing maximum angle [decimal degree]

References max_angle.

◆ getWossMinAngle()

double woss::WossTest::getWossMinAngle ( ) const

inline

Gets the Woss channel simulator ray tracing mimimum angle

Returns: ray tracing mimimum angle [decimal degree]

References min_angle.

◆ getWossNormalizedSspDepthSteps()

double woss::WossTest::getWossNormalizedSspDepthSteps ( ) const

inline

Gets the Woss channel simulator normalized depth steps

Returns: normalized SSP depth steps

References normalized_ssp_depth_steps.

◆ getWossRandomGenStream()

int woss::WossTest::getWossRandomGenStream ( ) const

inline

Gets the woss::RandomGenerator stream/seed value

Returns: seed/stream value

References woss_random_gen_stream.

◆ getWossRxMaxDepthOffset()

double woss::WossTest::getWossRxMaxDepthOffset ( ) const

inline

Gets the Woss channel simulator receiver maximum depth offset

Returns: receiver maximum depth offset in [m]

References rx_max_depth_offset.

◆ getWossRxMaxRangeOffset()

double woss::WossTest::getWossRxMaxRangeOffset ( ) const

inline

Gets the Woss channel simulator receiver maximum range offset

Returns: receiver maximum range offset [m]

References rx_max_range_offset.

◆ getWossRxMinDepthOffset()

double woss::WossTest::getWossRxMinDepthOffset ( ) const

inline

Gets the Woss channel simulator receiver mimimum depth offset

Returns: receiver mimimum depth offset in [m]

References rx_min_depth_offset.

◆ getWossRxMinRangeOffset()

double woss::WossTest::getWossRxMinRangeOffset ( ) const

inline

Gets the Woss channel simulator receiver mimimum range offset

Returns: receiver mimimum range offset [m]

References rx_min_range_offset.

◆ getWossSimTime()

SimTime woss::WossTest::getWossSimTime ( ) const

inline

Gets the Woss channel SimTime

Returns: simulation times

References sim_time.

◆ getWossSspDepthPrecision()

double woss::WossTest::getWossSspDepthPrecision ( ) const

inline

Gets the Woss channel simulator SSP depth precision

Parameters

precision SSP depth precision in [m]

Returns: reference to this instance

References ssp_depth_precision.

◆ getWossTestDebug()

bool woss::WossTest::getWossTestDebug ( ) const

inline

gets the WossTest object debug flag

Returns: debug flag

References debug.

Referenced by main().

◆ getWossTotalRangeSteps()

double woss::WossTest::getWossTotalRangeSteps ( ) const

inline

Gets the Woss channel simulator range steps that should be used The steps are applied between the tx and rx distance.

Returns: number of range steps

References total_range_steps.

◆ getWossTotalRays()

double woss::WossTest::getWossTotalRays ( ) const

inline

Gets the Woss channel simulator number of ray traces

Returns: total number of ray traces

References total_rays.

◆ getWossTotalRuns()

int woss::WossTest::getWossTotalRuns ( ) const

inline

Gets the Woss channel simulator total realizations number. Each run is based on random perturbation of the input data.

Returns: number of total runs to be executed

References total_runs.

◆ getWossTotalRxDepths()

int woss::WossTest::getWossTotalRxDepths ( ) const

inline

Gets the Woss channel simulator number of receiver depth points

Returns: number of receiver depth points

References total_rx_depths.

◆ getWossTotalRxRanges()

int woss::WossTest::getWossTotalRxRanges ( ) const

inline

Gets the Woss channel simulator receiver number of range points

Returns: receiver range point number

References total_rx_ranges.

◆ getWossTotalTransmitters()

int woss::WossTest::getWossTotalTransmitters ( ) const

inline

Gets the Woss channel simulator number of transmitters

Returns: number of transmitters

References total_transmitters.

◆ getWossTransducerHandlerDebug()

bool woss::WossTest::getWossTransducerHandlerDebug ( ) const

inline

Gets the WossTransducerHander debug flag

Returns: debug flag

References woss_transducer_handler_debug.

◆ getWossTxMaxDepthOffset()

double woss::WossTest::getWossTxMaxDepthOffset ( ) const

inline

Gets the Woss channel simulator transmitter maximum depth offset

Returns: maximum depth offset in [m]

References tx_max_depth_offset.

◆ getWossTxMinDepthOffset()

double woss::WossTest::getWossTxMinDepthOffset ( ) const

inline

Gets the Woss channel simulator transmitter minimum depth offset

Returns: minimum depth offset in [m]

References tx_min_depth_offset.

◆ getWossUseThorpeAtt()

bool woss::WossTest::getWossUseThorpeAtt ( ) const

inline

Gets the Thorpe attenuation model flag

Returns: Thorpe attenuation model flag

References use_thorpe_att.

◆ getWossWorkDirPath()

std::string woss::WossTest::getWossWorkDirPath ( ) const

inline

Gets the Woss channel simulator work directory path

Returns: a string containing the path of the work directory

References work_dir_path.

◆ init()

void WossTest::init ( )

protected

Performs the initialization phase. Must be called after the configuration phase.

References bathy_db_creator, bathy_db_creator_debug, bathy_db_debug, bathy_db_file_path, bathy_db_gebco_format, bellhop_altim_type, bellhop_arr_syntax, bellhop_bathy_method, bellhop_bathy_type, bellhop_beam_options, bellhop_creator, bellhop_mode, bellhop_path, bellhop_shd_syntax, box_depth, box_range, concurrent_threads, debug, def_handler, doInit(), woss::SimTime::end_time, evolution_time_quantum, frequency_step, initialized, woss::Time::isValid(), max_angle, min_angle, normalized_ssp_depth_steps, random_gen_proto, res_db_creator_debug, res_db_creator_press_bin, res_db_creator_press_txt, res_db_creator_time_arr_bin, res_db_creator_time_arr_txt, res_db_debug, res_db_file_name, res_db_file_path, res_db_use_binary, res_db_use_pressure, res_db_use_time_arr, rx_max_depth_offset, rx_max_range_offset, rx_min_depth_offset, rx_min_range_offset, sedim_db_coord_file_path, sedim_db_creator, sedim_db_creator_debug, sedim_db_debug, sedim_db_marsden_file_path, sedim_db_marsden_one_file_path, sedim_deck41_db_type, woss::DefHandler::setRandGenerator(), sim_time, ssp_db_creator, ssp_db_creator_debug, ssp_db_debug, ssp_db_file_path, ssp_depth_precision, woss::SimTime::start_time, time_evolution_active, total_range_steps, total_rays, total_runs, total_rx_depths, total_rx_ranges, total_transmitters, tx_max_depth_offset, tx_min_depth_offset, use_thorpe_att, work_dir_path, woss_clear_work_dir, woss_controller, woss_creator_debug, woss_db_manager, woss_db_manager_debug, woss_debug, woss::WOSS_ERROR_UNKNOWN, woss_manager_debug, woss_manager_multi, woss_manager_simple, woss_manager_space_sampling, woss_manager_use_multithread, woss_manager_use_thread_pool, woss_random_gen_stream, woss_transducer_handler, and woss_transducer_handler_debug.

Referenced by run().

Here is the call graph for this function:

◆ operator=() [1/2]

WossTest & woss::WossTest::operator= ( const WossTest & copy )

delete

Deleted move assignement operator

Parameters

copy	rvalue reference to a WossTest object

◆ operator=() [2/2]

WossTest & woss::WossTest::operator= ( WossTest && tmp )

delete

Deleted assignement operator

Parameters

tmp	const reference to a WossTest object

◆ run()

void WossTest::run ( )

Runs the current test. Must be called after the configuration phase and the initialization phase.

References config(), doRun(), init(), and woss::WossException::printAndExit().

Referenced by main().

Here is the call graph for this function:

◆ setBathyDbCreatorDebug()

WossTest & woss::WossTest::setBathyDbCreatorDebug ( bool flag )

inline

Sets the BathyGebcoDbCreator debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References bathy_db_creator_debug.

◆ setBathyDbDebug()

WossTest & woss::WossTest::setBathyDbDebug ( bool flag )

inline

Sets the Bathy Db debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References bathy_db_debug.

◆ setBathyDbFilePath()

WossTest & woss::WossTest::setBathyDbFilePath ( const std::string & path )

inline

Sets the Bathy Db file path

Parameters

path	path to db file

Returns: reference to this instance

References bathy_db_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setBathyDbGebcoFormat()

WossTest & woss::WossTest::setBathyDbGebcoFormat ( GEBCO_BATHY_TYPE type )

inline

Sets the Bathy Db GEBCO_BATHY_TYPE format type

Parameters

type	GEBCO_BATHY_TYPE of the file db path

Returns: reference to this instance

References bathy_db_gebco_format.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbCreatorDebug()

WossTest & woss::WossTest::setResDbCreatorDebug ( bool flag )

inline

Sets the Result Db Creator debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References res_db_creator_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbDebug()

WossTest & woss::WossTest::setResDbDebug ( bool flag )

inline

Sets the Result Db debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References res_db_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbFileName()

WossTest & woss::WossTest::setResDbFileName ( const std::string & file_name )

inline

Sets the ResDb file name

Parameters

path file name

Returns: reference to this instance

References res_db_file_name.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbFilePath()

WossTest & woss::WossTest::setResDbFilePath ( const std::string & path )

inline

Sets the ResDb'file path

Parameters

path file path

Returns: reference to this instance

References res_db_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbSpaceSampling()

WossTest & woss::WossTest::setResDbSpaceSampling ( double sampling )

inline

Sets the ResDb's space sampling

Parameters

sampling space sampling in [m]

Returns: reference to this instance

References res_db_space_sampling.

◆ setResDbUseBinary()

WossTest & woss::WossTest::setResDbUseBinary ( bool flag )

inline

If set to true, it will use the ResDb binary format classes

Parameters

flag	use binary flag

Returns: reference to this instance

References res_db_use_binary.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbUsePressure()

WossTest & woss::WossTest::setResDbUsePressure ( bool flag )

inline

If set to true, it will use the ResDb Pressure format classes If set to false, it will use the ResDb Pressure format classes

Parameters

flag	use Pressure flag

Returns: reference to this instance

References res_db_use_pressure.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setResDbUseTimeArr()

WossTest & woss::WossTest::setResDbUseTimeArr ( bool flag )

inline

If set to true, it will use the ResDb TimeArrival format classes If set to false, it will use the ResDb Pressure format classes

Parameters

flag	use TimeArrival flag

Returns: reference to this instance

References res_db_use_time_arr.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSedimDbCoordFilePath()

WossTest & woss::WossTest::setSedimDbCoordFilePath ( const std::string & path )

inline

Sets the Sediment DECK41 Db indexed by coordinates

Parameters

path	path to db file

Returns: reference to this instance

References sedim_db_coord_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSedimDbCreatorDebug()

WossTest & woss::WossTest::setSedimDbCreatorDebug ( bool flag )

inline

Sets the SedimDeck41DbCreator debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References sedim_db_creator_debug.

◆ setSedimDbDebug()

WossTest & woss::WossTest::setSedimDbDebug ( bool flag )

inline

Sets the Sediment db debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References sedim_db_debug.

◆ setSedimDbMarsdenFilePath()

WossTest & woss::WossTest::setSedimDbMarsdenFilePath ( const std::string & path )

inline

Sets the Sediment DECK41 Db indexed by Marsden square file path

Parameters

path	path to db file

Returns: reference to this instance

References sedim_db_marsden_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSedimDbMarsdenOneFilePath()

WossTest & woss::WossTest::setSedimDbMarsdenOneFilePath ( const std::string & path )

inline

Sets the Sediment DECK41 Db indexed by Marsden one squares file path

Parameters

path	path to db file

Returns: reference to this instance

References sedim_db_marsden_one_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSedimDeck41DbType()

WossTest & woss::WossTest::setSedimDeck41DbType ( DECK41DbType type )

inline

Sets the DECK41DbType db type

Parameters

type	DECK41DbType type

Returns: reference to this instance

References sedim_deck41_db_type.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSspDbCreatorDebug()

WossTest & woss::WossTest::setSspDbCreatorDebug ( bool flag )

inline

Sets the SspWoa2005DbCreator debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References ssp_db_creator_debug.

◆ setSspDbDebug()

WossTest & woss::WossTest::setSspDbDebug ( bool flag )

inline

Sets the SSP Db debug flag

Parameters

flag	debug boolean value

Returns: reference to this instance

References ssp_db_debug.

◆ setSspDbFilePath()

WossTest & woss::WossTest::setSspDbFilePath ( const std::string & path )

inline

Sets the SSP Db file path

Parameters

path	path to db file

Returns: reference to this instance

References ssp_db_file_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setSspWoaDbType()

WossTest & woss::WossTest::setSspWoaDbType ( WOADbType type )

inline

Sets the SSP Db WOADbType type

Parameters

type	WOADbType of the db path

Returns: reference to this instance

References ssp_woa_db_type.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopAltimType()

WossTest & woss::WossTest::setWossBellhopAltimType ( const std::string & type )

inline

Configures the Woss channel bellhop altimetry type

Parameters

mode	bellhop altimetry type

Returns: reference to this instance

References bellhop_altim_type.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopArraySyntax()

WossTest & woss::WossTest::setWossBellhopArraySyntax ( BellhopArrSyntax syntax )

inline

Configures the Woss channel bellhop array model result syntax

Parameters

BellhopArrSyntax bellhop array model result syntax

Returns: reference to this instance

References bellhop_arr_syntax.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopBathyMethod()

WossTest & woss::WossTest::setWossBellhopBathyMethod ( const std::string & type )

inline

Configures the Woss channel bellhop bathymetry method

Parameters

mode	bellhop bathymetry method

Returns: reference to this instance

References bellhop_bathy_method.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopBathyType()

WossTest & woss::WossTest::setWossBellhopBathyType ( const std::string & type )

inline

Configures the Woss channel bellhop bathymetry type

Parameters

mode	bellhop bathymetry type

Returns: reference to this instance

References bellhop_bathy_type.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopBeamOptions()

WossTest & woss::WossTest::setWossBellhopBeamOptions ( const std::string & options )

inline

Configures the Woss channel bellhop beam options

Parameters

mode	bellhop beam options

Returns: reference to this instance

References bellhop_beam_options.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopMode()

WossTest & woss::WossTest::setWossBellhopMode ( const std::string & mode )

inline

Configures the Woss channel bellhop running mode

Parameters

mode	bellhop running mode

Returns: reference to this instance

References bellhop_mode.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBellhopPath()

WossTest & woss::WossTest::setWossBellhopPath ( const std::string & path )

inline

Configures the Woss channel bellhop executable file path

Parameters

path	bellhop executable file path

Returns: reference to this instance

References bellhop_path.

◆ setWossBellhopShdSyntax()

WossTest & woss::WossTest::setWossBellhopShdSyntax ( BellhopShdSyntax syntax )

inline

Configures the Woss channel bellhop pressure model result syntax

Parameters

BellhopShdSyntax bellhop pressure model result syntax

Returns: reference to this instance

References bellhop_shd_syntax.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBoxDepth()

WossTest & woss::WossTest::setWossBoxDepth ( double depth )

inline

Configures the Woss channel simulation box max depth

Parameters

depth simulation box max depth [m]

Returns: reference to this instance

References box_depth.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossBoxRange()

WossTest & woss::WossTest::setWossBoxRange ( double range )

inline

Configures the Woss channel simulation box max range

Parameters

range simulation box max range [m]

Returns: reference to this instance

References box_range.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossClearWorkDir()

WossTest & woss::WossTest::setWossClearWorkDir ( bool flag )

inline

Configure if the Woss channel simulator working dir should be freed or kept

Parameters

flag	clean work dir boolean flag

Returns: reference to this instance

References woss_clear_work_dir.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossControllerDebug()

WossTest & woss::WossTest::setWossControllerDebug ( bool flag )

inline

Configures the WossController debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_controller_debug.

◆ setWossCreatorDebug()

WossTest & woss::WossTest::setWossCreatorDebug ( bool flag )

inline

Sets the WossCreator debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_creator_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossDbManagerDebug()

WossTest & woss::WossTest::setWossDbManagerDebug ( bool flag )

inline

Sets the WossDbManager debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_db_manager_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossDebug()

WossTest & woss::WossTest::setWossDebug ( bool flag )

inline

Sets the Woss channel simulator debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossEvolutionTimeQuantum()

WossTest & woss::WossTest::setWossEvolutionTimeQuantum ( double time )

inline

Configures the Woss channel simulator time quantum to be used by time dependent simulations

Parameters

time	evolution time quantum of the channel model, in [s]

Returns: reference to this instance

References evolution_time_quantum.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossFrequencyStep()

WossTest & woss::WossTest::setWossFrequencyStep ( double step )

inline

Configures the Woss channel simulator frequencies that should be computed. The steps are applied between the start and the end frequencies.

Parameters

frequency_step frequency step in [hZ]

Returns: reference to this instance

References frequency_step.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerDebug()

WossTest & woss::WossTest::setWossManagerDebug ( bool flag )

inline

Configures the WossManager debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_manager_debug.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerSpaceSampling()

WossTest & woss::WossTest::setWossManagerSpaceSampling ( double sampling )

inline

Configures the WossManager space sampling

Parameters

sampling space sampling in [m]

Returns: reference to this instance

References woss_manager_space_sampling.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerThreads()

WossTest & woss::WossTest::setWossManagerThreads ( unsigned int threads )

inline

Configures the WossManager number of threads

Parameters

threads number of threads

Returns: reference to this instance

References concurrent_threads.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerTimeEvoActive()

WossTest & woss::WossTest::setWossManagerTimeEvoActive ( bool flag )

inline

Configures the WossManager time evolution feature active

Parameters

flag	time evolution active flag

Returns: reference to this instance

References time_evolution_active.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerUseMultiThread()

WossTest & woss::WossTest::setWossManagerUseMultiThread ( bool flag )

inline

Configures the WossManager multithread feature

Parameters

flag	use multithread flag

Returns: reference to this instance

References woss_manager_use_multithread.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossManagerUseThreadPool()

WossTest & woss::WossTest::setWossManagerUseThreadPool ( bool flag )

inline

Configures the WossManager multithread thread pool flag

Parameters

flag	use threadpool flag

Returns: reference to this instance

References woss_manager_use_thread_pool.

Referenced by WossBellhopTest::doConfig().

◆ setWossMaxAngle()

WossTest & woss::WossTest::setWossMaxAngle ( double angle )

inline

Configures the Woss channel simulator ray tracing maximum angle

Parameters

angle ray tracing maximum angle [decimal degree]

Returns: reference to this instance

References max_angle.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossMinAngle()

WossTest & woss::WossTest::setWossMinAngle ( double angle )

inline

Configures the Woss channel simulator ray tracing mimimum angle

Parameters

angle ray tracing mimimum angle [decimal degree]

Returns: reference to this instance

References min_angle.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossNormalizedSspDepthSteps()

WossTest & woss::WossTest::setWossNormalizedSspDepthSteps ( double steps )

inline

Configures the Woss channel simulator number normalized SSP depth

Parameters

steps normalized SSP depth steps

Returns: reference to this instance

References normalized_ssp_depth_steps.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossRandomGenStream()

WossTest & woss::WossTest::setWossRandomGenStream ( int stream )

inline

Sets the woss::RandomGenerator stream/seed value

Parameters

stream seed/stream value

Returns: reference to this instance

References woss_random_gen_stream.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossRxMaxDepthOffset()

WossTest & woss::WossTest::setWossRxMaxDepthOffset ( double offset )

inline

Configures the Woss channel simulator receiver maximum depth offset

Parameters

offset receiver maximum depth offset in [m]

Returns: reference to this instance

References rx_max_depth_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossRxMaxRangeOffset()

WossTest & woss::WossTest::setWossRxMaxRangeOffset ( double offset )

inline

Configures the Woss channel simulator receiver maximum range offset

Parameters

offset receiver maximum range offset [m]

Returns: reference to this instance

References rx_max_range_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossRxMinDepthOffset()

WossTest & woss::WossTest::setWossRxMinDepthOffset ( double offset )

inline

Configures the Woss channel simulator receiver mimimum depth offset

Parameters

offset receiver mimimum depth offset in [m]

Returns: reference to this instance

References rx_min_depth_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossRxMinRangeOffset()

WossTest & woss::WossTest::setWossRxMinRangeOffset ( double offset )

inline

Configures the Woss channel simulator receiver mimimum range offset

Parameters

offset receiver mimimum range offset [m]

Returns: reference to this instance

References rx_min_range_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossSimTime()

WossTest & woss::WossTest::setWossSimTime ( const SimTime & time )

inline

Configures the Woss SimTime

Parameters

time	bellhop simulation times

Returns: reference to this instance

References sim_time.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossSspDepthPrecision()

WossTest & woss::WossTest::setWossSspDepthPrecision ( double precision )

inline

Configures the Woss channel simulator SSP depth precision

Parameters

precision SSP depth precision in [m]

Returns: reference to this instance

References ssp_depth_precision.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTestDebug()

WossTest & woss::WossTest::setWossTestDebug ( bool flag )

inline

Sets the WossTest object debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References debug.

Referenced by WossBellhopTest::doConfig(), and main().

◆ setWossTotalRangeSteps()

WossTest & woss::WossTest::setWossTotalRangeSteps ( double step )

inline

Configures the Woss channel simulator range steps that should be used The steps are applied between the tx and rx distance.

Parameters

total_range_steps number of range steps

Returns: reference to this instance

References total_range_steps.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTotalRays()

WossTest & woss::WossTest::setWossTotalRays ( double rays )

inline

Configures the Woss channel simulator number of ray traces

Parameters

rays	total number of ray traces

Returns: reference to this instance

References total_rays.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTotalRuns()

WossTest & woss::WossTest::setWossTotalRuns ( int runs )

inline

Configures the Woss channel simulator total realizations. Each run is based on random perturbation of the input data.

Parameters

runs	number of total runs to be executed

Returns: reference to this instance

References total_runs.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTotalRxDepths()

WossTest & woss::WossTest::setWossTotalRxDepths ( int rx_depths )

inline

Configures the Woss channel simulator number of receiver depth points

Parameters

rx_depths number of receiver depth points

Returns: reference to this instance

References total_rx_depths.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTotalRxRanges()

WossTest & woss::WossTest::setWossTotalRxRanges ( int rx_ranges )

inline

Configures the Woss channel simulator receiver number of range points

Parameters

rx_ranges receiver range point number

Returns: reference to this instance

References total_rx_ranges.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTotalTransmitters()

WossTest & woss::WossTest::setWossTotalTransmitters ( int transmitters )

inline

Configures the Woss channel simulator number of transmitters

Parameters

transmitters number of transmitters

Returns: reference to this instance

References total_transmitters.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTransducerHandlerDebug()

WossTest & woss::WossTest::setWossTransducerHandlerDebug ( bool flag )

inline

Configures the WossTransducerHander debug flag

Parameters

flag	debug flag

Returns: reference to this instance

References woss_transducer_handler_debug.

◆ setWossTxMaxDepthOffset()

WossTest & woss::WossTest::setWossTxMaxDepthOffset ( double offset )

inline

Configures the Woss channel simulator transmitter maximum depth offset

Parameters

offset minimum depth offset in [m]

Returns: reference to this instance

References tx_max_depth_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossTxMinDepthOffset()

WossTest & woss::WossTest::setWossTxMinDepthOffset ( double offset )

inline

Configures the Woss channel simulator transmitter minimum depth offset

Parameters

offset minimum depth offset in [m]

Returns: reference to this instance

References tx_min_depth_offset.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossUseThorpeAtt()

WossTest & woss::WossTest::setWossUseThorpeAtt ( bool flag )

inline

Configures if the Woss channel simulator should add the thorpe attenuation to its computed model

Parameters

flag	add the Thorpe attenuation model

Returns: reference to this instance

References use_thorpe_att.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

◆ setWossWorkDirPath()

WossTest & woss::WossTest::setWossWorkDirPath ( const std::string & path )

inline

Configures the Woss channel simulator work directory path

Parameters

path	path of the work directory

Returns: reference to this instance

References work_dir_path.

Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().

Member Data Documentation

◆ altim_bret_proto

std::unique_ptr<AltimBretschneider> woss::WossTest::altim_bret_proto

protected

AltimBretschneider prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ bathy_db_creator

std::shared_ptr<BathyGebcoDbCreator> woss::WossTest::bathy_db_creator

protected

the helper will automatically allocate the woss GEBCO bathymetry db creator

Referenced by init().

◆ bathy_db_creator_debug

bool woss::WossTest::bathy_db_creator_debug

protected

enable/disable the debug prints of the woss Bathymetry database creator.

Referenced by getBathyDbCreatorDebug(), init(), and setBathyDbCreatorDebug().

◆ bathy_db_debug

bool woss::WossTest::bathy_db_debug

protected

enable/disable the debug prints of the woss Bathymetry database (GEBCO).

Referenced by getBathyDbDebug(), init(), and setBathyDbDebug().

◆ bathy_db_file_path

std::string woss::WossTest::bathy_db_file_path

protected

setup the path of the woss GEBCO database

Referenced by getBathyDbFilePath(), init(), and setBathyDbFilePath().

◆ bathy_db_gebco_format

GEBCO_BATHY_TYPE woss::WossTest::bathy_db_gebco_format

protected

setup the the GEBCO database format

Referenced by getBathyDbGebcoFormat(), init(), and setBathyDbGebcoFormat().

◆ bellhop_altim_type

std::string woss::WossTest::bellhop_altim_type

protected

woss object configuration: Bellhop Altimetry type string

Referenced by getWossBellhopAltimType(), init(), and setWossBellhopAltimType().

◆ bellhop_arr_syntax

BellhopArrSyntax woss::WossTest::bellhop_arr_syntax

protected

woss object configration: Bellhop Arr file syntax to be used during .arr file parsing

Referenced by getWossBellhopArraySyntax(), init(), and setWossBellhopArraySyntax().

◆ bellhop_bathy_method

std::string woss::WossTest::bellhop_bathy_method

protected

woss object configuration: Bathymetry write method string

Referenced by getWossBellhopBathyMethod(), init(), and setWossBellhopBathyMethod().

◆ bellhop_bathy_type

std::string woss::WossTest::bellhop_bathy_type

protected

woss object configuration: Bellhop bathymetry type string

Referenced by getWossBellhopBathyType(), init(), and setWossBellhopBathyType().

◆ bellhop_beam_options

std::string woss::WossTest::bellhop_beam_options

protected

woss object configuration: Bellhop beam option string

Referenced by getWossBellhopBeamOptions(), init(), and setWossBellhopBeamOptions().

◆ bellhop_creator

std::shared_ptr<BellhopCreator> woss::WossTest::bellhop_creator

protected

the helper will automatically allocate the woss creator

Referenced by WossBellhopScript::doRun(), WossBellhopTest::doRun(), and init().

◆ bellhop_mode

std::string woss::WossTest::bellhop_mode

protected

woss object configuration: Bellhop mode string

Referenced by getWossBellhopMode(), init(), and setWossBellhopMode().

◆ bellhop_path

std::string woss::WossTest::bellhop_path

protected

woss object configuration: path of the Bellhop executable

Referenced by getWossBellhopPath(), init(), and setWossBellhopPath().

◆ bellhop_shd_syntax

BellhopShdSyntax woss::WossTest::bellhop_shd_syntax

protected

woss object configration: Bellhop Shd file syntax to be used during .shd file parsing

Referenced by getWossBellhopShdSyntax(), init(), and setWossBellhopShdSyntax().

◆ box_depth

double woss::WossTest::box_depth

protected

woss object configuration: maximum depth to trace rays to; deeper rays will be ignored

Referenced by getWossBoxDepth(), init(), and setWossBoxDepth().

◆ box_range

double woss::WossTest::box_range

protected

woss object configuration: maximum range to trace rats to; longer rays will be ignored

Referenced by getWossBoxRange(), init(), and setWossBoxRange().

◆ concurrent_threads

unsigned int woss::WossTest::concurrent_threads

protected

number of concurrent threads (0 = auto).

Referenced by getWossManagerThreads(), init(), and setWossManagerThreads().

◆ debug

bool woss::WossTest::debug

protected

debug flag

Referenced by WossCoordDefTest::doBearingTests(), WossCoordDefTest::doCoordCartTests(), WossBellhopScript::doRun(), WossBellhopTest::doRun(), WossCoordDefTest::doRun(), getWossTestDebug(), init(), and setWossTestDebug().

◆ def_handler

DefHandler& woss::WossTest::def_handler

protected

Definition Handler object allocated by the helper.

Referenced by init(), and WossTest().

◆ evolution_time_quantum

double woss::WossTest::evolution_time_quantum

protected

woss object configuration: evolution time quantum

Referenced by getWossEvolutionTimeQuantum(), init(), and setWossEvolutionTimeQuantum().

◆ frequency_step

double woss::WossTest::frequency_step

protected

woss object configuration: number of frequency steps

Referenced by getWossFrequencyStep(), init(), and setWossFrequencyStep().

◆ initialized

bool woss::WossTest::initialized

protected

initialization complete flag.

Referenced by init().

◆ location_proto

std::unique_ptr<Location> woss::WossTest::location_proto

protected

Location prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ max_angle

double woss::WossTest::max_angle

protected

woss object configuration: maximum vertical angle in decimal degrees

Referenced by getWossMaxAngle(), init(), and setWossMaxAngle().

◆ min_angle

double woss::WossTest::min_angle

protected

woss object configuration: minimum vertical angle in decimal degrees

Referenced by getWossMinAngle(), init(), and setWossMinAngle().

◆ normalized_ssp_depth_steps

double woss::WossTest::normalized_ssp_depth_steps

protected

woss object configuration: SSP depth quantization steps

Referenced by getWossNormalizedSspDepthSteps(), init(), and setWossNormalizedSspDepthSteps().

◆ pressure_proto

std::unique_ptr<Pressure> woss::WossTest::pressure_proto

protected

Pressure prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ random_gen_proto

std::unique_ptr<RandomGenerator> woss::WossTest::random_gen_proto

protected

RandomGenerator prototype which will be plugged into the WOSS framework.

Referenced by init().

◆ res_db_creator_debug

bool woss::WossTest::res_db_creator_debug

protected

enable/disable the debug prints of the woss results database creator.

Referenced by getResDbCreatorDebug(), init(), and setResDbCreatorDebug().

◆ res_db_creator_press_bin

std::shared_ptr<ResPressureBinDbCreator> woss::WossTest::res_db_creator_press_bin

protected

the helper will automatically allocate the desired result database creator based on current configuration.

Referenced by init().

◆ res_db_creator_press_txt

std::shared_ptr<ResPressureTxtDbCreator> woss::WossTest::res_db_creator_press_txt

protected

the helper will automatically allocate the desired result database creator based on current configuration.

Referenced by init().

◆ res_db_creator_time_arr_bin

std::shared_ptr<ResTimeArrBinDbCreator> woss::WossTest::res_db_creator_time_arr_bin

protected

the helper will automatically allocate the desired result database creator based on current configuration.

Referenced by init().

◆ res_db_creator_time_arr_txt

std::shared_ptr<ResTimeArrTxtDbCreator> woss::WossTest::res_db_creator_time_arr_txt

protected

the helper will automatically allocate the desired result database creator based on current configuration.

Referenced by init().

◆ res_db_debug

bool woss::WossTest::res_db_debug

protected

enable/disable the debug prints of the woss result databases.

Referenced by getResDbDebug(), init(), and setResDbDebug().

◆ res_db_file_name

std::string woss::WossTest::res_db_file_name

protected

set up the woss result database file name (without path)

Referenced by getResDbFileName(), init(), and setResDbFileName().

◆ res_db_file_path

std::string woss::WossTest::res_db_file_path

protected

set up the woss result database file path

Referenced by getResDbFilePath(), init(), and setResDbFilePath().

◆ res_db_space_sampling

double woss::WossTest::res_db_space_sampling

protected

set up the woss result database 2D spatial sampling

Referenced by getResDbSpaceSampling(), and setResDbSpaceSampling().

◆ res_db_use_binary

bool woss::WossTest::res_db_use_binary

protected

set up the woss result database format: binary or textual.

Referenced by getResDbUseBinary(), init(), and setResDbUseBinary().

◆ res_db_use_pressure

bool woss::WossTest::res_db_use_pressure

protected

set up the woss result databases data format: single pressure tap.

Referenced by getResDbUsePressure(), init(), and setResDbUsePressure().

◆ res_db_use_time_arr

bool woss::WossTest::res_db_use_time_arr

protected

set up the woss result databases data format: power delay profile.

Referenced by getResDbUseTimeArr(), init(), and setResDbUseTimeArr().

◆ rx_max_depth_offset

double woss::WossTest::rx_max_depth_offset

protected

woss object configuration: receiver max depth offset in meters

Referenced by getWossRxMaxDepthOffset(), init(), and setWossRxMaxDepthOffset().

◆ rx_max_range_offset

double woss::WossTest::rx_max_range_offset

protected

woss object configuration: receiver max range offset in meters

Referenced by getWossRxMaxRangeOffset(), init(), and setWossRxMaxRangeOffset().

◆ rx_min_depth_offset

double woss::WossTest::rx_min_depth_offset

protected

woss object configuration: receiver min depth offset in meters

Referenced by getWossRxMinDepthOffset(), init(), and setWossRxMinDepthOffset().

◆ rx_min_range_offset

double woss::WossTest::rx_min_range_offset

protected

woss object configuration: receiver min range offset in meters

Referenced by getWossRxMinRangeOffset(), init(), and setWossRxMinRangeOffset().

◆ sedim_db_coord_file_path

std::string woss::WossTest::sedim_db_coord_file_path

protected

setup the path of the sediment database indexed by geographical coordinates with decimal degrees resolution

Referenced by getSedimDbCoordFilePath(), init(), and setSedimDbCoordFilePath().

◆ sedim_db_creator

std::shared_ptr<SedimDeck41DbCreator> woss::WossTest::sedim_db_creator

protected

the helper will automatically allocate the woss sediment database creator

Referenced by init().

◆ sedim_db_creator_debug

bool woss::WossTest::sedim_db_creator_debug

protected

enable/disable the debug prints of the woss sediment database creator.

Referenced by getSedimDbCreatorDebug(), init(), and setSedimDbCreatorDebug().

◆ sedim_db_debug

bool woss::WossTest::sedim_db_debug

protected

enable/disable the debug prints of the woss sediment database.

Referenced by getSedimDbDebug(), init(), and setSedimDbDebug().

◆ sedim_db_marsden_file_path

std::string woss::WossTest::sedim_db_marsden_file_path

protected

setup the path of the sediment database indexed by geographical coordinates with marsden square resolution

Referenced by getSedimDbMarsdenFilePath(), init(), and setSedimDbMarsdenFilePath().

◆ sedim_db_marsden_one_file_path

std::string woss::WossTest::sedim_db_marsden_one_file_path

protected

setup the path of the sediment database indexed by geographical coordinates with marsden one square resolution

Referenced by getSedimDbMarsdenOneFilePath(), init(), and setSedimDbMarsdenOneFilePath().

◆ sedim_deck41_db_type

DECK41DbType woss::WossTest::sedim_deck41_db_type

protected

DECK41 db data format type.

Referenced by getSedimDeck41DbType(), init(), and setSedimDeck41DbType().

◆ sediment_proto

std::unique_ptr<Sediment> woss::WossTest::sediment_proto

protected

Sediment prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ sim_time

SimTime woss::WossTest::sim_time

protected

woss object configuration: woss simulation times (start and end sim times)

Referenced by getWossSimTime(), init(), and setWossSimTime().

◆ ssp_db_creator

std::shared_ptr<SspWoa2005DbCreator> woss::WossTest::ssp_db_creator

protected

the helper will automatically allocate the woss sediment database creator

Referenced by init().

◆ ssp_db_creator_debug

bool woss::WossTest::ssp_db_creator_debug

protected

enable/disable the debug prints of the woss SSP database creator.

Referenced by getSspDbCreatorDebug(), init(), and setSspDbCreatorDebug().

◆ ssp_db_debug

bool woss::WossTest::ssp_db_debug

protected

enable/disable the debug prints of the woss SSP database.

Referenced by getSspDbDebug(), init(), and setSspDbDebug().

◆ ssp_db_file_path

std::string woss::WossTest::ssp_db_file_path

protected

setup the path of the woss monthly SSP database indexed by geographical coordinates

Referenced by getSspDbFilePath(), init(), and setSspDbFilePath().

◆ ssp_depth_precision

double woss::WossTest::ssp_depth_precision

protected

woss object configuration: SSP depth precision in meters

Referenced by getWossSspDepthPrecision(), init(), and setWossSspDepthPrecision().

◆ ssp_proto

std::unique_ptr<SSP> woss::WossTest::ssp_proto

protected

SSP prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ ssp_woa_db_type

WOADbType woss::WossTest::ssp_woa_db_type

protected

WOA SSP Db Type.

Referenced by getSspWoaDbType(), and setSspWoaDbType().

◆ time_arr_proto

std::unique_ptr<TimeArr> woss::WossTest::time_arr_proto

protected

TimeArr prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ time_evolution_active

bool woss::WossTest::time_evolution_active

protected

enable/disable the time evolution feature.

Referenced by getWossManagerTimeEvoActive(), init(), and setWossManagerTimeEvoActive().

◆ time_ref_proto

std::unique_ptr<TimeReference> woss::WossTest::time_ref_proto

protected

TimeReference prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ total_range_steps

double woss::WossTest::total_range_steps

protected

woss object configuration: tx - rx range sampling in meters

Referenced by getWossTotalRangeSteps(), init(), and setWossTotalRangeSteps().

◆ total_rays

double woss::WossTest::total_rays

protected

woss object configuration: total number of rays (0 = automatic)

Referenced by getWossTotalRays(), init(), and setWossTotalRays().

◆ total_runs

int woss::WossTest::total_runs

protected

woss object configuration: total number of channel simulator runs

Referenced by getWossTotalRuns(), init(), and setWossTotalRuns().

◆ total_rx_depths

int woss::WossTest::total_rx_depths

protected

woss object configuration: receiver depth sampling

Referenced by getWossTotalRxDepths(), init(), and setWossTotalRxDepths().

◆ total_rx_ranges

int woss::WossTest::total_rx_ranges

protected

woss object configuration: receiver range sampling

Referenced by getWossTotalRxRanges(), init(), and setWossTotalRxRanges().

◆ total_transmitters

int woss::WossTest::total_transmitters

protected

woss object configuration: total number of transmitting sources

Referenced by getWossTotalTransmitters(), init(), and setWossTotalTransmitters().

◆ transducer_proto

std::unique_ptr<Transducer> woss::WossTest::transducer_proto

protected

Transducer prototype which will be plugged into the WOSS framework.

Referenced by WossTest().

◆ tx_max_depth_offset

double woss::WossTest::tx_max_depth_offset

protected

woss object configuration: transmitter max offset in meters

Referenced by getWossTxMaxDepthOffset(), init(), and setWossTxMaxDepthOffset().

◆ tx_min_depth_offset

double woss::WossTest::tx_min_depth_offset

protected

woss object configuration: transmitter min offset in meters

Referenced by getWossTxMinDepthOffset(), init(), and setWossTxMinDepthOffset().

◆ use_thorpe_att

bool woss::WossTest::use_thorpe_att

protected

woss object configuration: use thorpe attenuation in channel computation

Referenced by getWossUseThorpeAtt(), init(), and setWossUseThorpeAtt().

◆ work_dir_path

std::string woss::WossTest::work_dir_path

protected

woss object configuration: path of the temporary directory

Referenced by getWossWorkDirPath(), init(), and setWossWorkDirPath().

◆ woss_clear_work_dir

bool woss::WossTest::woss_clear_work_dir

protected

woss object configuration: clear the temporary files created by the underlying channel simulator

Referenced by getWossClearWorkDir(), init(), and setWossClearWorkDir().

◆ woss_controller

std::shared_ptr<WossController> woss::WossTest::woss_controller

protected

the helper will automatically allocate the woss controller.

Referenced by WossBellhopScript::doRun(), WossBellhopTest::doRun(), and init().

◆ woss_controller_debug

bool woss::WossTest::woss_controller_debug

protected

enable/disable the debug prints of the woss conteroller

Referenced by getWossControllerDebug(), and setWossControllerDebug().

◆ woss_creator_debug

bool woss::WossTest::woss_creator_debug

protected

enable/disable the debug prints of the woss creator.

Referenced by getWossCreatorDebug(), init(), and setWossCreatorDebug().

◆ woss_db_manager

std::shared_ptr<WossDbManager> woss::WossTest::woss_db_manager

protected

the helper will automatically allocate the woss DB manager

Referenced by WossBellhopScript::doInit(), WossBellhopTest::doInit(), and init().

◆ woss_db_manager_debug

bool woss::WossTest::woss_db_manager_debug

protected

enable/disable the debug prints of the woss DB manager object.

Referenced by getWossDbManagerDebug(), init(), and setWossDbManagerDebug().

◆ woss_debug

bool woss::WossTest::woss_debug

protected

enable/disable the debug prints of all woss objects

Referenced by getWossDebug(), init(), and setWossDebug().

◆ woss_manager_debug

bool woss::WossTest::woss_manager_debug

protected

enable/disable the debug prints of the woss manager.

Referenced by getWossManagerDebug(), init(), and setWossManagerDebug().

◆ woss_manager_multi

std::shared_ptr< WossManagerSimple<WossManagerResDbMT> > woss::WossTest::woss_manager_multi

protected

the helper will automatically allocate the desired woss manaeger based on current configuration.

Referenced by init().

◆ woss_manager_simple

std::shared_ptr< WossManagerSimple<WossManagerResDb> > woss::WossTest::woss_manager_simple

protected

the helper will automatically allocate the desired woss manager based on current configuration.

Referenced by init().

◆ woss_manager_space_sampling

double woss::WossTest::woss_manager_space_sampling

protected

woss manager space sampling in meters

Referenced by getWossManagerSpaceSampling(), init(), and setWossManagerSpaceSampling().

◆ woss_manager_use_multithread

bool woss::WossTest::woss_manager_use_multithread

protected

enable/disable the multithread feature

Referenced by getWossManagerUseMultiThread(), init(), and setWossManagerUseMultiThread().

◆ woss_manager_use_thread_pool

bool woss::WossTest::woss_manager_use_thread_pool

protected

enable/disable woss::ThreadPool usage

Referenced by getWossManagerUseThreadPool(), init(), and setWossManagerUseThreadPool().

◆ woss_random_gen_stream

int woss::WossTest::woss_random_gen_stream

protected

random generator used by the WOSS framework.

Referenced by getWossRandomGenStream(), init(), and setWossRandomGenStream().

◆ woss_transducer_handler

std::shared_ptr<TransducerHandler> woss::WossTest::woss_transducer_handler

protected

the helper will automatically allocate the woss Transducer handler.

Referenced by init().

◆ woss_transducer_handler_debug

bool woss::WossTest::woss_transducer_handler_debug

protected

enable/disable the debug prints of the woss transducer handler.

Referenced by getWossTransducerHandlerDebug(), init(), and setWossTransducerHandlerDebug().

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

tests/woss-test.h
tests/woss-test.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WossTest() [1/3]

◆ ~WossTest()

◆ WossTest() [2/3]

◆ WossTest() [3/3]

Member Function Documentation

◆ config()

◆ doConfig()

◆ doInit()

◆ doRun()

◆ getBathyDbCreatorDebug()

◆ getBathyDbDebug()

◆ getBathyDbFilePath()

◆ getBathyDbGebcoFormat()

◆ getResDbCreatorDebug()

◆ getResDbDebug()

◆ getResDbFileName()

◆ getResDbFilePath()

◆ getResDbSpaceSampling()

◆ getResDbUseBinary()

◆ getResDbUsePressure()

◆ getResDbUseTimeArr()

◆ getSedimDbCoordFilePath()

◆ getSedimDbCreatorDebug()

◆ getSedimDbDebug()

◆ getSedimDbMarsdenFilePath()

◆ getSedimDbMarsdenOneFilePath()

◆ getSedimDeck41DbType()

◆ getSspDbCreatorDebug()

◆ getSspDbDebug()

◆ getSspDbFilePath()

◆ getSspWoaDbType()

◆ getWossBellhopAltimType()

◆ getWossBellhopArraySyntax()

◆ getWossBellhopBathyMethod()

◆ getWossBellhopBathyType()

◆ getWossBellhopBeamOptions()

◆ getWossBellhopMode()

◆ getWossBellhopPath()

◆ getWossBellhopShdSyntax()

◆ getWossBoxDepth()

◆ getWossBoxRange()

◆ getWossClearWorkDir()

◆ getWossControllerDebug()

◆ getWossCreatorDebug()

◆ getWossDbManagerDebug()

◆ getWossDebug()

◆ getWossEvolutionTimeQuantum()

◆ getWossFrequencyStep()

◆ getWossManagerDebug()

◆ getWossManagerSpaceSampling()

◆ getWossManagerThreads()

◆ getWossManagerTimeEvoActive()

◆ getWossManagerUseMultiThread()

◆ getWossManagerUseThreadPool()

◆ getWossMaxAngle()

◆ getWossMinAngle()

◆ getWossNormalizedSspDepthSteps()

◆ getWossRandomGenStream()

◆ getWossRxMaxDepthOffset()

◆ getWossRxMaxRangeOffset()

◆ getWossRxMinDepthOffset()

◆ getWossRxMinRangeOffset()

◆ getWossSimTime()

◆ getWossSspDepthPrecision()

◆ getWossTestDebug()

◆ getWossTotalRangeSteps()

◆ getWossTotalRays()

◆ getWossTotalRuns()

◆ getWossTotalRxDepths()

◆ getWossTotalRxRanges()

◆ getWossTotalTransmitters()

◆ getWossTransducerHandlerDebug()

◆ getWossTxMaxDepthOffset()

◆ getWossTxMinDepthOffset()

◆ getWossUseThorpeAtt()