World Ocean Simulation System (WOSS) library
woss::ResTimeArrTxtDbCreator Class Reference

DbCreator for textual TimeArr database. More...

#include <res-time-arr-txt-db-creator.h>

Inheritance diagram for woss::ResTimeArrTxtDbCreator:
Inheritance graph
Collaboration diagram for woss::ResTimeArrTxtDbCreator:
Collaboration graph

Public Member Functions

 ResTimeArrTxtDbCreator ()=default
 
 ResTimeArrTxtDbCreator (const ResTimeArrTxtDbCreator &copy)=default
 
 ResTimeArrTxtDbCreator (ResTimeArrTxtDbCreator &&tmp)=default
 
virtual ~ResTimeArrTxtDbCreator () override=default
 
ResTimeArrTxtDbCreatoroperator= (const ResTimeArrTxtDbCreator &copy)=default
 
ResTimeArrTxtDbCreatoroperator= (ResTimeArrTxtDbCreator &&tmp)=default
 
virtual std::unique_ptr< WossDbCreatorclone () const override
 
virtual std::unique_ptr< WossDbcreateWossDb () const override
 
void setSpaceSampling (double value)
 
double getSpaceSampling () const
 
- Public Member Functions inherited from woss::WossDbCreator
 WossDbCreator ()=default
 
 WossDbCreator (const WossDbCreator &copy)=default
 
 WossDbCreator (WossDbCreator &&tmp)=default
 
virtual ~WossDbCreator ()=default
 
WossDbCreatoroperator= (const WossDbCreator &copy)=default
 
WossDbCreatorsetDebug (bool flag)
 
WossDbCreatorsetWossDebug (bool flag)
 
WossDbCreatorsetDbPathName (const std::string &name)
 
bool isUsingDebug () const
 
bool isUsingWossDbDebug () const
 
std::string getDbPathName () const
 

Protected Member Functions

virtual bool initializeDb (WossDb &woss_db) const
 

Protected Attributes

double space_sampling = 0.0
 
- Protected Attributes inherited from woss::WossDbCreator
bool debug = false
 
bool woss_db_debug = false
 
std::string pathname = ""
 

Detailed Description

DbCreator for textual TimeArr database.

ResTimeArrTxtDbCreator implements WossDbCreator for textual TimeArr database

Constructor & Destructor Documentation

◆ ResTimeArrTxtDbCreator() [1/3]

woss::ResTimeArrTxtDbCreator::ResTimeArrTxtDbCreator ( )
default

◆ ResTimeArrTxtDbCreator() [2/3]

woss::ResTimeArrTxtDbCreator::ResTimeArrTxtDbCreator ( const ResTimeArrTxtDbCreator copy)
default

◆ ResTimeArrTxtDbCreator() [3/3]

woss::ResTimeArrTxtDbCreator::ResTimeArrTxtDbCreator ( ResTimeArrTxtDbCreator &&  tmp)
default

◆ ~ResTimeArrTxtDbCreator()

virtual woss::ResTimeArrTxtDbCreator::~ResTimeArrTxtDbCreator ( )
overridevirtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< WossDbCreator > woss::ResTimeArrTxtDbCreator::clone ( ) const
inlineoverridevirtual

Abstract method. Virtual factory method. It is called to clone this WossDbCreator instance. The caller will be the owner of created object, therefore object destruction is his responsibility

Returns
a std::unique_ptr to a properly initialized WossDbCreator object

Implements woss::WossDbCreator.

◆ createWossDb()

std::unique_ptr< WossDb > ResTimeArrTxtDbCreator::createWossDb ( ) const
overridevirtual

This method is called to create and initialize a ResTimeArrTxtDb

Returns
a std::unique_ptr to a properly initialized ResTimeArrTxtDb object

Implements woss::WossDbCreator.

References woss::WossDbCreator::debug, initializeDb(), woss::WossDbCreator::pathname, and space_sampling.

Here is the call graph for this function:

◆ getSpaceSampling()

double woss::ResTimeArrTxtDbCreator::getSpaceSampling ( ) const
inline

References space_sampling.

◆ initializeDb()

bool ResTimeArrTxtDbCreator::initializeDb ( WossDb woss_db) const
protectedvirtual

Initializes the referenced object

Parameters
woss_dbreference to a recently created ResTimeArrTxtDb
Returns
true if the method succeed, false otherwise

Implements woss::WossDbCreator.

References woss::WossDbCreator::initializeDb().

Referenced by createWossDb().

Here is the call graph for this function:

◆ operator=() [1/2]

ResTimeArrTxtDbCreator & woss::ResTimeArrTxtDbCreator::operator= ( const ResTimeArrTxtDbCreator copy)
default

◆ operator=() [2/2]

ResTimeArrTxtDbCreator & woss::ResTimeArrTxtDbCreator::operator= ( ResTimeArrTxtDbCreator &&  tmp)
default

◆ setSpaceSampling()

void woss::ResTimeArrTxtDbCreator::setSpaceSampling ( double  value)
inline

References space_sampling.

Member Data Documentation

◆ space_sampling

double woss::ResTimeArrTxtDbCreator::space_sampling = 0.0
protected

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