woss::SedimDeck41DbCreator Class Reference

DbCreator for NetCDF Deck41 Sediment database. More...

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

Inheritance diagram for woss::SedimDeck41DbCreator:

Collaboration diagram for woss::SedimDeck41DbCreator:

Public Member Functions
	SedimDeck41DbCreator ()
	SedimDeck41DbCreator (const SedimDeck41DbCreator &copy)=default
	SedimDeck41DbCreator (SedimDeck41DbCreator &&tmp)=default
virtual	~SedimDeck41DbCreator () override=default
SedimDeck41DbCreator &	operator= (const SedimDeck41DbCreator &copy)=default
SedimDeck41DbCreator &	operator= (SedimDeck41DbCreator &&tmp)=default
virtual std::unique_ptr< WossDbCreator >	clone () const override
virtual std::unique_ptr< WossDb >	createWossDb () const override
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 ()=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
bool	initializeSedimDb (SedimDeck41Db &woss_db) const

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 = false
bool	woss_db_debug = false
std::string	pathname = ""

Detailed Description

DbCreator for NetCDF Deck41 Sediment database.

SedimDeck41DbCreator implements WossDbCreator for NetCDF Deck41 Sediment database

Constructor & Destructor Documentation

SedimDeck41DbCreator() [1/3]

SedimDeck41DbCreator::SedimDeck41DbCreator

(

)

SedimDeck41DbCreator default constructor

References db_coord_name, db_marsden_name, db_marsden_one_name, and deck41_db_type.

Referenced by operator=(), operator=(), SedimDeck41DbCreator(), and SedimDeck41DbCreator().

SedimDeck41DbCreator() [2/3]

woss::SedimDeck41DbCreator::SedimDeck41DbCreator ( const SedimDeck41DbCreator & copy )

default

References SedimDeck41DbCreator().

Here is the call graph for this function:

SedimDeck41DbCreator() [3/3]

woss::SedimDeck41DbCreator::SedimDeck41DbCreator ( SedimDeck41DbCreator && tmp )

default

References SedimDeck41DbCreator().

Here is the call graph for this function:

~SedimDeck41DbCreator()

virtual woss::SedimDeck41DbCreator::~SedimDeck41DbCreator ( )

overridevirtualdefault

Member Function Documentation

clone()

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

overridevirtual

This method is called to create and initialize a SedimDeck41Db

Returns

a std::unique_ptr to a properly initialized SedimDeck41Db object

Implements woss::WossDbCreator.

References initializeSedimDb().

Here is the call graph for this function:

getDeck41CoordPathName()

std::string woss::SedimDeck41DbCreator::getDeck41CoordPathName ( ) const

inline

References db_coord_name.

getDeck41DbType()

DECK41DbType woss::SedimDeck41DbCreator::getDeck41DbType ( ) const

inline

References deck41_db_type.

getDeck41MarsdenOnePathName()

std::string woss::SedimDeck41DbCreator::getDeck41MarsdenOnePathName ( ) const

inline

References db_marsden_one_name.

getDeck41MarsdenPathName()

std::string woss::SedimDeck41DbCreator::getDeck41MarsdenPathName ( ) const

inline

References db_marsden_name.

initializeDb()

bool SedimDeck41DbCreator::initializeDb ( WossDb & woss_db ) const

overrideprotectedvirtual

Initializes the referenced object

Parameters

woss_db

reference 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 & woss_db ) const

protected

Initializes the referenced object

Parameters

woss_db

reference to a recently created SedimDeck41Db

Returns

true if the method succeed, false otherwise

References db_coord_name, db_marsden_name, db_marsden_one_name, 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:

operator=() [1/2]

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

default

References SedimDeck41DbCreator().

Here is the call graph for this function:

operator=() [2/2]

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

default

References SedimDeck41DbCreator().

Here is the call graph for this function:

setDeck41CoordPathName()

void woss::SedimDeck41DbCreator::setDeck41CoordPathName ( const std::string & name )

inline

References db_coord_name.

setDeck41DbType()

void woss::SedimDeck41DbCreator::setDeck41DbType ( DECK41DbType db_type )

inline

References deck41_db_type.

setDeck41MarsdenOnePathName()

void woss::SedimDeck41DbCreator::setDeck41MarsdenOnePathName ( const std::string & name )

inline

References db_marsden_one_name.

setDeck41MarsdenPathName()

void woss::SedimDeck41DbCreator::setDeck41MarsdenPathName ( const std::string & name )

inline

References db_marsden_name.

Member Data Documentation

db_coord_name

std::string woss::SedimDeck41DbCreator::db_coord_name

protected

Referenced by getDeck41CoordPathName(), initializeSedimDb(), SedimDeck41DbCreator(), and setDeck41CoordPathName().

db_marsden_name

std::string woss::SedimDeck41DbCreator::db_marsden_name

protected

Referenced by getDeck41MarsdenPathName(), initializeSedimDb(), SedimDeck41DbCreator(), and setDeck41MarsdenPathName().

db_marsden_one_name

std::string woss::SedimDeck41DbCreator::db_marsden_one_name

protected

Referenced by getDeck41MarsdenOnePathName(), initializeSedimDb(), SedimDeck41DbCreator(), and setDeck41MarsdenOnePathName().

deck41_db_type

DECK41DbType woss::SedimDeck41DbCreator::deck41_db_type

protected

DECK41 database type

Referenced by getDeck41DbType(), initializeSedimDb(), SedimDeck41DbCreator(), and setDeck41DbType().

---

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

• woss/woss_db/sediment-deck41-db-creator.h
• woss/woss_db/sediment-deck41-db-creator.cpp