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

WossDbCreator for the custom made NetCDF WOA2005 SSP database. More...

#include <ssp-woa2005-db-creator.h>

Inheritance diagram for woss::SspWoa2005DbCreator:
Inheritance graph
Collaboration diagram for woss::SspWoa2005DbCreator:
Collaboration graph

Public Member Functions

 SspWoa2005DbCreator ()
 
 SspWoa2005DbCreator (WOADbType db_type)
 
virtual WossDb *const createWossDb ()
 
WOADbType getWoaDbType () const
 
SspWoa2005DbCreatorsetWoaDbType (WOADbType type)
 
- Public Member Functions inherited from woss::WossDbCreator
 WossDbCreator ()
 
virtual WossDb *const createWossDb ()=0
 
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 *const woss_db)
 
virtual bool initializeDb (WossDb *const woss_db)=0
 

Protected Attributes

WOADbType woa_db_type
 
- Protected Attributes inherited from woss::WossDbCreator
bool debug
 
bool woss_db_debug
 
::std::string pathname
 

Detailed Description

WossDbCreator for the custom made NetCDF WOA2005 SSP database.

Specialization of WossDbCreator for the custom made NetCDF WOA2005 SSP database

Constructor & Destructor Documentation

◆ SspWoa2005DbCreator() [1/2]

SspWoa2005DbCreator::SspWoa2005DbCreator ( )

Default SspWoa2005DbCreator constructor

References woss::WOA_DB_TYPE_2005.

◆ SspWoa2005DbCreator() [2/2]

SspWoa2005DbCreator::SspWoa2005DbCreator ( WOADbType  db_type)

SspWoa2005DbCreator constructor

Parameters
db_typeWOADbType of the database

Member Function Documentation

◆ createWossDb()

WossDb *const SspWoa2005DbCreator::createWossDb ( )
virtual

This method is called to create and initialize a SspWoa2005Db

Returns
a pointer to a properly initialized SspWoa2005Db object

Implements woss::WossDbCreator.

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

Here is the call graph for this function:

◆ getWoaDbType()

WOADbType woss::SspWoa2005DbCreator::getWoaDbType ( ) const
inline

Returns current WOADbType

Returns
current WOADbType

◆ initializeDb()

bool SspWoa2005DbCreator::initializeDb ( WossDb *const  woss_db)
protectedvirtual

Initializes the pointed object

Parameters
woss_dbpointer to a recently created SspWoa2005Db
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:

◆ setWoaDbType()

SspWoa2005DbCreator & woss::SspWoa2005DbCreator::setWoaDbType ( WOADbType  type)
inline

Set current WOADbType

Parameters
typevalid WOADbType

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