class that provides correctly initialized BellhopWoss objects More...
#include <bellhop-creator.h>
Public Types | |
| using | CCAngles = WossCreatorContainer< CustomAngles > |
| using | CCTransducer = WossCreatorContainer< CustomTransducer > |
| using | CCString = WossCreatorContainer< std::string > |
Protected Member Functions | |
| virtual bool | initializeWoss (Woss &woss_ref) const override |
| bool | initializeBhWoss (BellhopWoss &woss_ref) const |
| virtual void | updateDebugFlag () override |
Additional Inherited Members | |
| Protected Types inherited from woss::WossCreator | |
| using | CCSimTime = WossCreatorContainer< SimTime > |
| using | CCDouble = WossCreatorContainer< double > |
| using | CCInt = WossCreatorContainer< int > |
Detailed Description
class that provides correctly initialized BellhopWoss objects
BellhopCreator implements WossCreator and provides interface for creation and initializiation of BellhopWoss object
Member Typedef Documentation
◆ CCAngles
CustomAngles container. A map that links a valid CoordZ (transmitter) with its CustomAngles
◆ CCString
| using woss::BellhopCreator::CCString = WossCreatorContainer< std::string > |
◆ CCTransducer
Constructor & Destructor Documentation
◆ BellhopCreator()
| BellhopCreator::BellhopCreator | ( | ) |
BellhopCreator default constructor
References bellhop_arr_syntax, bellhop_bin_name, bellhop_path, bellhop_shd_syntax, ccaltimetry_type, ccangles_map, ccbathymetry_method, ccbathymetry_type, ccbeam_options, ccbellhop_mode, ccbox_depth, ccbox_range, ccnormalized_ssp_depth_steps, ccrx_max_depth_offset, ccrx_max_range_offset, ccrx_min_depth_offset, ccrx_min_range_offset, ccssp_depth_precision, cctotal_range_steps, cctotal_rays, cctotal_rx_depths, cctotal_rx_ranges, cctotal_transmitters, cctransducer, cctx_max_depth_offset, cctx_min_depth_offset, updateDebugFlag(), use_thorpe_att, and woss::WossCreator::WossCreator().
Referenced by eraseAltimetryType(), eraseAltimetryType(), eraseAngles(), eraseAngles(), eraseBathymetryMethod(), eraseBathymetryMethod(), eraseBathymetryType(), eraseBathymetryType(), eraseBeamOptions(), eraseBeamOptions(), eraseBhMode(), eraseBhMode(), eraseBoxDepth(), eraseBoxDepth(), eraseBoxRange(), eraseBoxRange(), eraseCustomTransducer(), eraseCustomTransducer(), eraseRaysNumber(), eraseRaysNumber(), eraseRxMaxDepthOffset(), eraseRxMaxDepthOffset(), eraseRxMaxRangeOffset(), eraseRxMaxRangeOffset(), eraseRxMinDepthOffset(), eraseRxMinDepthOffset(), eraseRxMinRangeOffset(), eraseRxMinRangeOffset(), eraseRxTotalDepths(), eraseRxTotalDepths(), eraseRxTotalRanges(), eraseRxTotalRanges(), eraseSspDepthPrecision(), eraseSspDepthPrecision(), eraseSspDepthSteps(), eraseSspDepthSteps(), eraseTotalRangeSteps(), eraseTotalRangeSteps(), eraseTotalTransmitters(), eraseTotalTransmitters(), eraseTxMaxDepthOffset(), eraseTxMaxDepthOffset(), eraseTxMinDepthOffset(), eraseTxMinDepthOffset(), setAltimetryType(), setAltimetryType(), setAngles(), setAngles(), setBathymetryMethod(), setBathymetryMethod(), setBathymetryType(), setBathymetryType(), setBeamOptions(), setBeamOptions(), setBellhopArrSyntax(), setBellhopBinName(), setBellhopPath(), setBellhopShdSyntax(), setBhMode(), setBhMode(), setBoxDepth(), setBoxDepth(), setBoxRange(), setBoxRange(), setCustomTransducer(), setCustomTransducer(), setRaysNumber(), setRaysNumber(), setRxMaxDepthOffset(), setRxMaxDepthOffset(), setRxMaxRangeOffset(), setRxMaxRangeOffset(), setRxMinDepthOffset(), setRxMinDepthOffset(), setRxMinRangeOffset(), setRxMinRangeOffset(), setRxTotalDepths(), setRxTotalDepths(), setRxTotalRanges(), setRxTotalRanges(), setSspDepthPrecision(), setSspDepthPrecision(), setSspDepthSteps(), setSspDepthSteps(), setThorpeAttFlag(), setTotalRangeSteps(), setTotalRangeSteps(), setTotalTransmitters(), setTotalTransmitters(), setTxMaxDepthOffset(), setTxMaxDepthOffset(), setTxMinDepthOffset(), and setTxMinDepthOffset().
◆ ~BellhopCreator()
|
overridevirtualdefault |
Member Function Documentation
◆ createWoss()
|
overridevirtual |
Returns a pointer to valid BellhopWoss for given parameters
- Parameters
-
tx const reference to a valid CoordZ object ( transmitter ) rx const reference to a valid CoordZ object ( receiver ) start_freq start frequency [Hz] end_freq end frequency [Hz]
- Returns
- a std::unique_ptr to a properly initialized woss::Woss object
Implements woss::WossCreator.
References woss::SimTime::end_time, woss::WossCreator::getFrequencyStep(), woss::WossCreator::getSimTime(), initializeBhWoss(), woss::Time::isValid(), and woss::SimTime::start_time.
◆ eraseAltimetryType() [1/2]
|
inline |
Erases the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccaltimetry_type.
◆ eraseAltimetryType() [2/2]
|
inline |
Erases the altimetry type ( L, C ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccaltimetry_type.
◆ eraseAngles() [1/2]
|
inline |
Erases the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccangles_map.
◆ eraseAngles() [2/2]
|
inline |
Erases the CustomAngles for given transmitter CoordZ, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< CustomAngles >::ALL_LOCATIONS, BellhopCreator(), and ccangles_map.
◆ eraseBathymetryMethod() [1/2]
|
inline |
Erases the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbathymetry_method.
◆ eraseBathymetryMethod() [2/2]
|
inline |
Erases the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbathymetry_method.
◆ eraseBathymetryType() [1/2]
|
inline |
Erases the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbathymetry_type.
◆ eraseBathymetryType() [2/2]
|
inline |
Erases the bathymetry type ( L, C ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbathymetry_type.
◆ eraseBeamOptions() [1/2]
|
inline |
Erases the beam option string for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbeam_options.
◆ eraseBeamOptions() [2/2]
|
inline |
Erases the beam option string for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbeam_options.
◆ eraseBhMode() [1/2]
|
inline |
Erases the Bellhop run mode string for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbellhop_mode.
◆ eraseBhMode() [2/2]
|
inline |
Erases the Bellhop run mode string for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbellhop_mode.
◆ eraseBoxDepth() [1/2]
|
inline |
Erases the maximum box depth [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbox_depth.
◆ eraseBoxDepth() [2/2]
|
inline |
Erases the receiver box depth [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccbox_depth.
◆ eraseBoxRange() [1/2]
|
inline |
Erases the maximum box depth [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbox_range.
◆ eraseBoxRange() [2/2]
|
inline |
Erases the receiver box depth [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccbox_range.
◆ eraseCustomTransducer() [1/2]
|
inline |
Erases the woss::Transducer for given transmitter woss::CoordZ, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccangles_map.
◆ eraseCustomTransducer() [2/2]
|
inline |
Erases the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< CustomTransducer >::ALL_LOCATIONS, BellhopCreator(), and cctransducer.
◆ eraseRaysNumber() [1/2]
|
inline |
Erases the number of launched rays for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rays.
Referenced by WossUnitTest::testBellhopCreator().
◆ eraseRaysNumber() [2/2]
|
inline |
Erases the number of launched rays for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rays.
◆ eraseRxMaxDepthOffset() [1/2]
|
inline |
Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_max_depth_offset.
◆ eraseRxMaxDepthOffset() [2/2]
|
inline |
Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_max_depth_offset.
◆ eraseRxMaxRangeOffset() [1/2]
|
inline |
Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_max_range_offset.
◆ eraseRxMaxRangeOffset() [2/2]
|
inline |
Erases the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_max_range_offset.
◆ eraseRxMinDepthOffset() [1/2]
|
inline |
Erases the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_min_depth_offset.
◆ eraseRxMinDepthOffset() [2/2]
|
inline |
Erases the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_min_depth_offset.
◆ eraseRxMinRangeOffset() [1/2]
|
inline |
Erases the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_min_range_offset.
◆ eraseRxMinRangeOffset() [2/2]
|
inline |
Erases the receiver mimimum range offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_min_range_offset.
◆ eraseRxTotalDepths() [1/2]
|
inline |
Erases the number of receiver depths for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rx_depths.
◆ eraseRxTotalDepths() [2/2]
|
inline |
Erases the number of receiver depths for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rx_depths.
◆ eraseRxTotalRanges() [1/2]
|
inline |
Erases the number of receiver ranges for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rx_ranges.
◆ eraseRxTotalRanges() [2/2]
|
inline |
Erases the number of receiver ranges for given transmitter, receiver woss::Location
- Parameters
-
tx const reference to a valid woss::Location instance rx const reference to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rx_ranges.
◆ eraseSspDepthPrecision() [1/2]
|
inline |
Erases the SSP depth precision [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccssp_depth_precision.
◆ eraseSspDepthPrecision() [2/2]
|
inline |
Erases the SSP depth precision [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccssp_depth_precision.
◆ eraseSspDepthSteps() [1/2]
|
inline |
Erases depth steps for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccnormalized_ssp_depth_steps.
◆ eraseSspDepthSteps() [2/2]
|
inline |
Erases depth steps for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and ccnormalized_ssp_depth_steps.
◆ eraseTotalRangeSteps() [1/2]
|
inline |
Erases the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_range_steps.
◆ eraseTotalRangeSteps() [2/2]
|
inline |
Erases the total range steps of bellhop simulation for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_range_steps.
◆ eraseTotalTransmitters() [1/2]
|
inline |
Erases the number of transmitters for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_transmitters.
◆ eraseTotalTransmitters() [2/2]
|
inline |
Erases the number of transmitters for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_transmitters.
◆ eraseTxMaxDepthOffset() [1/2]
|
inline |
Erases the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctx_max_depth_offset.
◆ eraseTxMaxDepthOffset() [2/2]
|
inline |
Erases the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and cctx_max_depth_offset.
◆ eraseTxMinDepthOffset() [1/2]
|
inline |
Erases mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctx_min_depth_offset.
◆ eraseTxMinDepthOffset() [2/2]
|
inline |
Erases mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and cctx_min_depth_offset.
◆ getAltimetryType() [1/2]
|
inline |
Returns the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- altimetry type
References ccaltimetry_type.
◆ getAltimetryType() [2/2]
|
inline |
Sets the altimetry type ( L, C ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- altimetry type
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, and ccaltimetry_type.
◆ getAngles() [1/2]
|
inline |
Returns the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- a valid CustomAngles
References ccangles_map.
◆ getAngles() [2/2]
|
inline |
Returns the CustomAngles for given transmitter CoordZ, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- a valid CustomAngles
References woss::WossCreatorContainer< CustomAngles >::ALL_LOCATIONS, and ccangles_map.
◆ getBathymetryMethod() [1/2]
|
inline |
Returns the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- bathymetry type
References ccbathymetry_method.
◆ getBathymetryMethod() [2/2]
|
inline |
Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- bathymetry type
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, and ccbathymetry_method.
◆ getBathymetryType() [1/2]
|
inline |
Returns the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- bathymetry type
References ccbathymetry_type.
◆ getBathymetryType() [2/2]
|
inline |
Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- bathymetry type
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, and ccbathymetry_type.
◆ getBeamOptions() [1/2]
|
inline |
Returns the beam option string for given transmitter, receiver woss::CoordZ
- Parameters
-
rx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- beam options
References ccbeam_options.
◆ getBeamOptions() [2/2]
|
inline |
Returns the beam option string for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- beam options
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, and ccbeam_options.
◆ getBellhopArrSyntax()
|
inline |
◆ getBellhopBinName()
|
inline |
Gets the Bellhop binary name
- Returns
- Bellhop binary name
References bellhop_bin_name.
Referenced by WossUnitTest::testBellhopCreator().
◆ getBellhopPath()
|
inline |
Gets the path of bellhop program
- Returns
- path string
References bellhop_path.
Referenced by WossUnitTest::testBellhopCreator().
◆ getBellhopShdSyntax()
|
inline |
◆ getBhMode() [1/2]
Returns the Bellhop run mode string for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- Bellhop run mode
References ccbellhop_mode.
◆ getBhMode() [2/2]
|
inline |
Returns the Bellhop run mode string for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- Bellhop run mode
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, and ccbellhop_mode.
◆ getBoxDepth() [1/2]
Returns the maximum box depth [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccbox_depth.
◆ getBoxDepth() [2/2]
|
inline |
Returns the maximum box depth [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccbox_depth.
◆ getBoxRange() [1/2]
Returns the maximum box depth [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccbox_range.
◆ getBoxRange() [2/2]
|
inline |
Returns the maximum box depth [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccbox_range.
◆ getCustomTransducer() [1/2]
|
inline |
Returns the woss::Transducer for given transmitter CoordZ, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- a valid woss::Transducer
References cctransducer.
◆ getCustomTransducer() [2/2]
|
inline |
Returns the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- a valid woss::Transducer
References woss::WossCreatorContainer< CustomTransducer >::ALL_LOCATIONS, and cctransducer.
◆ getRaysNumber() [1/2]
Returns the number of launched rays for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- number of launched rays
References cctotal_rays.
Referenced by WossUnitTest::testBellhopCreator().
◆ getRaysNumber() [2/2]
|
inline |
Returns the number of launched rays for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- number of launched rays
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and cctotal_rays.
◆ getRxMaxDepthOffset() [1/2]
|
inline |
Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccrx_max_depth_offset.
◆ getRxMaxDepthOffset() [2/2]
|
inline |
Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccrx_max_depth_offset.
◆ getRxMaxRangeOffset() [1/2]
|
inline |
Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccrx_max_range_offset.
◆ getRxMaxRangeOffset() [2/2]
|
inline |
Returns the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccrx_max_range_offset.
◆ getRxMinDepthOffset() [1/2]
|
inline |
Returns the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccrx_min_depth_offset.
◆ getRxMinDepthOffset() [2/2]
|
inline |
Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccrx_min_depth_offset.
◆ getRxMinRangeOffset() [1/2]
|
inline |
Returns the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccrx_min_range_offset.
◆ getRxMinRangeOffset() [2/2]
|
inline |
Returns the receiver mimimum range offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccrx_min_range_offset.
◆ getRxTotalDepths() [1/2]
Gets the number of receiver depths for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- number of receiver depths
References cctotal_rx_depths.
◆ getRxTotalDepths() [2/2]
|
inline |
Sets the number of receiver depths for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- number of receiver depths
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and cctotal_rx_depths.
◆ getRxTotalRanges() [1/2]
Returns the number of receiver ranges for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- number of receiver ranges
References cctotal_rx_ranges.
◆ getRxTotalRanges() [2/2]
|
inline |
Returns the number of receiver ranges for given transmitter, receiver woss::Location
- Parameters
-
tx const reference to a valid woss::Location instance rx const reference to a valid woss::Location instance
- Returns
- number of receiver ranges
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and cctotal_rx_ranges.
◆ getSspDepthPrecision() [1/2]
|
inline |
Returns the SSP depth precision [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References ccssp_depth_precision.
◆ getSspDepthPrecision() [2/2]
|
inline |
Returns the SSP depth precision [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and ccssp_depth_precision.
◆ getSspDepthSteps() [1/2]
Returns depth steps for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance tx const reference to a valid woss::CoordZ instance
- Returns
- integer value
References ccnormalized_ssp_depth_steps.
◆ getSspDepthSteps() [2/2]
|
inline |
Returns depth steps for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance tx const pointer to a valid woss::Location instance
- Returns
- integer value
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and ccnormalized_ssp_depth_steps.
◆ getThorpeAttFlag()
|
inline |
Gets the Thorpe attenuation flag for all bellhop instances
- Returns
- boolean flag
References use_thorpe_att.
Referenced by WossUnitTest::testBellhopCreator().
◆ getTotalRangeSteps() [1/2]
|
inline |
Returns the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- int value
References cctotal_range_steps.
◆ getTotalRangeSteps() [2/2]
|
inline |
Returns the total range steps of bellhop simulation for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- int value
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and cctotal_range_steps.
◆ getTotalTransmitters() [1/2]
|
inline |
Returns the number of transmitters for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- total number of transmitter sources
References cctotal_transmitters.
◆ getTotalTransmitters() [2/2]
|
inline |
Returns the number of transmitters for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- total number of transmitter sources
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, and cctotal_transmitters.
◆ getTxMaxDepthOffset() [1/2]
|
inline |
Gets the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References cctx_max_depth_offset.
◆ getTxMaxDepthOffset() [2/2]
|
inline |
Gets the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and cctx_max_depth_offset.
◆ getTxMinDepthOffset() [1/2]
|
inline |
Returns mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References cctx_min_depth_offset.
Referenced by WossUnitTest::testBellhopCreator().
◆ getTxMinDepthOffset() [2/2]
|
inline |
Returns mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, and cctx_min_depth_offset.
◆ initializeBhWoss()
|
protected |
Initializes given BellhopWoss object
- Parameters
-
woss_ref ref to an unitialized BellhopWoss
- Returns
- true if method succeeded, false otherwise
References woss::CustomTransducer::add_costant, bellhop_arr_syntax, bellhop_bin_name, bellhop_path, bellhop_shd_syntax, ccaltimetry_type, ccangles_map, ccbathymetry_method, ccbathymetry_type, ccbeam_options, ccbellhop_mode, ccbox_depth, ccbox_range, ccnormalized_ssp_depth_steps, ccrx_max_depth_offset, ccrx_max_range_offset, ccrx_min_depth_offset, ccrx_min_range_offset, ccssp_depth_precision, cctotal_range_steps, cctotal_rays, cctotal_rx_depths, cctotal_rx_ranges, cctotal_transmitters, cctransducer, cctx_max_depth_offset, cctx_min_depth_offset, woss::Woss::getRxCoordZ(), woss::Woss::getTxCoordZ(), woss::CustomTransducer::initial_bearing, woss::CustomTransducer::initial_horiz_rotation, woss::CustomTransducer::initial_vert_rotation, initializeWoss(), woss::CustomTransducer::multiply_costant, woss::BellhopWoss::setAltimetryType(), woss::BellhopWoss::setBathymetryMethod(), woss::BellhopWoss::setBathymetryType(), woss::BellhopWoss::setBeamOptions(), woss::BellhopWoss::setBeamPatternParam(), woss::BellhopWoss::setBellhopArrSyntax(), woss::BellhopWoss::setBellhopBinName(), woss::BellhopWoss::setBellhopPath(), woss::BellhopWoss::setBellhopShdSyntax(), woss::BellhopWoss::setBhMode(), woss::BellhopWoss::setBoxDepth(), woss::BellhopWoss::setBoxRange(), woss::BellhopWoss::setMaxAngle(), woss::BellhopWoss::setMinAngle(), woss::ACToolboxWoss::setRangeSteps(), woss::BellhopWoss::setRaysNumber(), woss::BellhopWoss::setRxMaxDepthOffset(), woss::BellhopWoss::setRxMaxRangeOffset(), woss::BellhopWoss::setRxMinDepthOffset(), woss::BellhopWoss::setRxMinRangeOffset(), woss::BellhopWoss::setRxTotalDepths(), woss::BellhopWoss::setRxTotalRanges(), woss::ACToolboxWoss::setSSPDepthPrecision(), woss::BellhopWoss::setThorpeAttFlag(), woss::BellhopWoss::setTotalTransmitters(), woss::BellhopWoss::setTransducer(), woss::BellhopWoss::setTransformSSPDepthSteps(), woss::BellhopWoss::setTxMaxDepthOffset(), woss::BellhopWoss::setTxMinDepthOffset(), woss::WossCreator::transducer_handler, woss::CustomTransducer::type, and use_thorpe_att.
Referenced by createWoss().
◆ initializeWoss()
|
overrideprotectedvirtual |
Initializes given BellhopWoss object
- Parameters
-
woss_ref ref to an unitialized BellhopWoss
- Returns
- true if method succeeded, false otherwise
Implements woss::WossCreator.
References woss::Woss::initialize(), and woss::WossCreator::initializeWoss().
Referenced by initializeBhWoss().
◆ setAltimetryType() [1/2]
|
inline |
Sets the altimetry type ( L, C ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info
- Parameters
-
type altimetry type tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccaltimetry_type.
◆ setAltimetryType() [2/2]
|
inline |
Sets the altimetry type ( L, C ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info
- Parameters
-
type altimetry types tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccaltimetry_type.
◆ setAngles() [1/2]
|
inline |
Sets the CustomAngles for given transmitter CoordZ, receiver woss::CoordZ
- Parameters
-
angles const reference to a valid CustomAngles tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccangles_map.
◆ setAngles() [2/2]
|
inline |
Sets the CustomAngles for given transmitter CoordZ, receiver woss::Location
- Parameters
-
angles const reference to a valid CustomAngles tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< CustomAngles >::ALL_LOCATIONS, BellhopCreator(), and ccangles_map.
◆ setBathymetryMethod() [1/2]
|
inline |
Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info
- Parameters
-
type bathymetry write method tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbathymetry_method.
◆ setBathymetryMethod() [2/2]
|
inline |
Sets the bathymetry write method ( S, D ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info
- Parameters
-
type bathymetry types tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbathymetry_method.
◆ setBathymetryType() [1/2]
|
inline |
Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info
- Parameters
-
type bathymetry type tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbathymetry_type.
◆ setBathymetryType() [2/2]
|
inline |
Sets the bathymetry type ( L, C ) for given transmitter, receiver woss::Location. See Bellhop documentation for more info
- Parameters
-
type bathymetry types tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbathymetry_type.
◆ setBeamOptions() [1/2]
|
inline |
Sets the beam option string for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info
- Parameters
-
options beam options ( G, C, R , B) tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbeam_options.
◆ setBeamOptions() [2/2]
|
inline |
Sets the beam option string for given transmitter, receiver woss::Location. See Bellhop documentation for more info
- Parameters
-
options beam options ( G, C, R , B) tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbeam_options.
◆ setBellhopArrSyntax()
|
inline |
Sets the .arr file syntax to be used during file parsing
- Parameters
-
syntax .arr file syntax
- Returns
- reference to *this
References bellhop_arr_syntax, and BellhopCreator().
◆ setBellhopBinName()
|
inline |
Sets the Bellhop binary name
- Parameters
-
name Bellhop binary name
- Returns
- reference to *this
References bellhop_bin_name, and BellhopCreator().
Referenced by WossUnitTest::testBellhopCreator().
◆ setBellhopPath()
|
inline |
Sets the path of bellhop program
- Parameters
-
path filesystem path
- Returns
- reference to *this
References bellhop_path, and BellhopCreator().
Referenced by WossUnitTest::testBellhopCreator().
◆ setBellhopShdSyntax()
|
inline |
Sets the .shd file syntax to be used during file parsing
- Parameters
-
syntax .arr file syntax
- Returns
- reference to *this
References bellhop_shd_syntax, and BellhopCreator().
◆ setBhMode() [1/2]
|
inline |
Sets the Bellhop run mode string for given transmitter, receiver woss::CoordZ. See Bellhop documentation for more info
- Parameters
-
mode Bellhop run mode ( A, a , C, I , S) tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbellhop_mode.
◆ setBhMode() [2/2]
|
inline |
Sets the Bellhop run mode string for given transmitter, receiver woss::Location. See Bellhop documentation for more info
- Parameters
-
mode Bellhop run mode ( A, a , C, I , S) tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< std::string >::ALL_LOCATIONS, BellhopCreator(), and ccbellhop_mode.
◆ setBoxDepth() [1/2]
|
inline |
Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
box_depth [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbox_depth.
◆ setBoxDepth() [2/2]
|
inline |
Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::Location
- Parameters
-
box_depth [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccbox_depth.
◆ setBoxRange() [1/2]
|
inline |
Sets the maximum Bellhop ray range [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
box_depth [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccbox_range.
◆ setBoxRange() [2/2]
|
inline |
Sets the maximum Bellhop ray depth [m] for given transmitter, receiver woss::Location
- Parameters
-
box_depth [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- value in meters
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccbox_range.
◆ setCustomTransducer() [1/2]
|
inline |
Sets the woss::Transducer for given transmitter woss::CoordZ, receiver woss::CoordZ
- Parameters
-
angles const reference to a valid woss::Transducer tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctransducer.
◆ setCustomTransducer() [2/2]
|
inline |
Sets the woss::Transducer for given transmitter woss::CoordZ, receiver woss::Location
- Parameters
-
angles const reference to a valid woss::Transducer tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< CustomTransducer >::ALL_LOCATIONS, BellhopCreator(), and cctransducer.
◆ setRaysNumber() [1/2]
|
inline |
Sets the number of launched rays for given transmitter, receiver woss::CoordZ
- Parameters
-
number number of launched rays (>= 0) tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rays.
Referenced by WossUnitTest::testBellhopCreator().
◆ setRaysNumber() [2/2]
|
inline |
Sets the number of launched rays for given transmitter, receiver woss::Location
- Parameters
-
number number of launched rays (>= 0) tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rays.
◆ setRxMaxDepthOffset() [1/2]
|
inline |
Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_max_depth_offset.
◆ setRxMaxDepthOffset() [2/2]
|
inline |
Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_max_depth_offset.
◆ setRxMaxRangeOffset() [1/2]
|
inline |
Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset -total_distance <= range offset <= total_distance [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References BellhopCreator(), and ccrx_max_range_offset.
◆ setRxMaxRangeOffset() [2/2]
|
inline |
Sets the receiver maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset -total_distance <= range offset <= total_distance [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_max_range_offset.
◆ setRxMinDepthOffset() [1/2]
|
inline |
Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_min_depth_offset.
◆ setRxMinDepthOffset() [2/2]
|
inline |
Sets the receiver mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_min_depth_offset.
◆ setRxMinRangeOffset() [1/2]
|
inline |
Sets the receiver mimimum range offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset -total_distance <= range offset <= total_distance [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and ccrx_min_range_offset.
◆ setRxMinRangeOffset() [2/2]
|
inline |
Sets the receiver mimimum range offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset -total_distance <= range offset <= total_distance [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccrx_min_range_offset.
◆ setRxTotalDepths() [1/2]
|
inline |
Sets the number of receiver depths for given transmitter, receiver woss::CoordZ
- Parameters
-
number number of receiver depths tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rx_depths.
◆ setRxTotalDepths() [2/2]
|
inline |
Sets the number of receiver depths for given transmitter, receiver woss::Location
- Parameters
-
number number of receiver depths tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rx_depths.
◆ setRxTotalRanges() [1/2]
|
inline |
Sets the number of receiver ranges for given transmitter, receiver woss::CoordZ
- Parameters
-
number number of receiver ranges tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_rx_ranges.
◆ setRxTotalRanges() [2/2]
|
inline |
Sets the number of receiver ranges for given transmitter, receiver woss::Location
- Parameters
-
number number of receiver ranges tx const reference to a valid woss::Location instance rx const reference to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_rx_ranges.
◆ setSspDepthPrecision() [1/2]
|
inline |
Sets the SSP depth precision [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
ssp_precision depth_precision [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References BellhopCreator(), and ccssp_depth_precision.
◆ setSspDepthPrecision() [2/2]
|
inline |
Sets the SSP depth precision [m] for given transmitter, receiver woss::Location
- Parameters
-
ssp_precision depth_precision [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and ccssp_depth_precision.
◆ setSspDepthSteps() [1/2]
|
inline |
Sets the SSP depth steps for given transmitter, receiver woss::CoordZ
- Parameters
-
ssp_depth_steps depth steps tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- value in meters
References BellhopCreator(), and ccnormalized_ssp_depth_steps.
◆ setSspDepthSteps() [2/2]
|
inline |
Sets the SSP depth steps for given transmitter, receiver woss::Location
- Parameters
-
ssp_depth_steps depth_precision [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and ccnormalized_ssp_depth_steps.
◆ setThorpeAttFlag()
|
inline |
Sets the Thorpe attenuation flag for all bellhop instances
- Parameters
-
flag boolean flag
- Returns
- reference to *this
References BellhopCreator(), and use_thorpe_att.
Referenced by WossUnitTest::testBellhopCreator().
◆ setTotalRangeSteps() [1/2]
|
inline |
Sets the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ
- Parameters
-
steps total range steps tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_range_steps.
◆ setTotalRangeSteps() [2/2]
|
inline |
Sets the total range steps of bellhop simulation for given transmitter, receiver woss::Location
- Parameters
-
steps total range steps tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_range_steps.
◆ setTotalTransmitters() [1/2]
|
inline |
Sets the number of transmitters for given transmitter, receiver woss::CoordZ
- Parameters
-
sources number of transmitters tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctotal_transmitters.
◆ setTotalTransmitters() [2/2]
|
inline |
Sets the number of transmitters for given transmitter, receiver woss::Location
- Parameters
-
sources number of transmitters tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< int >::ALL_LOCATIONS, BellhopCreator(), and cctotal_transmitters.
◆ setTxMaxDepthOffset() [1/2]
|
inline |
Sets the transmitter maximum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctx_max_depth_offset.
◆ setTxMaxDepthOffset() [2/2]
|
inline |
Sets the transmitter maximum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and cctx_max_depth_offset.
◆ setTxMinDepthOffset() [1/2]
|
inline |
Sets mimimum depth offset [m] for given transmitter, receiver woss::CoordZ
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References BellhopCreator(), and cctx_min_depth_offset.
Referenced by WossUnitTest::testBellhopCreator().
◆ setTxMinDepthOffset() [2/2]
|
inline |
Sets mimimum depth offset [m] for given transmitter, receiver woss::Location
- Parameters
-
offset 0 <= depth offset <= 0 [m] tx const pointer to a valid woss::Location instance rx const pointer to a valid woss::Location instance
- Returns
- reference to *this
References woss::WossCreatorContainer< double >::ALL_LOCATIONS, BellhopCreator(), and cctx_min_depth_offset.
◆ updateDebugFlag()
|
overrideprotectedvirtual |
Propagates the debug flag
Reimplemented from woss::WossCreator.
References ccaltimetry_type, ccangles_map, ccbathymetry_method, ccbathymetry_type, ccbeam_options, ccbellhop_mode, ccnormalized_ssp_depth_steps, ccrx_max_depth_offset, ccrx_max_range_offset, ccrx_min_depth_offset, ccrx_min_range_offset, ccssp_depth_precision, cctotal_range_steps, cctotal_rays, cctotal_rx_depths, cctotal_rx_ranges, cctotal_transmitters, cctransducer, cctx_max_depth_offset, cctx_min_depth_offset, woss::WossCreator::debug, and woss::WossCreator::updateDebugFlag().
Referenced by BellhopCreator().
Member Data Documentation
◆ bellhop_arr_syntax
|
protected |
Bellhop .arr file syntax to be used during parsing, factory value = invalid
Referenced by BellhopCreator(), getBellhopArrSyntax(), initializeBhWoss(), and setBellhopArrSyntax().
◆ bellhop_bin_name
|
protected |
Bellhop binary name
Referenced by BellhopCreator(), getBellhopBinName(), initializeBhWoss(), and setBellhopBinName().
◆ bellhop_path
|
protected |
Pathname of Bellhop program
Referenced by BellhopCreator(), getBellhopPath(), initializeBhWoss(), and setBellhopPath().
◆ bellhop_shd_syntax
|
protected |
Bellhop .shd file syntax to be used during parsing, factory value = invalid
Referenced by BellhopCreator(), getBellhopShdSyntax(), initializeBhWoss(), and setBellhopShdSyntax().
◆ ccaltimetry_type
|
protected |
Altimetry type ( L, C )
Referenced by BellhopCreator(), eraseAltimetryType(), eraseAltimetryType(), getAltimetryType(), getAltimetryType(), initializeBhWoss(), setAltimetryType(), setAltimetryType(), and updateDebugFlag().
◆ ccangles_map
|
protected |
CustomAngles containter for user-given transmitter CoordZ
Referenced by BellhopCreator(), eraseAngles(), eraseAngles(), eraseCustomTransducer(), getAngles(), getAngles(), initializeBhWoss(), setAngles(), setAngles(), and updateDebugFlag().
◆ ccbathymetry_method
|
protected |
Bathymetry write method ( S (slope), D (discrete )
Referenced by BellhopCreator(), eraseBathymetryMethod(), eraseBathymetryMethod(), getBathymetryMethod(), getBathymetryMethod(), initializeBhWoss(), setBathymetryMethod(), setBathymetryMethod(), and updateDebugFlag().
◆ ccbathymetry_type
|
protected |
Bathymetry type ( L, C )
Referenced by BellhopCreator(), eraseBathymetryType(), eraseBathymetryType(), getBathymetryType(), getBathymetryType(), initializeBhWoss(), setBathymetryType(), setBathymetryType(), and updateDebugFlag().
◆ ccbeam_options
|
protected |
Bellhop beam options ( G, C, R, B )
Referenced by BellhopCreator(), eraseBeamOptions(), eraseBeamOptions(), getBeamOptions(), getBeamOptions(), initializeBhWoss(), setBeamOptions(), setBeamOptions(), and updateDebugFlag().
◆ ccbellhop_mode
|
protected |
Bellhop run mode ( A, a, C, I, S )
Referenced by BellhopCreator(), eraseBhMode(), eraseBhMode(), getBhMode(), getBhMode(), initializeBhWoss(), setBhMode(), setBhMode(), and updateDebugFlag().
◆ ccbox_depth
|
protected |
Maximum Bellhop ray depth [m]
Referenced by BellhopCreator(), eraseBoxDepth(), eraseBoxDepth(), getBoxDepth(), getBoxDepth(), initializeBhWoss(), setBoxDepth(), and setBoxDepth().
◆ ccbox_range
|
protected |
Maximum Bellhop ray range [m]
Referenced by BellhopCreator(), eraseBoxRange(), eraseBoxRange(), getBoxRange(), getBoxRange(), initializeBhWoss(), setBoxRange(), and setBoxRange().
◆ ccnormalized_ssp_depth_steps
|
protected |
Depth steps of all SSP involved
Referenced by BellhopCreator(), eraseSspDepthSteps(), eraseSspDepthSteps(), getSspDepthSteps(), getSspDepthSteps(), initializeBhWoss(), setSspDepthSteps(), setSspDepthSteps(), and updateDebugFlag().
◆ ccrx_max_depth_offset
|
protected |
Receiver maximum depth offset [m]
Referenced by BellhopCreator(), eraseRxMaxDepthOffset(), eraseRxMaxDepthOffset(), getRxMaxDepthOffset(), getRxMaxDepthOffset(), initializeBhWoss(), setRxMaxDepthOffset(), setRxMaxDepthOffset(), and updateDebugFlag().
◆ ccrx_max_range_offset
|
protected |
Receiver maximum range offset [m]
Referenced by BellhopCreator(), eraseRxMaxRangeOffset(), eraseRxMaxRangeOffset(), getRxMaxRangeOffset(), getRxMaxRangeOffset(), initializeBhWoss(), setRxMaxRangeOffset(), setRxMaxRangeOffset(), and updateDebugFlag().
◆ ccrx_min_depth_offset
|
protected |
Receiver minimum depth offset [m]
Referenced by BellhopCreator(), eraseRxMinDepthOffset(), eraseRxMinDepthOffset(), getRxMinDepthOffset(), getRxMinDepthOffset(), initializeBhWoss(), setRxMinDepthOffset(), setRxMinDepthOffset(), and updateDebugFlag().
◆ ccrx_min_range_offset
|
protected |
Receiver minimum range offset [m]
Referenced by BellhopCreator(), eraseRxMinRangeOffset(), eraseRxMinRangeOffset(), getRxMinRangeOffset(), getRxMinRangeOffset(), initializeBhWoss(), setRxMinRangeOffset(), setRxMinRangeOffset(), and updateDebugFlag().
◆ ccssp_depth_precision
|
protected |
SSP depth precision [m]
Referenced by BellhopCreator(), eraseSspDepthPrecision(), eraseSspDepthPrecision(), getSspDepthPrecision(), getSspDepthPrecision(), initializeBhWoss(), setSspDepthPrecision(), setSspDepthPrecision(), and updateDebugFlag().
◆ cctotal_range_steps
|
protected |
Number ot range steps
Referenced by BellhopCreator(), eraseTotalRangeSteps(), eraseTotalRangeSteps(), getTotalRangeSteps(), getTotalRangeSteps(), initializeBhWoss(), setTotalRangeSteps(), setTotalRangeSteps(), and updateDebugFlag().
◆ cctotal_rays
|
protected |
Number of launched rays
Referenced by BellhopCreator(), eraseRaysNumber(), eraseRaysNumber(), getRaysNumber(), getRaysNumber(), initializeBhWoss(), setRaysNumber(), setRaysNumber(), and updateDebugFlag().
◆ cctotal_rx_depths
|
protected |
Number of receiver depths
Referenced by BellhopCreator(), eraseRxTotalDepths(), eraseRxTotalDepths(), getRxTotalDepths(), getRxTotalDepths(), initializeBhWoss(), setRxTotalDepths(), setRxTotalDepths(), and updateDebugFlag().
◆ cctotal_rx_ranges
|
protected |
Number of receiver ranges.
On some configuration (linux distribution / cpu ) bellhop will output an empty file with a value of total_rx_ranges = 1.
Referenced by BellhopCreator(), eraseRxTotalRanges(), eraseRxTotalRanges(), getRxTotalRanges(), getRxTotalRanges(), initializeBhWoss(), setRxTotalRanges(), setRxTotalRanges(), and updateDebugFlag().
◆ cctotal_transmitters
|
protected |
Number of transmitter
Referenced by BellhopCreator(), eraseTotalTransmitters(), eraseTotalTransmitters(), getTotalTransmitters(), getTotalTransmitters(), initializeBhWoss(), setTotalTransmitters(), setTotalTransmitters(), and updateDebugFlag().
◆ cctransducer
|
protected |
Transmitter beam pattern
Referenced by BellhopCreator(), eraseCustomTransducer(), getCustomTransducer(), getCustomTransducer(), initializeBhWoss(), setCustomTransducer(), setCustomTransducer(), and updateDebugFlag().
◆ cctx_max_depth_offset
|
protected |
Transmitter maximum depth offset [m]
Referenced by BellhopCreator(), eraseTxMaxDepthOffset(), eraseTxMaxDepthOffset(), getTxMaxDepthOffset(), getTxMaxDepthOffset(), initializeBhWoss(), setTxMaxDepthOffset(), setTxMaxDepthOffset(), and updateDebugFlag().
◆ cctx_min_depth_offset
|
protected |
Transmitter minimum depth offset [m]
Referenced by BellhopCreator(), eraseTxMinDepthOffset(), eraseTxMinDepthOffset(), getTxMinDepthOffset(), getTxMinDepthOffset(), initializeBhWoss(), setTxMinDepthOffset(), setTxMinDepthOffset(), and updateDebugFlag().
◆ use_thorpe_att
|
protected |
flag that control bellhop's thorpe calculation
Referenced by BellhopCreator(), getThorpeAttFlag(), initializeBhWoss(), and setThorpeAttFlag().
The documentation for this class was generated from the following files:
- woss/bellhop-creator.h
- woss/bellhop-creator.cpp
