Ingester::IodaDescription Class Reference

Describes how to write data to IODA. More...

#include <IodaDescription.h>

Public Member Functions
	IodaDescription ()=default
	IodaDescription (const eckit::Configuration &conf)
void	addDimension (const DimensionDescription &scale)
	Add Dimension defenition. More...
void	addVariable (const VariableDescription &variable)
	Add Variable defenition. More...
void	addGlobal (const std::shared_ptr< GlobalDescriptionBase > &global)
	Add Globals defenition. More...
void	setBackend (const ioda::Engines::BackendNames &backend)
void	setFilepath (const std::string &filepath)
ioda::Engines::BackendNames	getBackend () const
std::string	getFilepath () const
DimDescriptions	getDims () const
VariableDescriptions	getVariables () const
GlobalDescriptions	getGlobals () const

Private Member Functions
void	setBackend (const std::string &backend)
	Collection of defined variables. More...

Private Attributes
ioda::Engines::BackendNames	backend_
	The backend type to use. More...
std::string	filepath_
	The relative path of the output file to create. More...
DimDescriptions	dimensions_
	Collection of defined dimensions. More...
VariableDescriptions	variables_
	Collection of defined variables. More...
GlobalDescriptions	globals_
	Collection of defined globals. More...

Detailed Description

Describes how to write data to IODA.

Definition at line 94 of file IodaDescription.h.

Constructor & Destructor Documentation

IodaDescription() [1/2]

Ingester::IodaDescription::IodaDescription ( )

default

IodaDescription() [2/2]

Ingester::IodaDescription::IodaDescription ( const eckit::Configuration &  conf )

explicit

Definition at line 59 of file IodaDescription.cpp.

Here is the call graph for this function:

Member Function Documentation

addDimension()

void Ingester::IodaDescription::addDimension

(

const DimensionDescription &

scale

)

Add Dimension defenition.

Definition at line 220 of file IodaDescription.cpp.

Here is the caller graph for this function:

addGlobal()

void Ingester::IodaDescription::addGlobal

(

const std::shared_ptr< GlobalDescriptionBase > &

global

)

Add Globals defenition.

Definition at line 230 of file IodaDescription.cpp.

Here is the caller graph for this function:

addVariable()

void Ingester::IodaDescription::addVariable

(

const VariableDescription &

variable

)

Add Variable defenition.

Definition at line 225 of file IodaDescription.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getBackend()

ioda::Engines::BackendNames Ingester::IodaDescription::getBackend ( ) const

inline

Definition at line 114 of file IodaDescription.h.

Here is the caller graph for this function:

getDims()

DimDescriptions Ingester::IodaDescription::getDims ( ) const

inline

Definition at line 116 of file IodaDescription.h.

Here is the caller graph for this function:

getFilepath()

std::string Ingester::IodaDescription::getFilepath ( ) const

inline

Definition at line 115 of file IodaDescription.h.

Here is the caller graph for this function:

getGlobals()

GlobalDescriptions Ingester::IodaDescription::getGlobals ( ) const

inline

Definition at line 118 of file IodaDescription.h.

Here is the caller graph for this function:

getVariables()

VariableDescriptions Ingester::IodaDescription::getVariables ( ) const

inline

Definition at line 117 of file IodaDescription.h.

Here is the caller graph for this function:

setBackend() [1/2]

void Ingester::IodaDescription::setBackend ( const ioda::Engines::BackendNames &  backend )

inline

Definition at line 110 of file IodaDescription.h.

Here is the caller graph for this function:

setBackend() [2/2]

void Ingester::IodaDescription::setBackend ( const std::string &  backend )

private

Collection of defined variables.

Definition at line 235 of file IodaDescription.cpp.

Here is the call graph for this function:

setFilepath()

void Ingester::IodaDescription::setFilepath ( const std::string &  filepath )

inline

Definition at line 111 of file IodaDescription.h.

Member Data Documentation

backend_

ioda::Engines::BackendNames Ingester::IodaDescription::backend_

private

The backend type to use.

Definition at line 122 of file IodaDescription.h.

dimensions_

DimDescriptions Ingester::IodaDescription::dimensions_

private

Collection of defined dimensions.

Definition at line 128 of file IodaDescription.h.

filepath_

std::string Ingester::IodaDescription::filepath_

private

The relative path of the output file to create.

Definition at line 125 of file IodaDescription.h.

globals_

GlobalDescriptions Ingester::IodaDescription::globals_

private

Collection of defined globals.

Definition at line 134 of file IodaDescription.h.

variables_

VariableDescriptions Ingester::IodaDescription::variables_

private

Collection of defined variables.

Definition at line 131 of file IodaDescription.h.

---

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

• IodaDescription.h
• IodaDescription.cpp