FV3-JEDI
Public Member Functions | Private Member Functions | Private Attributes | List of all members
fv3jedi::FieldMetadata Class Reference

#include <FieldsMetadata.h>

Inheritance diagram for fv3jedi::FieldMetadata:
Inheritance graph
[legend]
Collaboration diagram for fv3jedi::FieldMetadata:
Collaboration graph
[legend]

Public Member Functions

 FieldMetadata (const std::string fieldIOName)
 
std::string getFieldIOName () const
 
void setFieldIOName (std::string fieldIOName)
 
std::string getFieldName () const
 
void setFieldName (std::string fieldName)
 
std::string getKind () const
 
void setKind (std::string kind)
 
int getLevels () const
 
void setLevels (int levels)
 
std::string getLongName () const
 
void setLongName (std::string longName)
 
std::string getSpace () const
 
void setSpace (std::string space)
 
std::string getStaggerLoc () const
 
void setStaggerLoc (std::string staggerLoc)
 
bool getTracer () const
 
void setTracer (bool tracer)
 
std::string getUnits () const
 
void setUnits (std::string units)
 
std::string getIOFile () const
 
void setIOFile (std::string io_file)
 
void checkKindValid (const std::string fieldIOName, const std::string kind) const
 
void checkStaggerLocValid (const std::string fieldIOName, const std::string staggerLoc) const
 
void checkSpaceValid (const std::string fieldIOName, const std::string space) const
 
void checkLevelValid (const std::string fieldIOName, const std::string level) const
 
bool is_number (const std::string &s) const
 

Private Member Functions

void print (std::ostream &os) const
 

Private Attributes

std::string fieldIOName_
 
std::string fieldName_
 
std::string kind_
 
int levels_
 
std::string longName_
 
std::string staggerLoc_
 
std::string space_
 
bool tracer_
 
std::string units_
 
std::string io_file_
 
const std::vector< std::string > kindVal_ = {"double", "integer"}
 
const std::vector< std::string > levelVal_ = {"full", "half"}
 
const std::vector< std::string > spaceVal_ = {"vector", "magnitude", "direction"}
 
const std::vector< std::string > staggerLocVal_ = {"center", "eastwest", "northsouth", "corner"}
 

Detailed Description

Definition at line 33 of file FieldsMetadata.h.

Constructor & Destructor Documentation

◆ FieldMetadata()

fv3jedi::FieldMetadata::FieldMetadata ( const std::string  fieldIOName)
inlineexplicit

Definition at line 35 of file FieldsMetadata.h.

Member Function Documentation

◆ checkKindValid()

void fv3jedi::FieldMetadata::checkKindValid ( const std::string  fieldIOName,
const std::string  kind 
) const
inline

Definition at line 80 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ checkLevelValid()

void fv3jedi::FieldMetadata::checkLevelValid ( const std::string  fieldIOName,
const std::string  level 
) const
inline

Definition at line 110 of file FieldsMetadata.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ checkSpaceValid()

void fv3jedi::FieldMetadata::checkSpaceValid ( const std::string  fieldIOName,
const std::string  space 
) const
inline

Definition at line 100 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ checkStaggerLocValid()

void fv3jedi::FieldMetadata::checkStaggerLocValid ( const std::string  fieldIOName,
const std::string  staggerLoc 
) const
inline

Definition at line 90 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getFieldIOName()

std::string fv3jedi::FieldMetadata::getFieldIOName ( ) const
inline

Definition at line 40 of file FieldsMetadata.h.

◆ getFieldName()

std::string fv3jedi::FieldMetadata::getFieldName ( ) const
inline

Definition at line 44 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getIOFile()

std::string fv3jedi::FieldMetadata::getIOFile ( ) const
inline

Definition at line 76 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getKind()

std::string fv3jedi::FieldMetadata::getKind ( ) const
inline

Definition at line 48 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getLevels()

int fv3jedi::FieldMetadata::getLevels ( ) const
inline

Definition at line 52 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getLongName()

std::string fv3jedi::FieldMetadata::getLongName ( ) const
inline

Definition at line 56 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getSpace()

std::string fv3jedi::FieldMetadata::getSpace ( ) const
inline

Definition at line 60 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getStaggerLoc()

std::string fv3jedi::FieldMetadata::getStaggerLoc ( ) const
inline

Definition at line 64 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getTracer()

bool fv3jedi::FieldMetadata::getTracer ( ) const
inline

Definition at line 68 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ getUnits()

std::string fv3jedi::FieldMetadata::getUnits ( ) const
inline

Definition at line 72 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ is_number()

bool fv3jedi::FieldMetadata::is_number ( const std::string &  s) const
inline

Definition at line 121 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ print()

void fv3jedi::FieldMetadata::print ( std::ostream &  os) const
inlineprivate

Definition at line 143 of file FieldsMetadata.h.

◆ setFieldIOName()

void fv3jedi::FieldMetadata::setFieldIOName ( std::string  fieldIOName)
inline

Definition at line 41 of file FieldsMetadata.h.

◆ setFieldName()

void fv3jedi::FieldMetadata::setFieldName ( std::string  fieldName)
inline

Definition at line 45 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setIOFile()

void fv3jedi::FieldMetadata::setIOFile ( std::string  io_file)
inline

Definition at line 77 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setKind()

void fv3jedi::FieldMetadata::setKind ( std::string  kind)
inline

Definition at line 49 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setLevels()

void fv3jedi::FieldMetadata::setLevels ( int  levels)
inline

Definition at line 53 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setLongName()

void fv3jedi::FieldMetadata::setLongName ( std::string  longName)
inline

Definition at line 57 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setSpace()

void fv3jedi::FieldMetadata::setSpace ( std::string  space)
inline

Definition at line 61 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setStaggerLoc()

void fv3jedi::FieldMetadata::setStaggerLoc ( std::string  staggerLoc)
inline

Definition at line 65 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setTracer()

void fv3jedi::FieldMetadata::setTracer ( bool  tracer)
inline

Definition at line 69 of file FieldsMetadata.h.

Here is the caller graph for this function:

◆ setUnits()

void fv3jedi::FieldMetadata::setUnits ( std::string  units)
inline

Definition at line 73 of file FieldsMetadata.h.

Here is the caller graph for this function:

Member Data Documentation

◆ fieldIOName_

std::string fv3jedi::FieldMetadata::fieldIOName_
private

Definition at line 127 of file FieldsMetadata.h.

◆ fieldName_

std::string fv3jedi::FieldMetadata::fieldName_
private

Definition at line 128 of file FieldsMetadata.h.

◆ io_file_

std::string fv3jedi::FieldMetadata::io_file_
private

Definition at line 136 of file FieldsMetadata.h.

◆ kind_

std::string fv3jedi::FieldMetadata::kind_
private

Definition at line 129 of file FieldsMetadata.h.

◆ kindVal_

const std::vector<std::string> fv3jedi::FieldMetadata::kindVal_ = {"double", "integer"}
private

Definition at line 138 of file FieldsMetadata.h.

◆ levels_

int fv3jedi::FieldMetadata::levels_
private

Definition at line 130 of file FieldsMetadata.h.

◆ levelVal_

const std::vector<std::string> fv3jedi::FieldMetadata::levelVal_ = {"full", "half"}
private

Definition at line 139 of file FieldsMetadata.h.

◆ longName_

std::string fv3jedi::FieldMetadata::longName_
private

Definition at line 131 of file FieldsMetadata.h.

◆ space_

std::string fv3jedi::FieldMetadata::space_
private

Definition at line 133 of file FieldsMetadata.h.

◆ spaceVal_

const std::vector<std::string> fv3jedi::FieldMetadata::spaceVal_ = {"vector", "magnitude", "direction"}
private

Definition at line 140 of file FieldsMetadata.h.

◆ staggerLoc_

std::string fv3jedi::FieldMetadata::staggerLoc_
private

Definition at line 132 of file FieldsMetadata.h.

◆ staggerLocVal_

const std::vector<std::string> fv3jedi::FieldMetadata::staggerLocVal_ = {"center", "eastwest", "northsouth", "corner"}
private

Definition at line 141 of file FieldsMetadata.h.

◆ tracer_

bool fv3jedi::FieldMetadata::tracer_
private

Definition at line 134 of file FieldsMetadata.h.

◆ units_

std::string fv3jedi::FieldMetadata::units_
private

Definition at line 135 of file FieldsMetadata.h.

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