WossDb for custom made NetCDF marsden coordinates DECK41 Sediment database. More...

#include <sediment-deck41-marsden-one-db.h>

Inheritance diagram for woss::SedimDeck41MarsdenOneDb:

Collaboration diagram for woss::SedimDeck41MarsdenOneDb:

Public Member Functions
	SedimDeck41MarsdenOneDb (const std::string &name=DB_NAME_NOT_SET)
	SedimDeck41MarsdenOneDb (const std::string &name, DECK41DbType db_type)
virtual	~SedimDeck41MarsdenOneDb () override=default
Deck41Types	getSeaFloorType (const MarsdenCoord &marsden_coord) const
virtual bool	isValid () const override
virtual bool	finalizeConnection () override
void	setDeck41DbType (DECK41DbType db_type)
DECK41DbType	getDeck41DbType () const
Public Member Functions inherited from woss::WossNetcdfDb
	WossNetcdfDb (const std::string &name)
virtual	~WossNetcdfDb () override
virtual bool	openConnection () override
virtual bool	closeConnection () override
Public Member Functions inherited from woss::WossDb
	WossDb (const std::string &name)
virtual	~WossDb ()=default
void	setDbName (const std::string &pathname)
std::string	getDbName () const
void	setDebug (double flag=true)
bool	isUsingDebug () const

Protected Attributes
netCDF::NcVar	main_sedim_var_marsden_one
NcVar *	main_sedim_var_marsden_one
netCDF::NcVar	sec_sedim_var_marsden_one
NcVar *	sec_sedim_var_marsden_one
netCDF::NcVar	marsden_square_var
NcVar *	marsden_square_var
netCDF::NcVar	marsden_one_square_var
NcVar *	marsden_one_square_var
DECK41DbType	deck41_db_type
Protected Attributes inherited from woss::WossNetcdfDb
std::unique_ptr< netCDF::NcFile >	netcdf_db = nullptr
std::unique_ptr< NcFile >	netcdf_db = nullptr
Protected Attributes inherited from woss::WossDb
std::string	db_name
bool	debug

Additional Inherited Members
Protected Member Functions inherited from woss::WossDb
PathName	getPathName (const std::string &complete_path) const

Detailed Description

WossDb for custom made NetCDF marsden coordinates DECK41 Sediment database.

SedimDeck41MarsdenOneDb implements WossNetcdfDb for the custom made NetCDF marsden coordinates DECK41 Sediment database

Constructor & Destructor Documentation

◆ SedimDeck41MarsdenOneDb() [1/2]

SedimDeck41MarsdenOneDb::SedimDeck41MarsdenOneDb ( const std::string & name = DB_NAME_NOT_SET )

SedimDeck41MarsdenOneDb default constructor. Default constructed object are not valid

Parameters

name	pathname of database
db_type	DECK41 db type

References deck41_db_type, main_sedim_var_marsden_one, marsden_one_square_var, marsden_square_var, sec_sedim_var_marsden_one, and woss::WossNetcdfDb::WossNetcdfDb().

Here is the call graph for this function:

◆ SedimDeck41MarsdenOneDb() [2/2]

SedimDeck41MarsdenOneDb::SedimDeck41MarsdenOneDb	(	const std::string &	name,
		DECK41DbType	db_type )

SedimDeck41MarsdenOneDb default constructor. Default constructed object are not valid

Parameters

name	pathname of database
db_type	DECK41 db type

References deck41_db_type, main_sedim_var_marsden_one, marsden_one_square_var, marsden_square_var, sec_sedim_var_marsden_one, and woss::WossNetcdfDb::WossNetcdfDb().

Here is the call graph for this function:

◆ ~SedimDeck41MarsdenOneDb()

virtual woss::SedimDeck41MarsdenOneDb::~SedimDeck41MarsdenOneDb ( )

overridevirtualdefault

Member Function Documentation

◆ finalizeConnection()

bool SedimDeck41MarsdenOneDb::finalizeConnection ( )

overridevirtual

Post openConnection() actions, used to create and initialize NetCDF variables

Returns: true if method was successful, false otherwise

Implements woss::WossDb.

References deck41_db_type, woss::DECK41_DB_V2_TYPE, main_sedim_var_marsden_one, marsden_one_square_var, marsden_square_var, woss::WossNetcdfDb::netcdf_db, and sec_sedim_var_marsden_one.

◆ getDeck41DbType()

DECK41DbType woss::SedimDeck41MarsdenOneDb::getDeck41DbType ( ) const

inline

Returns the current DECK41 DB type

Returns: current deck41 db type

References deck41_db_type.

◆ getSeaFloorType()

Deck41Types SedimDeck41MarsdenOneDb::getSeaFloorType ( const MarsdenCoord & marsden_coord ) const

Returns a Deck41Types for the given coordinates

Parameters

coordinates const reference to a valid MarsdenCoord object

Returns: a Deck41Types value ( main type value, secondary type value )

References woss::WossDb::debug, deck41_db_type, woss::DECK41_DB_V1_TYPE, woss::DECK41_DB_V2_TYPE, main_sedim_var_marsden_one, marsden_one_square_var, marsden_square_var, and sec_sedim_var_marsden_one.

◆ isValid()

virtual bool woss::SedimDeck41MarsdenOneDb::isValid ( ) const

inlineoverridevirtual

Checks the validity of SedimDeck41MarsdenOneDb

Returns: true if pathname is valid, false otherwise

Reimplemented from woss::WossDb.

References woss::WossDb::db_name, woss::DECK41_DB_INVALID_TYPE, deck41_db_type, and woss::WossDb::isValid().

Here is the call graph for this function:

◆ setDeck41DbType()

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

inline

Sets the current DECK41 Db type

Parameters

db_type DECK41DbType

References deck41_db_type.

Referenced by woss::SedimDeck41DbCreator::initializeSedimDb().

Member Data Documentation

◆ deck41_db_type

DECK41DbType woss::SedimDeck41MarsdenOneDb::deck41_db_type

protected

DECK41 database type

Referenced by finalizeConnection(), getDeck41DbType(), getSeaFloorType(), isValid(), SedimDeck41MarsdenOneDb(), SedimDeck41MarsdenOneDb(), and setDeck41DbType().

◆ main_sedim_var_marsden_one [1/2]

NcVar* woss::SedimDeck41MarsdenOneDb::main_sedim_var_marsden_one

protected

◆ main_sedim_var_marsden_one [2/2]

netCDF::NcVar woss::SedimDeck41MarsdenOneDb::main_sedim_var_marsden_one

protected

NetCDF variable representing main DECK41 floortype

Referenced by finalizeConnection(), getSeaFloorType(), SedimDeck41MarsdenOneDb(), and SedimDeck41MarsdenOneDb().

◆ marsden_one_square_var [1/2]

NcVar* woss::SedimDeck41MarsdenOneDb::marsden_one_square_var

protected

◆ marsden_one_square_var [2/2]

netCDF::NcVar woss::SedimDeck41MarsdenOneDb::marsden_one_square_var

protected

NetCDF marsden one degree square variable

Referenced by finalizeConnection(), getSeaFloorType(), SedimDeck41MarsdenOneDb(), and SedimDeck41MarsdenOneDb().

◆ marsden_square_var [1/2]

NcVar* woss::SedimDeck41MarsdenOneDb::marsden_square_var

protected

◆ marsden_square_var [2/2]

netCDF::NcVar woss::SedimDeck41MarsdenOneDb::marsden_square_var

protected

NetCDF marsden square variable

Referenced by finalizeConnection(), getSeaFloorType(), SedimDeck41MarsdenOneDb(), and SedimDeck41MarsdenOneDb().

◆ sec_sedim_var_marsden_one [1/2]

NcVar* woss::SedimDeck41MarsdenOneDb::sec_sedim_var_marsden_one

protected

◆ sec_sedim_var_marsden_one [2/2]

netCDF::NcVar woss::SedimDeck41MarsdenOneDb::sec_sedim_var_marsden_one

protected

NetCDF variable representing secondary DECK41 floortype

Referenced by finalizeConnection(), getSeaFloorType(), SedimDeck41MarsdenOneDb(), and SedimDeck41MarsdenOneDb().

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

woss/woss_db/sediment-deck41-marsden-one-db.h
woss/woss_db/sediment-deck41-marsden-one-db.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SedimDeck41MarsdenOneDb() [1/2]

◆ SedimDeck41MarsdenOneDb() [2/2]

◆ ~SedimDeck41MarsdenOneDb()

Member Function Documentation

◆ finalizeConnection()

◆ getDeck41DbType()

◆ getSeaFloorType()

◆ isValid()

◆ setDeck41DbType()

Member Data Documentation

◆ deck41_db_type

◆ main_sedim_var_marsden_one [1/2]

◆ main_sedim_var_marsden_one [2/2]

◆ marsden_one_square_var [1/2]

◆ marsden_one_square_var [2/2]

◆ marsden_square_var [1/2]

◆ marsden_square_var [2/2]

◆ sec_sedim_var_marsden_one [1/2]

◆ sec_sedim_var_marsden_one [2/2]