World Ocean Simulation System (WOSS) library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
woss::SedimDeck41DbCreator Class Reference

DbCreator for NetCDF Deck41 Sediment database. More...

#include <sediment-deck41-db-creator.h>

Inheritance diagram for woss::SedimDeck41DbCreator:
Inheritance graph
Collaboration diagram for woss::SedimDeck41DbCreator:
Collaboration graph

Public Member Functions

 SedimDeck41DbCreator ()
 
virtual WossDb *const createWossDb ()
 
void setDeck41CoordPathName (const ::std::string &name)
 
void setDeck41MarsdenPathName (const ::std::string &name)
 
void setDeck41MarsdenOnePathName (const ::std::string &name)
 
void setDeck41DbType (DECK41DbType db_type)
 
::std::string getDeck41CoordPathName () const
 
::std::string getDeck41MarsdenPathName () const
 
::std::string getDeck41MarsdenOnePathName () const
 
DECK41DbType getDeck41DbType () const
 
- Public Member Functions inherited from woss::WossDbCreator
 WossDbCreator ()
 
virtual WossDb *const createWossDb ()=0
 
WossDbCreator & setDebug (bool flag)
 
WossDbCreator & setWossDebug (bool flag)
 
WossDbCreator & setDbPathName (const ::std::string &name)
 
bool isUsingDebug () const
 
bool isUsingWossDbDebug () const
 
::std::string getDbPathName () const
 

Protected Member Functions

virtual bool initializeDb (WossDb *woss_db)
 
bool initializeSedimDb (SedimDeck41Db *const woss_db)
 
virtual bool initializeDb (WossDb *const woss_db)=0
 

Protected Attributes

::std::string db_coord_name
 
::std::string db_marsden_name
 
::std::string db_marsden_one_name
 
DECK41DbType deck41_db_type
 
- Protected Attributes inherited from woss::WossDbCreator
bool debug
 
bool woss_db_debug
 
::std::string pathname
 

Detailed Description

DbCreator for NetCDF Deck41 Sediment database.

SedimDeck41DbCreator implements WossDbCreator for NetCDF Deck41 Sediment database

Constructor & Destructor Documentation

◆ SedimDeck41DbCreator()

SedimDeck41DbCreator::SedimDeck41DbCreator ( )

SedimDeck41DbCreator default constructor

References woss::DECK41_DB_V1_TYPE.

Member Function Documentation

◆ createWossDb()

WossDb *const SedimDeck41DbCreator::createWossDb ( )
virtual

This method is called to create and initialize a SedimDeck41Db

Returns
a pointer to a properly initialized SedimDeck41Db object

Implements woss::WossDbCreator.

References initializeSedimDb().

Here is the call graph for this function:

◆ initializeDb()

bool SedimDeck41DbCreator::initializeDb ( WossDb *  woss_db)
protectedvirtual

Initializes the pointed object

Parameters
woss_dbpointer to a recently created SedimDeck41Db
Returns
true if the method succeed, false otherwise

Implements woss::WossDbCreator.

References woss::WossDbCreator::initializeDb().

Referenced by initializeSedimDb().

Here is the call graph for this function:

◆ initializeSedimDb()

bool SedimDeck41DbCreator::initializeSedimDb ( SedimDeck41Db *const  woss_db)
protected

Initializes the pointed object

Parameters
woss_dbpointer to a recently created SedimDeck41Db
Returns
true if the method succeed, false otherwise

References deck41_db_type, initializeDb(), woss::SedimDeck41Db::sediment_coord_db, woss::SedimDeck41Db::sediment_marsden_db, woss::SedimDeck41Db::sediment_marsden_one_db, woss::WossDb::setDbName(), woss::SedimDeck41CoordDb::setDeck41DbType(), woss::SedimDeck41MarsdenDb::setDeck41DbType(), and woss::SedimDeck41MarsdenOneDb::setDeck41DbType().

Referenced by createWossDb().

Here is the call graph for this function:

Member Data Documentation

◆ deck41_db_type

DECK41DbType woss::SedimDeck41DbCreator::deck41_db_type
protected

DECK41 database type

Referenced by initializeSedimDb().

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