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

DbCreator for binary Pressure database. More...

#include <res-pressure-bin-db-creator.h>

Inheritance diagram for woss::ResPressureBinDbCreator:
Inheritance graph
Collaboration diagram for woss::ResPressureBinDbCreator:
Collaboration graph

Public Member Functions

 ResPressureBinDbCreator ()=default
 
 ResPressureBinDbCreator (const ResPressureBinDbCreator &copy)=default
 
 ResPressureBinDbCreator (ResPressureBinDbCreator &&tmp)=default
 
virtual ~ResPressureBinDbCreator () override=default
 
ResPressureBinDbCreatoroperator= (const ResPressureBinDbCreator &copy)=default
 
ResPressureBinDbCreatoroperator= (ResPressureBinDbCreator &&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 binary Pressure database.

ResPressureBinDbCreator implements WossDbCreator for binary file Pressure database

Constructor & Destructor Documentation

◆ ResPressureBinDbCreator() [1/3]

woss::ResPressureBinDbCreator::ResPressureBinDbCreator ( )
default

ResPressureBinDbCreator default constructor

◆ ResPressureBinDbCreator() [2/3]

woss::ResPressureBinDbCreator::ResPressureBinDbCreator ( const ResPressureBinDbCreator copy)
default

◆ ResPressureBinDbCreator() [3/3]

woss::ResPressureBinDbCreator::ResPressureBinDbCreator ( ResPressureBinDbCreator &&  tmp)
default

◆ ~ResPressureBinDbCreator()

virtual woss::ResPressureBinDbCreator::~ResPressureBinDbCreator ( )
overridevirtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< WossDbCreator > woss::ResPressureBinDbCreator::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 > ResPressureBinDbCreator::createWossDb ( ) const
overridevirtual

This method is called to create and initialize a ResPressureTxtDb

Returns
a std::unique_ptr to a properly initialized ResPressureTxtDb 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::ResPressureBinDbCreator::getSpaceSampling ( ) const
inline

References space_sampling.

◆ initializeDb()

bool ResPressureBinDbCreator::initializeDb ( WossDb woss_db) const
protectedvirtual

Initializes the pointed object

Parameters
woss_dbreference to a recently created ResPressureTxtDb
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]

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

◆ operator=() [2/2]

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

◆ setSpaceSampling()

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

References space_sampling.

Member Data Documentation

◆ space_sampling

double woss::ResPressureBinDbCreator::space_sampling = 0.0
protected

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