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:

Collaboration diagram for woss::SspWoa2005DbCreator:

Public Member Functions
	SspWoa2005DbCreator ()=default
	SspWoa2005DbCreator (WOADbType db_type)
	SspWoa2005DbCreator (const SspWoa2005DbCreator &copy)=default
	SspWoa2005DbCreator (SspWoa2005DbCreator &&tmp)=default
virtual	~SspWoa2005DbCreator () override=default
SspWoa2005DbCreator &	operator= (const SspWoa2005DbCreator &copy)=default
SspWoa2005DbCreator &	operator= (SspWoa2005DbCreator &&tmp)=default
virtual std::unique_ptr< WossDbCreator >	clone () const override
virtual std::unique_ptr< WossDb >	createWossDb () const override
WOADbType	getWoaDbType () const
SspWoa2005DbCreator &	setWoaDbType (WOADbType type)
Public Member Functions inherited from woss::WossDbCreator
	WossDbCreator ()=default
	WossDbCreator (const WossDbCreator &copy)=default
	WossDbCreator (WossDbCreator &&tmp)=default
virtual	~WossDbCreator ()=default
WossDbCreator &	operator= (const WossDbCreator &copy)=default
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) const override

Protected Attributes
WOADbType	woa_db_type = WOADbType::WOA_DB_TYPE_2005
Protected Attributes inherited from woss::WossDbCreator
bool	debug = false
bool	woss_db_debug = false
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/4]

woss::SspWoa2005DbCreator::SspWoa2005DbCreator ( )

default

Default SspWoa2005DbCreator constructor

SspWoa2005DbCreator() [2/4]

SspWoa2005DbCreator::SspWoa2005DbCreator

(

WOADbType

db_type

)

SspWoa2005DbCreator constructor

Parameters

db_type

WOADbType of the database

SspWoa2005DbCreator() [3/4]

woss::SspWoa2005DbCreator::SspWoa2005DbCreator ( const SspWoa2005DbCreator &  copy )

default

SspWoa2005DbCreator() [4/4]

woss::SspWoa2005DbCreator::SspWoa2005DbCreator ( SspWoa2005DbCreator &&  tmp )

default

~SspWoa2005DbCreator()

virtual woss::SspWoa2005DbCreator::~SspWoa2005DbCreator ( )

overridevirtualdefault

Member Function Documentation

clone()

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

overridevirtual

This method is called to create and initialize a SspWoa2005Db

Returns

a std::unique_ptr to a properly initialized SspWoa2005Db object

Implements woss::WossDbCreator.

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

Here is the call graph for this function:

getWoaDbType()

WOADbType woss::SspWoa2005DbCreator::getWoaDbType ( ) const

inline

Returns current WOADbType

Returns

current WOADbType

References woa_db_type.

initializeDb()

bool SspWoa2005DbCreator::initializeDb ( WossDb &  woss_db ) const

overrideprotectedvirtual

Initializes the referenced object

Parameters

woss_db

reference 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:

operator=() [1/2]

SspWoa2005DbCreator & woss::SspWoa2005DbCreator::operator= ( const SspWoa2005DbCreator &  copy )

default

operator=() [2/2]

SspWoa2005DbCreator & woss::SspWoa2005DbCreator::operator= ( SspWoa2005DbCreator &&  tmp )

default

setWoaDbType()

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

inline

Set current WOADbType

Parameters

type	valid WOADbType

References woa_db_type.

Member Data Documentation

woa_db_type

WOADbType woss::SspWoa2005DbCreator::woa_db_type = WOADbType::WOA_DB_TYPE_2005

protected

Referenced by createWossDb(), getWoaDbType(), and setWoaDbType().

---

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

• woss/woss_db/ssp-woa2005-db-creator.h
• woss/woss_db/ssp-woa2005-db-creator.cpp