woss::WossResReader Class Reference

Woss class with ResReader objects for reading simulated results. More...

#include <woss.h>

Inheritance diagram for woss::WossResReader:

Collaboration diagram for woss::WossResReader:

Public Member Functions
	WossResReader ()=default
	WossResReader (const CoordZ &tx, const CoordZ &rx, const Time &start_t, const Time &end_t, double start_freq, double end_freq, double freq_step)
virtual	~WossResReader () override=default
virtual bool	initResReader (double curr_frequency)=0
Public Member Functions inherited from woss::Woss
	Woss ()
	Woss (const CoordZ &tx, const CoordZ &rx, const Time &start_t, const Time &end_t, double start_freq, double end_freq, double freq_step)
virtual	~Woss ()
virtual bool	initialize ()=0
virtual bool	run ()=0
virtual bool	timeEvolve (const Time &time_value)=0
virtual bool	isValid () const =0
virtual std::unique_ptr< Pressure >	getAvgPressure (double frequency, double tx_depth, double start_rx_depth=WOSS_MIN_DEPTH, double start_rx_range=WOSS_MIN_RANGE, double end_rx_depth=WOSS_MAX_DEPTH, double end_rx_range=WOSS_MAX_RANGE) const =0
virtual std::unique_ptr< Pressure >	getPressure (double frequency, double tx_depth, double rx_depth, double rx_range) const =0
virtual std::unique_ptr< TimeArr >	getTimeArr (double frequency, double tx_depth, double rx_depth, double rx_range) const =0
Woss &	setDebug (bool flag)
Woss &	setCleanWorkDir (bool flag)
Woss &	setWorkDirPath (const std::string &path)
Woss &	setWossDbManager (const std::shared_ptr< WossDbManager > &ptr)
Woss &	insertFrequency (double freq)
Woss &	insertFrequencies (double freq_start, double freq_end, double freq_step)
Woss &	setFrequencies (const FreqSet &freq_set)
Woss &	eraseFrequency (double freq)
Woss &	clearFrequencies ()
Woss &	setTotalRuns (int runs)
Woss &	setTxCoordZ (const CoordZ &coordz)
Woss &	setRxCoordZ (const CoordZ &coordz)
Woss &	setStartTime (const Time &start_t)
Woss &	setEndTime (const Time &end_t)
Woss &	setEvolutionTimeQuantum (double value)
int	getWossId () const
std::string	getWorkDirPath () const
const FreqSet &	getFrequencies () const
double	getMinFrequency () const
double	getMaxFrequency () const
FreqSCIt	freq_begin () const
FreqSCIt	freq_end () const
FreqSCRIt	freq_rbegin () const
FreqSCRIt	freq_rend () const
FreqSCIt	freq_lower_bound (double frequency) const
FreqSCIt	freq_upper_bound (double frequency) const
int	getTotalRuns () const
CoordZ	getTxCoordZ () const
CoordZ	getRxCoordZ () const
Time	getStartTime () const
Time	getCurrentTime () const
Time	getEndTime () const
double	getEvolutionTimeQuantum () const
double	getGreatCircleDistance () const
double	getDistance () const
double	getBearing () const
bool	usingDebug () const
virtual bool	isRunning () const

Protected Member Functions
void	clearResReaderMap ()
Protected Member Functions inherited from woss::Woss
virtual bool	mkWorkDir (double curr_frequency, int curr_run=0)
virtual bool	rmWorkDir (double curr_frequency, int curr_run=0)
virtual bool	rmWorkDir ()

Protected Attributes
ResReaderMap	res_reader_map
Protected Attributes inherited from woss::Woss
int	woss_id
std::string	work_dir_path
std::shared_ptr< WossDbManager >	db_manager
Time	start_time
Time	current_time
Time	end_time
double	evolution_time_quantum
CoordZ	tx_coordz
CoordZ	rx_coordz
FreqSet	frequencies
double	bearing
double	total_great_circle_distance
double	total_distance
int	total_runs
bool	debug
std::atomic< bool >	has_run_once
std::atomic< bool >	is_running
bool	has_run_once
volatile bool	is_running
bool	clean_workdir

Additional Inherited Members
Static Protected Attributes inherited from woss::Woss
static std::atomic< int >	woss_counter = 0
static int	woss_counter

Detailed Description

Woss class with ResReader objects for reading simulated results.

WossResReader implements Woss with the add of a ResReaderMap object for reading and further refination purposes

Constructor & Destructor Documentation

WossResReader() [1/2]

woss::WossResReader::WossResReader ( )

default

Default constructor

Referenced by woss::ACToolboxWoss::ACToolboxWoss(), and woss::ACToolboxWoss::ACToolboxWoss().

WossResReader() [2/2]

woss::WossResReader::WossResReader ( const CoordZ & tx, const CoordZ & rx, const Time & start_t, const Time & end_t, double start_freq, double end_freq, double freq_step )

inline

Woss constructor

Parameters

tx	const reference to a valid CoordZ object ( transmitter )
rx	const reference to a valid CoordZ object ( receiver )
start_t	const reference to a valid Time object for SSP's averaging purposes ( start date time )
end_t	const reference to a valid Time object for SSP's averaging purposes ( end date time )
start_freq	start frequency [Hz]
end_freq	end frequency [Hz]
freq_step	frequency step [Hz]

References woss::Woss::Woss().

Here is the call graph for this function:

~WossResReader()

virtual woss::WossResReader::~WossResReader ( )

overridevirtualdefault

Member Function Documentation

clearResReaderMap()

void WossResReader::clearResReaderMap ( )

protected

Clears res_reader_map

References res_reader_map.

initResReader()

virtual bool woss::WossResReader::initResReader ( double curr_frequency )

pure virtual

Initializes current ResReader object

Parameters

curr_frequency

frequency in use [Hz]

Returns

true if method succeeded, false otherwise

Implemented in woss::BellhopWoss.

Member Data Documentation

res_reader_map

ResReaderMap woss::WossResReader::res_reader_map

protected

ResReader map

Referenced by clearResReaderMap(), woss::BellhopWoss::getAvgPressure(), woss::BellhopWoss::getPressure(), woss::BellhopWoss::getTimeArr(), woss::BellhopWoss::initPressResReader(), woss::BellhopWoss::initResReader(), and woss::BellhopWoss::initTimeArrResReader().

---

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

• woss/woss.h
• woss/woss.cpp