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 woss::WossCreatorContainer< CustomTransducer >::accessAllLocations(), cctransducer, and updateDebugFlag().
◆ ~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 ccaltimetry_type, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccaltimetry_type, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbathymetry_method, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbathymetry_method, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbathymetry_type, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbathymetry_type, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbeam_options, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbeam_options, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbellhop_mode, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbellhop_mode, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbox_depth, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbox_depth, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbox_range, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccbox_range, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctransducer, and woss::WossCreatorContainer< CustomTransducer >::erase().
◆ 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 cctotal_rays, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_rays, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_rx_depths, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_rx_depths, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccssp_depth_precision, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccssp_depth_precision, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::erase().
◆ 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 ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_range_steps, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_range_steps, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_transmitters, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctotal_transmitters, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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 cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::erase().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccaltimetry_type, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbathymetry_method, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbathymetry_type, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbeam_options, and woss::WossCreatorContainer< Data >::get().
◆ getBellhopArrSyntax()
|
inline |
◆ getBellhopPath()
|
inline |
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbellhop_mode, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbox_depth, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccbox_range, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< CustomTransducer >::get().
◆ 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 cctransducer, and woss::WossCreatorContainer< CustomTransducer >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctotal_rays, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctotal_rx_depths, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccssp_depth_precision, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::get().
◆ getThorpeAttFlag()
|
inline |
Gets the Thorpe attenuation flag for all bellhop instances
- Returns
- boolean flag
References use_thorpe_att.
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctotal_range_steps, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctotal_transmitters, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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, and woss::WossCreatorContainer< Data >::get().
◆ 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 cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::get().
◆ 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_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::WossCreatorContainer< Data >::get(), woss::WossCreatorContainer< CustomTransducer >::get(), woss::Woss::getRxCoordZ(), woss::Woss::getTxCoordZ(), woss::CustomTransducer::initial_bearing, woss::CustomTransducer::initial_horiz_rotation, woss::CustomTransducer::initial_vert_rotation, initializeWoss(), woss::WossCreatorContainer< Data >::isEmpty(), woss::CustomAngles::max_angle, woss::CustomAngles::min_angle, woss::CustomTransducer::multiply_costant, woss::BellhopWoss::setAltimetryType(), woss::BellhopWoss::setBathymetryMethod(), woss::BellhopWoss::setBathymetryType(), woss::BellhopWoss::setBeamOptions(), woss::BellhopWoss::setBeamPatternParam(), woss::BellhopWoss::setBellhopArrSyntax(), 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 ccaltimetry_type, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccaltimetry_type, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccangles_map, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbathymetry_method, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbathymetry_method, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbathymetry_type, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbathymetry_type, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbeam_options, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbeam_options, and woss::WossCreatorContainer< Data >::replace().
◆ 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.
◆ setBellhopPath()
|
inline |
Sets the path of bellhop program
- Parameters
-
path filesystem path
- Returns
- reference to *this
References bellhop_path.
◆ 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.
◆ 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 ccbellhop_mode, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbellhop_mode, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbox_depth, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbox_depth, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbox_range, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccbox_range, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctransducer, and woss::WossCreatorContainer< CustomTransducer >::replace().
◆ 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 cctransducer, and woss::WossCreatorContainer< CustomTransducer >::replace().
◆ 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 cctotal_rays, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_rays, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_max_range_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccrx_min_range_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_rx_depths, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_rx_depths, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_rx_ranges, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccssp_depth_precision, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccssp_depth_precision, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::replace().
◆ 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 ccnormalized_ssp_depth_steps, and woss::WossCreatorContainer< Data >::replace().
◆ setThorpeAttFlag()
|
inline |
Sets the Thorpe attenuation flag for all bellhop instances
- Parameters
-
flag boolean flag
- Returns
- reference to *this
References use_thorpe_att.
◆ setTotalRangeSteps() [1/2]
|
inline |
Sets the total range steps of bellhop simulation for given transmitter, receiver woss::CoordZ
- Parameters
-
steps total range steps tx const reference to a valid woss::CoordZ instance rx const reference to a valid woss::CoordZ instance
- Returns
- reference to *this
References cctotal_range_steps, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_range_steps, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_transmitters, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctotal_transmitters, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctx_max_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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 cctx_min_depth_offset, and woss::WossCreatorContainer< Data >::replace().
◆ 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, woss::WossCreatorContainer< Data >::setDebug(), woss::WossCreatorContainer< CustomTransducer >::setDebug(), 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 getBellhopArrSyntax(), initializeBhWoss(), and setBellhopArrSyntax().
◆ bellhop_path
|
protected |
Pathname of Bellhop program
Referenced by getBellhopPath(), initializeBhWoss(), and setBellhopPath().
◆ bellhop_shd_syntax
|
protected |
Bellhop .shd file syntax to be used during parsing, factory value = invalid
Referenced by getBellhopShdSyntax(), initializeBhWoss(), and setBellhopShdSyntax().
◆ ccaltimetry_type
|
protected |
Altimetry type ( L, C )
Referenced by eraseAltimetryType(), eraseAltimetryType(), getAltimetryType(), getAltimetryType(), initializeBhWoss(), setAltimetryType(), setAltimetryType(), and updateDebugFlag().
◆ ccangles_map
|
protected |
CustomAngles containter for user-given transmitter CoordZ
Referenced by eraseAngles(), eraseAngles(), eraseCustomTransducer(), getAngles(), getAngles(), initializeBhWoss(), setAngles(), setAngles(), and updateDebugFlag().
◆ ccbathymetry_method
|
protected |
Bathymetry write method ( S (slope), D (discrete )
Referenced by eraseBathymetryMethod(), eraseBathymetryMethod(), getBathymetryMethod(), getBathymetryMethod(), initializeBhWoss(), setBathymetryMethod(), setBathymetryMethod(), and updateDebugFlag().
◆ ccbathymetry_type
|
protected |
Bathymetry type ( L, C )
Referenced by eraseBathymetryType(), eraseBathymetryType(), getBathymetryType(), getBathymetryType(), initializeBhWoss(), setBathymetryType(), setBathymetryType(), and updateDebugFlag().
◆ ccbeam_options
|
protected |
Bellhop beam options ( G, C, R, B )
Referenced by eraseBeamOptions(), eraseBeamOptions(), getBeamOptions(), getBeamOptions(), initializeBhWoss(), setBeamOptions(), setBeamOptions(), and updateDebugFlag().
◆ ccbellhop_mode
|
protected |
Bellhop run mode ( A, a, C, I, S )
Referenced by eraseBhMode(), eraseBhMode(), getBhMode(), getBhMode(), initializeBhWoss(), setBhMode(), setBhMode(), and updateDebugFlag().
◆ ccbox_depth
|
protected |
Maximum Bellhop ray depth [m]
Referenced by eraseBoxDepth(), eraseBoxDepth(), getBoxDepth(), getBoxDepth(), initializeBhWoss(), setBoxDepth(), and setBoxDepth().
◆ ccbox_range
|
protected |
Maximum Bellhop ray range [m]
Referenced by eraseBoxRange(), eraseBoxRange(), getBoxRange(), getBoxRange(), initializeBhWoss(), setBoxRange(), and setBoxRange().
◆ ccnormalized_ssp_depth_steps
|
protected |
Depth steps of all SSP involved
Referenced by eraseSspDepthSteps(), eraseSspDepthSteps(), getSspDepthSteps(), getSspDepthSteps(), initializeBhWoss(), setSspDepthSteps(), setSspDepthSteps(), and updateDebugFlag().
◆ ccrx_max_depth_offset
|
protected |
Receiver maximum depth offset [m]
Referenced by eraseRxMaxDepthOffset(), eraseRxMaxDepthOffset(), getRxMaxDepthOffset(), getRxMaxDepthOffset(), initializeBhWoss(), setRxMaxDepthOffset(), setRxMaxDepthOffset(), and updateDebugFlag().
◆ ccrx_max_range_offset
|
protected |
Receiver maximum range offset [m]
Referenced by eraseRxMaxRangeOffset(), eraseRxMaxRangeOffset(), getRxMaxRangeOffset(), getRxMaxRangeOffset(), initializeBhWoss(), setRxMaxRangeOffset(), setRxMaxRangeOffset(), and updateDebugFlag().
◆ ccrx_min_depth_offset
|
protected |
Receiver minimum depth offset [m]
Referenced by eraseRxMinDepthOffset(), eraseRxMinDepthOffset(), getRxMinDepthOffset(), getRxMinDepthOffset(), initializeBhWoss(), setRxMinDepthOffset(), setRxMinDepthOffset(), and updateDebugFlag().
◆ ccrx_min_range_offset
|
protected |
Receiver minimum range offset [m]
Referenced by eraseRxMinRangeOffset(), eraseRxMinRangeOffset(), getRxMinRangeOffset(), getRxMinRangeOffset(), initializeBhWoss(), setRxMinRangeOffset(), setRxMinRangeOffset(), and updateDebugFlag().
◆ ccssp_depth_precision
|
protected |
SSP depth precision [m]
Referenced by eraseSspDepthPrecision(), eraseSspDepthPrecision(), getSspDepthPrecision(), getSspDepthPrecision(), initializeBhWoss(), setSspDepthPrecision(), setSspDepthPrecision(), and updateDebugFlag().
◆ cctotal_range_steps
|
protected |
Number ot range steps
Referenced by eraseTotalRangeSteps(), eraseTotalRangeSteps(), getTotalRangeSteps(), getTotalRangeSteps(), initializeBhWoss(), setTotalRangeSteps(), setTotalRangeSteps(), and updateDebugFlag().
◆ cctotal_rays
|
protected |
Number of launched rays
Referenced by eraseRaysNumber(), eraseRaysNumber(), getRaysNumber(), getRaysNumber(), initializeBhWoss(), setRaysNumber(), setRaysNumber(), and updateDebugFlag().
◆ cctotal_rx_depths
|
protected |
Number of receiver depths
Referenced by 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 eraseRxTotalRanges(), eraseRxTotalRanges(), getRxTotalRanges(), getRxTotalRanges(), initializeBhWoss(), setRxTotalRanges(), setRxTotalRanges(), and updateDebugFlag().
◆ cctotal_transmitters
|
protected |
Number of transmitter
Referenced by 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 eraseTxMaxDepthOffset(), eraseTxMaxDepthOffset(), getTxMaxDepthOffset(), getTxMaxDepthOffset(), initializeBhWoss(), setTxMaxDepthOffset(), setTxMaxDepthOffset(), and updateDebugFlag().
◆ cctx_min_depth_offset
|
protected |
Transmitter minimum depth offset [m]
Referenced by eraseTxMinDepthOffset(), eraseTxMinDepthOffset(), getTxMinDepthOffset(), getTxMinDepthOffset(), initializeBhWoss(), setTxMinDepthOffset(), setTxMinDepthOffset(), and updateDebugFlag().
◆ use_thorpe_att
|
protected |
flag that control bellhop's thorpe calculation
Referenced by getThorpeAttFlag(), initializeBhWoss(), and setThorpeAttFlag().
The documentation for this class was generated from the following files:
- woss/bellhop-creator.h
- woss/bellhop-creator.cpp
