WossTest provides the framework for the WOSS library test binaries. More...
#include <woss-test.h>
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_bin_name |
| woss object configuration: Bellhop binary name | |
| 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, bathy_db_creator, 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_bin_name, bellhop_creator, bellhop_mode, bellhop_path, bellhop_shd_syntax, box_depth, box_range, concurrent_threads, debug, def_handler, evolution_time_quantum, frequency_step, initialized, location_proto, max_angle, min_angle, normalized_ssp_depth_steps, pressure_proto, 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_space_sampling, 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, sediment_proto, sim_time, ssp_db_creator, ssp_db_creator_debug, ssp_db_debug, ssp_db_file_path, ssp_depth_precision, ssp_proto, ssp_woa_db_type, time_arr_proto, time_evolution_active, time_ref_proto, total_range_steps, total_rays, total_runs, total_rx_depths, total_rx_ranges, total_transmitters, transducer_proto, tx_max_depth_offset, tx_min_depth_offset, use_thorpe_att, work_dir_path, woss_clear_work_dir, woss_controller, woss_controller_debug, woss_creator_debug, woss_db_manager, woss_db_manager_debug, woss_debug, 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 operator=(), operator=(), setBathyDbCreatorDebug(), setBathyDbDebug(), setBathyDbFilePath(), setBathyDbGebcoFormat(), setResDbCreatorDebug(), setResDbDebug(), setResDbFileName(), setResDbFilePath(), setResDbSpaceSampling(), setResDbUseBinary(), setResDbUsePressure(), setResDbUseTimeArr(), setSedimDbCoordFilePath(), setSedimDbCreatorDebug(), setSedimDbDebug(), setSedimDbMarsdenFilePath(), setSedimDbMarsdenOneFilePath(), setSedimDeck41DbType(), setSspDbCreatorDebug(), setSspDbDebug(), setSspDbFilePath(), setSspWoaDbType(), setWossBellhopAltimType(), setWossBellhopArraySyntax(), setWossBellhopBathyMethod(), setWossBellhopBathyType(), setWossBellhopBeamOptions(), setWossBellhopBinName(), setWossBellhopMode(), setWossBellhopPath(), setWossBellhopShdSyntax(), setWossBoxDepth(), setWossBoxRange(), setWossClearWorkDir(), setWossControllerDebug(), setWossCreatorDebug(), setWossDbManagerDebug(), setWossDebug(), setWossEvolutionTimeQuantum(), setWossFrequencyStep(), setWossManagerDebug(), setWossManagerSpaceSampling(), setWossManagerThreads(), setWossManagerTimeEvoActive(), setWossManagerUseMultiThread(), setWossManagerUseThreadPool(), setWossMaxAngle(), setWossMinAngle(), setWossNormalizedSspDepthSteps(), setWossRandomGenStream(), setWossRxMaxDepthOffset(), setWossRxMaxRangeOffset(), setWossRxMinDepthOffset(), setWossRxMinRangeOffset(), setWossSimTime(), setWossSspDepthPrecision(), setWossTestDebug(), setWossTotalRangeSteps(), setWossTotalRays(), setWossTotalRuns(), setWossTotalRxDepths(), setWossTotalRxRanges(), setWossTotalTransmitters(), setWossTransducerHandlerDebug(), setWossTxMaxDepthOffset(), setWossTxMinDepthOffset(), setWossUseThorpeAtt(), setWossWorkDirPath(), WossBellhopScript::WossBellhopScript(), WossBellhopTest::WossBellhopTest(), WossCoordDefTest::WossCoordDefTest(), WossTest(), and WossTest().
◆ ~WossTest()
|
virtualdefault |
◆ WossTest() [2/3]
|
delete |
Deleted copy constructor
- Parameters
-
copy const reference to a WossTest object
References WossTest().
◆ WossTest() [3/3]
|
delete |
Deleted move constructor
- Parameters
-
tmp rvalue reference to a WossTest object
References WossTest().
Member Function Documentation
◆ config()
|
protected |
Perform the configuration phase. Must be run before the initialization phase.
References doConfig().
Referenced by run().
◆ doConfig()
|
protectedpure virtual |
Virtual function that allows the derived class to perform its custom configuration phase
Implemented in WossBellhopScript, WossBellhopTest, WossCoordDefTest, and WossUnitTest.
Referenced by config().
◆ doInit()
|
protectedpure virtual |
Virtual function that allows the derived class to perform its custom initialization phase
Implemented in WossBellhopScript, WossBellhopTest, WossCoordDefTest, and WossUnitTest.
Referenced by init().
◆ doRun()
|
protectedpure virtual |
Virtual function that allows the derived class to perform its custom run phase
Implemented in WossBellhopScript, WossBellhopTest, WossCoordDefTest, and WossUnitTest.
Referenced by run().
◆ getBathyDbCreatorDebug()
|
inline |
Gets the BathyGebcoDbCreator debug flag
- Returns
- debug boolean value
References bathy_db_creator_debug.
◆ getBathyDbDebug()
|
inline |
◆ getBathyDbFilePath()
|
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()
|
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()
|
inline |
Gets the Result Db Creator debug flag
- Returns
- debug flag
References res_db_creator_debug.
Referenced by WossUnitTest::testSettings().
◆ getResDbDebug()
|
inline |
◆ getResDbFileName()
|
inline |
◆ getResDbFilePath()
|
inline |
◆ getResDbSpaceSampling()
|
inline |
◆ getResDbUseBinary()
|
inline |
◆ getResDbUsePressure()
|
inline |
◆ getResDbUseTimeArr()
|
inline |
◆ getSedimDbCoordFilePath()
|
inline |
Gets the Sediment DECK41 Db indexed by coordinates path
- Returns
- string containing the file path
References sedim_db_coord_file_path.
◆ getSedimDbCreatorDebug()
|
inline |
Gets the SedimDeck41DbCreator debug flag
- Returns
- debug boolean value
References sedim_db_creator_debug.
◆ getSedimDbDebug()
|
inline |
◆ getSedimDbMarsdenFilePath()
|
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()
|
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()
|
inline |
◆ getSspDbCreatorDebug()
|
inline |
Gets the SspWoa2005DbCreator debug flag
- Returns
- boolean debug flag value
References ssp_db_creator_debug.
◆ getSspDbDebug()
|
inline |
◆ getSspDbFilePath()
|
inline |
◆ getSspWoaDbType()
|
inline |
◆ getWossBellhopAltimType()
|
inline |
Gets the Woss channel simulator bellhop altimetry type
- Returns
- bellhop altimetry type
References bellhop_altim_type.
◆ getWossBellhopArraySyntax()
|
inline |
Gets the Woss channel bellhop array model result syntax
- Returns
- bellhop array model result syntax
References bellhop_arr_syntax.
◆ getWossBellhopBathyMethod()
|
inline |
Gets the Woss channel simulator bellhop bathymetry method
- Returns
- bellhop bathymetry method
References bellhop_bathy_method.
◆ getWossBellhopBathyType()
|
inline |
Gets the Woss channel simulator bellhop bathymetry type
- Returns
- bellhop bathymetry type
References bellhop_bathy_type.
◆ getWossBellhopBeamOptions()
|
inline |
Gets the Woss channel simulator bellhop beam options
- Returns
- bellhop beam options
References bellhop_beam_options.
◆ getWossBellhopBinName()
|
inline |
Gets the Woss channel simulator bellhop binary name
- Returns
- bellhop binary name
References bellhop_bin_name.
◆ getWossBellhopMode()
|
inline |
Gets the Woss channel simulator bellhop running mode
- Returns
- bellhop running mode
References bellhop_mode.
◆ getWossBellhopPath()
|
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()
|
inline |
Gets the Woss channel bellhop pressure model result syntax
- Returns
- bellhop pressure model result syntax
References bellhop_shd_syntax.
◆ getWossBoxDepth()
|
inline |
◆ getWossBoxRange()
|
inline |
◆ getWossClearWorkDir()
|
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()
|
inline |
◆ getWossCreatorDebug()
|
inline |
◆ getWossDbManagerDebug()
|
inline |
◆ getWossDebug()
|
inline |
◆ getWossEvolutionTimeQuantum()
|
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()
|
inline |
Gets the Woss channel simulator frequencies frequency steps
- Returns
- frequency step in [hZ]
References frequency_step.
◆ getWossManagerDebug()
|
inline |
◆ getWossManagerSpaceSampling()
|
inline |
Gets the WossManager space sampling
- Returns
- space sampling in [m]
References woss_manager_space_sampling.
◆ getWossManagerThreads()
|
inline |
◆ getWossManagerTimeEvoActive()
|
inline |
Gets the WossManager time evolution feature active
- Returns
- time evolution active flag
References time_evolution_active.
◆ getWossManagerUseMultiThread()
|
inline |
Gets the WossManager multithread flag
- Returns
- use multithread flag
References woss_manager_use_multithread.
◆ getWossManagerUseThreadPool()
|
inline |
Gets the WossManager thread pool flag
- Returns
- use thread pool flag
References woss_manager_use_thread_pool.
◆ getWossMaxAngle()
|
inline |
◆ getWossMinAngle()
|
inline |
◆ getWossNormalizedSspDepthSteps()
|
inline |
Gets the Woss channel simulator normalized depth steps
- Returns
- normalized SSP depth steps
References normalized_ssp_depth_steps.
◆ getWossRandomGenStream()
|
inline |
Gets the woss::RandomGenerator stream/seed value
- Returns
- seed/stream value
References woss_random_gen_stream.
Referenced by WossUnitTest::testSettings().
◆ getWossRxMaxDepthOffset()
|
inline |
Gets the Woss channel simulator receiver maximum depth offset
- Returns
- receiver maximum depth offset in [m]
References rx_max_depth_offset.
◆ getWossRxMaxRangeOffset()
|
inline |
Gets the Woss channel simulator receiver maximum range offset
- Returns
- receiver maximum range offset [m]
References rx_max_range_offset.
◆ getWossRxMinDepthOffset()
|
inline |
Gets the Woss channel simulator receiver mimimum depth offset
- Returns
- receiver mimimum depth offset in [m]
References rx_min_depth_offset.
◆ getWossRxMinRangeOffset()
|
inline |
Gets the Woss channel simulator receiver mimimum range offset
- Returns
- receiver mimimum range offset [m]
References rx_min_range_offset.
◆ getWossSimTime()
|
inline |
◆ getWossSspDepthPrecision()
|
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()
|
inline |
◆ getWossTotalRangeSteps()
|
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()
|
inline |
Gets the Woss channel simulator number of ray traces
- Returns
- total number of ray traces
References total_rays.
◆ getWossTotalRuns()
|
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()
|
inline |
Gets the Woss channel simulator number of receiver depth points
- Returns
- number of receiver depth points
References total_rx_depths.
◆ getWossTotalRxRanges()
|
inline |
Gets the Woss channel simulator receiver number of range points
- Returns
- receiver range point number
References total_rx_ranges.
◆ getWossTotalTransmitters()
|
inline |
Gets the Woss channel simulator number of transmitters
- Returns
- number of transmitters
References total_transmitters.
◆ getWossTransducerHandlerDebug()
|
inline |
Gets the WossTransducerHander debug flag
- Returns
- debug flag
References woss_transducer_handler_debug.
◆ getWossTxMaxDepthOffset()
|
inline |
Gets the Woss channel simulator transmitter maximum depth offset
- Returns
- maximum depth offset in [m]
References tx_max_depth_offset.
◆ getWossTxMinDepthOffset()
|
inline |
Gets the Woss channel simulator transmitter minimum depth offset
- Returns
- minimum depth offset in [m]
References tx_min_depth_offset.
◆ getWossUseThorpeAtt()
|
inline |
Gets the Thorpe attenuation model flag
- Returns
- Thorpe attenuation model flag
References use_thorpe_att.
◆ getWossWorkDirPath()
|
inline |
Gets the Woss channel simulator work directory path
- Returns
- a string containing the path of the work directory
References work_dir_path.
◆ 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_bin_name, bellhop_creator, bellhop_mode, bellhop_path, bellhop_shd_syntax, box_depth, box_range, concurrent_threads, debug, def_handler, doInit(), evolution_time_quantum, frequency_step, initialized, 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, sim_time, ssp_db_creator, ssp_db_creator_debug, ssp_db_debug, ssp_db_file_path, ssp_depth_precision, 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().
◆ operator=() [1/2]
Deleted move assignement operator
- Parameters
-
copy rvalue reference to a WossTest object
References WossTest().
◆ operator=() [2/2]
Deleted assignement operator
- Parameters
-
tmp const reference to a WossTest object
References WossTest().
◆ 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().
◆ setBathyDbCreatorDebug()
|
inline |
Sets the BathyGebcoDbCreator debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References bathy_db_creator_debug, and WossTest().
◆ setBathyDbDebug()
|
inline |
Sets the Bathy Db debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References bathy_db_debug, and WossTest().
◆ setBathyDbFilePath()
|
inline |
Sets the Bathy Db file path
- Parameters
-
path path to db file
- Returns
- reference to this instance
References bathy_db_file_path, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setBathyDbGebcoFormat()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbCreatorDebug()
|
inline |
Sets the Result Db Creator debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References res_db_creator_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), WossBellhopTest::doConfig(), and WossUnitTest::testSettings().
◆ setResDbDebug()
|
inline |
Sets the Result Db debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References res_db_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbFileName()
|
inline |
Sets the ResDb file name
- Parameters
-
path file name
- Returns
- reference to this instance
References res_db_file_name, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbFilePath()
|
inline |
Sets the ResDb'file path
- Parameters
-
path file path
- Returns
- reference to this instance
References res_db_file_path, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbSpaceSampling()
|
inline |
Sets the ResDb's space sampling
- Parameters
-
sampling space sampling in [m]
- Returns
- reference to this instance
References res_db_space_sampling, and WossTest().
◆ setResDbUseBinary()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbUsePressure()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setResDbUseTimeArr()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSedimDbCoordFilePath()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSedimDbCreatorDebug()
|
inline |
Sets the SedimDeck41DbCreator debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References sedim_db_creator_debug, and WossTest().
◆ setSedimDbDebug()
|
inline |
Sets the Sediment db debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References sedim_db_debug, and WossTest().
◆ setSedimDbMarsdenFilePath()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSedimDbMarsdenOneFilePath()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSedimDeck41DbType()
|
inline |
Sets the DECK41DbType db type
- Parameters
-
type DECK41DbType type
- Returns
- reference to this instance
References sedim_deck41_db_type, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSspDbCreatorDebug()
|
inline |
Sets the SspWoa2005DbCreator debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References ssp_db_creator_debug, and WossTest().
◆ setSspDbDebug()
|
inline |
Sets the SSP Db debug flag
- Parameters
-
flag debug boolean value
- Returns
- reference to this instance
References ssp_db_debug, and WossTest().
◆ setSspDbFilePath()
|
inline |
Sets the SSP Db file path
- Parameters
-
path path to db file
- Returns
- reference to this instance
References ssp_db_file_path, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setSspWoaDbType()
Sets the SSP Db WOADbType type
- Parameters
-
type WOADbType of the db path
- Returns
- reference to this instance
References ssp_woa_db_type, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopAltimType()
|
inline |
Configures the Woss channel bellhop altimetry type
- Parameters
-
mode bellhop altimetry type
- Returns
- reference to this instance
References bellhop_altim_type, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopArraySyntax()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopBathyMethod()
|
inline |
Configures the Woss channel bellhop bathymetry method
- Parameters
-
mode bellhop bathymetry method
- Returns
- reference to this instance
References bellhop_bathy_method, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopBathyType()
|
inline |
Configures the Woss channel bellhop bathymetry type
- Parameters
-
mode bellhop bathymetry type
- Returns
- reference to this instance
References bellhop_bathy_type, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopBeamOptions()
|
inline |
Configures the Woss channel bellhop beam options
- Parameters
-
mode bellhop beam options
- Returns
- reference to this instance
References bellhop_beam_options, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopBinName()
|
inline |
Sets the Woss channel simulator bellhop binary name
- Parameters
-
name bellhop binary name
- Returns
- reference to this instance
References bellhop_bin_name, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopMode()
|
inline |
Configures the Woss channel bellhop running mode
- Parameters
-
mode bellhop running mode
- Returns
- reference to this instance
References bellhop_mode, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBellhopPath()
|
inline |
Configures the Woss channel bellhop executable file path
- Parameters
-
path bellhop executable file path
- Returns
- reference to this instance
References bellhop_path, and WossTest().
◆ setWossBellhopShdSyntax()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBoxDepth()
|
inline |
Configures the Woss channel simulation box max depth
- Parameters
-
depth simulation box max depth [m]
- Returns
- reference to this instance
References box_depth, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossBoxRange()
|
inline |
Configures the Woss channel simulation box max range
- Parameters
-
range simulation box max range [m]
- Returns
- reference to this instance
References box_range, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossClearWorkDir()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossControllerDebug()
|
inline |
Configures the WossController debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_controller_debug, and WossTest().
◆ setWossCreatorDebug()
|
inline |
Sets the WossCreator debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_creator_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossDbManagerDebug()
|
inline |
Sets the WossDbManager debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_db_manager_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossDebug()
|
inline |
Sets the Woss channel simulator debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossEvolutionTimeQuantum()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossFrequencyStep()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerDebug()
|
inline |
Configures the WossManager debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_manager_debug, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerSpaceSampling()
|
inline |
Configures the WossManager space sampling
- Parameters
-
sampling space sampling in [m]
- Returns
- reference to this instance
References woss_manager_space_sampling, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerThreads()
|
inline |
Configures the WossManager number of threads
- Parameters
-
threads number of threads
- Returns
- reference to this instance
References concurrent_threads, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerTimeEvoActive()
|
inline |
Configures the WossManager time evolution feature active
- Parameters
-
flag time evolution active flag
- Returns
- reference to this instance
References time_evolution_active, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerUseMultiThread()
|
inline |
Configures the WossManager multithread feature
- Parameters
-
flag use multithread flag
- Returns
- reference to this instance
References woss_manager_use_multithread, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossManagerUseThreadPool()
|
inline |
Configures the WossManager multithread thread pool flag
- Parameters
-
flag use threadpool flag
- Returns
- reference to this instance
References woss_manager_use_thread_pool, and WossTest().
Referenced by WossBellhopTest::doConfig().
◆ setWossMaxAngle()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossMinAngle()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossNormalizedSspDepthSteps()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossRandomGenStream()
|
inline |
Sets the woss::RandomGenerator stream/seed value
- Parameters
-
stream seed/stream value
- Returns
- reference to this instance
References woss_random_gen_stream, and WossTest().
Referenced by WossBellhopScript::doConfig(), WossBellhopTest::doConfig(), and WossUnitTest::testSettings().
◆ setWossRxMaxDepthOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossRxMaxRangeOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossRxMinDepthOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossRxMinRangeOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossSimTime()
- Parameters
-
time bellhop simulation times
- Returns
- reference to this instance
References sim_time, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossSspDepthPrecision()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTestDebug()
|
inline |
Sets the WossTest object debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References debug, and WossTest().
Referenced by WossBellhopTest::doConfig(), WossUnitTest::doConfig(), and main().
◆ setWossTotalRangeSteps()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTotalRays()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTotalRuns()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTotalRxDepths()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTotalRxRanges()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTotalTransmitters()
|
inline |
Configures the Woss channel simulator number of transmitters
- Parameters
-
transmitters number of transmitters
- Returns
- reference to this instance
References total_transmitters, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTransducerHandlerDebug()
|
inline |
Configures the WossTransducerHander debug flag
- Parameters
-
flag debug flag
- Returns
- reference to this instance
References woss_transducer_handler_debug, and WossTest().
◆ setWossTxMaxDepthOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossTxMinDepthOffset()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossUseThorpeAtt()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
◆ setWossWorkDirPath()
|
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, and WossTest().
Referenced by WossBellhopScript::doConfig(), and WossBellhopTest::doConfig().
Member Data Documentation
◆ altim_bret_proto
|
protected |
AltimBretschneider prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ bathy_db_creator
|
protected |
the helper will automatically allocate the woss GEBCO bathymetry db creator
Referenced by init(), and 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
|
protected |
enable/disable the debug prints of the woss Bathymetry database (GEBCO).
Referenced by getBathyDbDebug(), init(), setBathyDbDebug(), and WossTest().
◆ bathy_db_file_path
|
protected |
setup the path of the woss GEBCO database
Referenced by getBathyDbFilePath(), init(), setBathyDbFilePath(), and WossTest().
◆ bathy_db_gebco_format
|
protected |
setup the the GEBCO database format
Referenced by getBathyDbGebcoFormat(), init(), setBathyDbGebcoFormat(), and WossTest().
◆ bellhop_altim_type
|
protected |
woss object configuration: Bellhop Altimetry type string
Referenced by getWossBellhopAltimType(), init(), setWossBellhopAltimType(), and WossTest().
◆ bellhop_arr_syntax
|
protected |
woss object configration: Bellhop Arr file syntax to be used during .arr file parsing
Referenced by getWossBellhopArraySyntax(), init(), setWossBellhopArraySyntax(), and WossTest().
◆ bellhop_bathy_method
|
protected |
woss object configuration: Bathymetry write method string
Referenced by getWossBellhopBathyMethod(), init(), setWossBellhopBathyMethod(), and WossTest().
◆ bellhop_bathy_type
|
protected |
woss object configuration: Bellhop bathymetry type string
Referenced by getWossBellhopBathyType(), init(), setWossBellhopBathyType(), and WossTest().
◆ bellhop_beam_options
|
protected |
woss object configuration: Bellhop beam option string
Referenced by getWossBellhopBeamOptions(), init(), setWossBellhopBeamOptions(), and WossTest().
◆ bellhop_bin_name
|
protected |
woss object configuration: Bellhop binary name
Referenced by getWossBellhopBinName(), init(), setWossBellhopBinName(), and WossTest().
◆ bellhop_creator
|
protected |
the helper will automatically allocate the woss creator
Referenced by WossBellhopScript::doRun(), WossBellhopTest::doRun(), init(), and WossTest().
◆ bellhop_mode
|
protected |
woss object configuration: Bellhop mode string
Referenced by getWossBellhopMode(), init(), setWossBellhopMode(), and WossTest().
◆ bellhop_path
|
protected |
woss object configuration: path of the Bellhop executable
Referenced by getWossBellhopPath(), init(), setWossBellhopPath(), and WossTest().
◆ bellhop_shd_syntax
|
protected |
woss object configration: Bellhop Shd file syntax to be used during .shd file parsing
Referenced by getWossBellhopShdSyntax(), init(), setWossBellhopShdSyntax(), and WossTest().
◆ box_depth
|
protected |
woss object configuration: maximum depth to trace rays to; deeper rays will be ignored
Referenced by getWossBoxDepth(), init(), setWossBoxDepth(), and WossTest().
◆ box_range
|
protected |
woss object configuration: maximum range to trace rats to; longer rays will be ignored
Referenced by getWossBoxRange(), init(), setWossBoxRange(), and WossTest().
◆ concurrent_threads
|
protected |
number of concurrent threads (0 = auto).
Referenced by getWossManagerThreads(), init(), setWossManagerThreads(), and WossTest().
◆ debug
|
protected |
debug flag
Referenced by WossCoordDefTest::doBearingTests(), WossCoordDefTest::doCoordCartTests(), WossBellhopScript::doRun(), WossBellhopTest::doRun(), WossCoordDefTest::doRun(), WossUnitTest::doRun(), getWossTestDebug(), init(), setWossTestDebug(), WossUnitTest::testAltimetry(), WossUnitTest::testArrDataAndReaders(), WossUnitTest::testBellhopCreator(), WossUnitTest::testBellhopWoss(), WossUnitTest::testCoordZ(), WossUnitTest::testCustomDataContainer(), WossUnitTest::testDefHandler(), WossUnitTest::testExceptions(), WossUnitTest::testLocation(), WossUnitTest::testPDouble(), WossUnitTest::testPressure(), WossUnitTest::testRandomGenerator(), WossUnitTest::testResPressureDb(), WossUnitTest::testResTimeArrDb(), WossUnitTest::testSediment(), WossUnitTest::testSettings(), WossUnitTest::testShdDataAndReaders(), WossUnitTest::testSSP(), WossUnitTest::testThreadPool(), WossUnitTest::testTime(), WossUnitTest::testTimeArr(), WossUnitTest::testTimeReference(), WossUnitTest::testTransducer(), WossUnitTest::testTransducerHandler(), WossUnitTest::testWossCreatorContainer(), WossUnitTest::testWossDbManager(), and WossTest().
◆ def_handler
|
protected |
Definition Handler object allocated by the helper.
Referenced by init(), and WossTest().
◆ evolution_time_quantum
|
protected |
woss object configuration: evolution time quantum
Referenced by getWossEvolutionTimeQuantum(), init(), setWossEvolutionTimeQuantum(), and WossTest().
◆ frequency_step
|
protected |
woss object configuration: number of frequency steps
Referenced by getWossFrequencyStep(), init(), setWossFrequencyStep(), and WossTest().
◆ initialized
|
protected |
initialization complete flag.
Referenced by init(), and WossTest().
◆ location_proto
|
protected |
Location prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ max_angle
|
protected |
woss object configuration: maximum vertical angle in decimal degrees
Referenced by getWossMaxAngle(), init(), setWossMaxAngle(), and WossTest().
◆ min_angle
|
protected |
woss object configuration: minimum vertical angle in decimal degrees
Referenced by getWossMinAngle(), init(), setWossMinAngle(), and WossTest().
◆ normalized_ssp_depth_steps
|
protected |
woss object configuration: SSP depth quantization steps
Referenced by getWossNormalizedSspDepthSteps(), init(), setWossNormalizedSspDepthSteps(), and WossTest().
◆ pressure_proto
|
protected |
Pressure prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ random_gen_proto
|
protected |
RandomGenerator prototype which will be plugged into the WOSS framework.
Referenced by init(), and WossTest().
◆ res_db_creator_debug
|
protected |
enable/disable the debug prints of the woss results database creator.
Referenced by getResDbCreatorDebug(), init(), setResDbCreatorDebug(), and WossTest().
◆ res_db_creator_press_bin
|
protected |
the helper will automatically allocate the desired result database creator based on current configuration.
Referenced by init(), and WossTest().
◆ res_db_creator_press_txt
|
protected |
the helper will automatically allocate the desired result database creator based on current configuration.
Referenced by init(), and 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(), and 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(), and WossTest().
◆ res_db_debug
|
protected |
enable/disable the debug prints of the woss result databases.
Referenced by getResDbDebug(), init(), setResDbDebug(), and WossTest().
◆ res_db_file_name
|
protected |
set up the woss result database file name (without path)
Referenced by getResDbFileName(), init(), setResDbFileName(), and WossTest().
◆ res_db_file_path
|
protected |
set up the woss result database file path
Referenced by getResDbFilePath(), init(), setResDbFilePath(), and WossTest().
◆ res_db_space_sampling
|
protected |
set up the woss result database 2D spatial sampling
Referenced by getResDbSpaceSampling(), setResDbSpaceSampling(), and WossTest().
◆ res_db_use_binary
|
protected |
set up the woss result database format: binary or textual.
Referenced by getResDbUseBinary(), init(), setResDbUseBinary(), and WossTest().
◆ res_db_use_pressure
|
protected |
set up the woss result databases data format: single pressure tap.
Referenced by getResDbUsePressure(), init(), setResDbUsePressure(), and WossTest().
◆ res_db_use_time_arr
|
protected |
set up the woss result databases data format: power delay profile.
Referenced by getResDbUseTimeArr(), init(), setResDbUseTimeArr(), and WossTest().
◆ rx_max_depth_offset
|
protected |
woss object configuration: receiver max depth offset in meters
Referenced by getWossRxMaxDepthOffset(), init(), setWossRxMaxDepthOffset(), and WossTest().
◆ rx_max_range_offset
|
protected |
woss object configuration: receiver max range offset in meters
Referenced by getWossRxMaxRangeOffset(), init(), setWossRxMaxRangeOffset(), and WossTest().
◆ rx_min_depth_offset
|
protected |
woss object configuration: receiver min depth offset in meters
Referenced by getWossRxMinDepthOffset(), init(), setWossRxMinDepthOffset(), and WossTest().
◆ rx_min_range_offset
|
protected |
woss object configuration: receiver min range offset in meters
Referenced by getWossRxMinRangeOffset(), init(), setWossRxMinRangeOffset(), and 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(), setSedimDbCoordFilePath(), and WossTest().
◆ sedim_db_creator
|
protected |
the helper will automatically allocate the woss sediment database creator
Referenced by init(), and WossTest().
◆ sedim_db_creator_debug
|
protected |
enable/disable the debug prints of the woss sediment database creator.
Referenced by getSedimDbCreatorDebug(), init(), setSedimDbCreatorDebug(), and WossTest().
◆ sedim_db_debug
|
protected |
enable/disable the debug prints of the woss sediment database.
Referenced by getSedimDbDebug(), init(), setSedimDbDebug(), and 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(), setSedimDbMarsdenFilePath(), and 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(), setSedimDbMarsdenOneFilePath(), and WossTest().
◆ sedim_deck41_db_type
|
protected |
DECK41 db data format type.
Referenced by getSedimDeck41DbType(), init(), setSedimDeck41DbType(), and WossTest().
◆ sediment_proto
|
protected |
Sediment prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ sim_time
|
protected |
woss object configuration: woss simulation times (start and end sim times)
Referenced by getWossSimTime(), init(), setWossSimTime(), and WossTest().
◆ ssp_db_creator
|
protected |
the helper will automatically allocate the woss sediment database creator
Referenced by init(), and WossTest().
◆ ssp_db_creator_debug
|
protected |
enable/disable the debug prints of the woss SSP database creator.
Referenced by getSspDbCreatorDebug(), init(), setSspDbCreatorDebug(), and WossTest().
◆ ssp_db_debug
|
protected |
enable/disable the debug prints of the woss SSP database.
Referenced by getSspDbDebug(), init(), setSspDbDebug(), and WossTest().
◆ ssp_db_file_path
|
protected |
setup the path of the woss monthly SSP database indexed by geographical coordinates
Referenced by getSspDbFilePath(), init(), setSspDbFilePath(), and WossTest().
◆ ssp_depth_precision
|
protected |
woss object configuration: SSP depth precision in meters
Referenced by getWossSspDepthPrecision(), init(), setWossSspDepthPrecision(), and WossTest().
◆ ssp_proto
|
protected |
SSP prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ ssp_woa_db_type
|
protected |
WOA SSP Db Type.
Referenced by getSspWoaDbType(), setSspWoaDbType(), and WossTest().
◆ time_arr_proto
|
protected |
TimeArr prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ time_evolution_active
|
protected |
enable/disable the time evolution feature.
Referenced by getWossManagerTimeEvoActive(), init(), setWossManagerTimeEvoActive(), and WossTest().
◆ time_ref_proto
|
protected |
TimeReference prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ total_range_steps
|
protected |
woss object configuration: tx - rx range sampling in meters
Referenced by getWossTotalRangeSteps(), init(), setWossTotalRangeSteps(), and WossTest().
◆ total_rays
|
protected |
woss object configuration: total number of rays (0 = automatic)
Referenced by getWossTotalRays(), init(), setWossTotalRays(), and WossTest().
◆ total_runs
|
protected |
woss object configuration: total number of channel simulator runs
Referenced by getWossTotalRuns(), init(), setWossTotalRuns(), and WossTest().
◆ total_rx_depths
|
protected |
woss object configuration: receiver depth sampling
Referenced by getWossTotalRxDepths(), init(), setWossTotalRxDepths(), and WossTest().
◆ total_rx_ranges
|
protected |
woss object configuration: receiver range sampling
Referenced by getWossTotalRxRanges(), init(), setWossTotalRxRanges(), and WossTest().
◆ total_transmitters
|
protected |
woss object configuration: total number of transmitting sources
Referenced by getWossTotalTransmitters(), init(), setWossTotalTransmitters(), and WossTest().
◆ transducer_proto
|
protected |
Transducer prototype which will be plugged into the WOSS framework.
Referenced by WossTest().
◆ tx_max_depth_offset
|
protected |
woss object configuration: transmitter max offset in meters
Referenced by getWossTxMaxDepthOffset(), init(), setWossTxMaxDepthOffset(), and WossTest().
◆ tx_min_depth_offset
|
protected |
woss object configuration: transmitter min offset in meters
Referenced by getWossTxMinDepthOffset(), init(), setWossTxMinDepthOffset(), and WossTest().
◆ use_thorpe_att
|
protected |
woss object configuration: use thorpe attenuation in channel computation
Referenced by getWossUseThorpeAtt(), init(), setWossUseThorpeAtt(), and WossTest().
◆ work_dir_path
|
protected |
woss object configuration: path of the temporary directory
Referenced by getWossWorkDirPath(), init(), setWossWorkDirPath(), and WossTest().
◆ woss_clear_work_dir
|
protected |
woss object configuration: clear the temporary files created by the underlying channel simulator
Referenced by getWossClearWorkDir(), init(), setWossClearWorkDir(), and WossTest().
◆ woss_controller
|
protected |
the helper will automatically allocate the woss controller.
Referenced by WossBellhopScript::doRun(), WossBellhopTest::doRun(), init(), and WossTest().
◆ woss_controller_debug
|
protected |
enable/disable the debug prints of the woss conteroller
Referenced by getWossControllerDebug(), setWossControllerDebug(), and WossTest().
◆ woss_creator_debug
|
protected |
enable/disable the debug prints of the woss creator.
Referenced by getWossCreatorDebug(), init(), setWossCreatorDebug(), and WossTest().
◆ woss_db_manager
|
protected |
the helper will automatically allocate the woss DB manager
Referenced by WossBellhopScript::doInit(), WossBellhopTest::doInit(), init(), and WossTest().
◆ woss_db_manager_debug
|
protected |
enable/disable the debug prints of the woss DB manager object.
Referenced by getWossDbManagerDebug(), init(), setWossDbManagerDebug(), and WossTest().
◆ woss_debug
|
protected |
enable/disable the debug prints of all woss objects
Referenced by getWossDebug(), init(), setWossDebug(), and WossTest().
◆ woss_manager_debug
|
protected |
enable/disable the debug prints of the woss manager.
Referenced by getWossManagerDebug(), init(), setWossManagerDebug(), and WossTest().
◆ woss_manager_multi
|
protected |
the helper will automatically allocate the desired woss manaeger based on current configuration.
Referenced by init(), and WossTest().
◆ woss_manager_simple
|
protected |
the helper will automatically allocate the desired woss manager based on current configuration.
Referenced by init(), and WossTest().
◆ woss_manager_space_sampling
|
protected |
woss manager space sampling in meters
Referenced by getWossManagerSpaceSampling(), init(), setWossManagerSpaceSampling(), and WossTest().
◆ woss_manager_use_multithread
|
protected |
enable/disable the multithread feature
Referenced by getWossManagerUseMultiThread(), init(), setWossManagerUseMultiThread(), and WossTest().
◆ woss_manager_use_thread_pool
|
protected |
enable/disable woss::ThreadPool usage
Referenced by getWossManagerUseThreadPool(), init(), setWossManagerUseThreadPool(), and WossTest().
◆ woss_random_gen_stream
|
protected |
random generator used by the WOSS framework.
Referenced by getWossRandomGenStream(), init(), setWossRandomGenStream(), and WossTest().
◆ woss_transducer_handler
|
protected |
the helper will automatically allocate the woss Transducer handler.
Referenced by init(), and WossTest().
◆ woss_transducer_handler_debug
|
protected |
enable/disable the debug prints of the woss transducer handler.
Referenced by getWossTransducerHandlerDebug(), init(), setWossTransducerHandlerDebug(), and WossTest().
The documentation for this class was generated from the following files:
- tests/woss-test.h
- tests/woss-test.cpp
