World Ocean Simulation System (WOSS) library
woss::WossResTimeArrDb Class Referenceabstract

Data behaviour class for storing calculated TimeArr. More...

#include <woss-db.h>

Inheritance diagram for woss::WossResTimeArrDb:
Inheritance graph
Collaboration diagram for woss::WossResTimeArrDb:
Collaboration graph

Public Member Functions

 WossResTimeArrDb ()=default
 
virtual ~WossResTimeArrDb ()=default
 
virtual std::unique_ptr< TimeArrgetValue (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value) const =0
 
virtual bool insertValue (const CoordZ &coord_tx, const CoordZ &coord_rx, const double frequency, const Time &time_value, const TimeArr &channel)=0
 

Detailed Description

Data behaviour class for storing calculated TimeArr.

WossResTimeArrDb is the prototype of any class that implements a database database for calculated TimeArr

See also
ResTimeArrTxtDb

Constructor & Destructor Documentation

◆ WossResTimeArrDb()

woss::WossResTimeArrDb::WossResTimeArrDb ( )
default

◆ ~WossResTimeArrDb()

virtual woss::WossResTimeArrDb::~WossResTimeArrDb ( )
virtualdefault

Member Function Documentation

◆ getValue()

virtual std::unique_ptr< TimeArr > woss::WossResTimeArrDb::getValue ( const CoordZ coord_tx,
const CoordZ coord_rx,
const double  frequency,
const Time time_value 
) const
pure virtual

Returns a std::unique_ptr to a heap-created TimeArr value for given frequency, transmitter and receiver coordinates if present in the database. User is responsible of pointer's ownership

Parameters
coord_txconst reference to a valid CoordZ object
coord_rxconst reference to a valid CoordZ object
frequencyused frequency [hz]
Returns
std::unique_ptr to a valid TimeArr if parameters are found, not valid otherwise

Implemented in woss::ResTimeArrTxtDb.

◆ insertValue()

virtual bool woss::WossResTimeArrDb::insertValue ( const CoordZ coord_tx,
const CoordZ coord_rx,
const double  frequency,
const Time time_value,
const TimeArr channel 
)
pure virtual

Inserts the given TimeArr value in the database at given frequency, transmitter and receiver coordinates

Parameters
coord_txconst reference to a valid CoordZ object
coord_rxconst reference to a valid CoordZ object
frequencyused frequency [hz]
channelcomputed TimeArr
Returns
true if method was successful, false otherwise

Implemented in woss::ResTimeArrTxtDb.


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