Derived coordinate variable abstract class. More...

#include <DerivedVar.h>

Inheritance diagram for VAPoR::DerivedCFVertCoordVar:

Public Member Functions
	DerivedCFVertCoordVar (string varName, DC *dc, string mesh, string formula)

virtual	~DerivedCFVertCoordVar ()

virtual bool	GetCoordVarInfo (DC::CoordVar &cvar) const =0

Public Member Functions inherited from VAPoR::DerivedCoordVar
	DerivedCoordVar (string varName)

virtual	~DerivedCoordVar ()

virtual bool	GetCoordVarInfo (DC::CoordVar &cvar) const =0

Public Member Functions inherited from VAPoR::DerivedVar
	DerivedVar (string varName)

virtual	~DerivedVar ()

virtual int	Initialize ()=0

string	GetName () const

virtual bool	GetBaseVarInfo (DC::BaseVar &var) const =0

virtual bool	GetAtt (string attname, std::vector< double > &values) const

virtual bool	GetAtt (string attname, std::vector< long > &values) const

virtual bool	GetAtt (string attname, string &values) const

virtual std::vector< string >	GetAttNames () const

virtual DC::XType	GetAttType (string attname) const

virtual std::vector< string >	GetInputs () const =0

virtual int	GetDimLensAtLevel (int level, std::vector< size_t > &dims_at_level, std::vector< size_t > &bs_at_level) const =0

virtual int	GetDimLensAtLevel (int level, std::vector< size_t > &dims_at_level, std::vector< size_t > &bs_at_level, long ts) const

virtual size_t	GetNumRefLevels () const

virtual std::vector< size_t >	GetCRatios () const

virtual int	OpenVariableRead (size_t ts, int level=0, int lod=0)=0

virtual int	CloseVariable (int fd)=0

virtual int	ReadRegion (int fd, const std::vector< size_t > &min, const std::vector< size_t > &max, float *region)=0

virtual int	ReadRegion (int fd, const std::vector< size_t > &min, const std::vector< size_t > &max, double *region)

virtual bool	VariableExists (size_t ts, int reflevel, int lod) const =0

Public Member Functions inherited from Wasp::MyBase
	MyBase ()

const string &	getClassName () const

Static Public Member Functions
static bool	ParseFormula (string formula_terms, map< string, string > &parsed_terms)

static bool	ValidFormula (const vector< string > &required_terms, string formula)

Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code.

static int	GetErrCode ()
	Retrieve the current error code.

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message.

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

static bool	GetEnableErrMsg ()

Protected Attributes
DC *	_dc

string	_mesh

string	_formula

Protected Attributes inherited from VAPoR::DerivedVar
string	_derivedVarName

DC::FileTable	_fileTable

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Static Public Attributes inherited from Wasp::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from VAPoR::DerivedVar
int	_getVar (DC dc, size_t ts, string varname, int level, int lod, const std::vector< size_t > &min, const std::vector< size_t > &max, float region) const

int	_getVarDestagger (DC dc, size_t ts, string varname, int level, int lod, const std::vector< size_t > &min, const std::vector< size_t > &max, float region, int stagDim) const

Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)

Detailed Description

Derived coordinate variable abstract class.

Author: John Clyne

Date: July, 2018

Definition at line 123 of file DerivedVar.h.

Constructor & Destructor Documentation

◆ DerivedCFVertCoordVar()

VAPoR::DerivedCFVertCoordVar::DerivedCFVertCoordVar	(	string	varName,
		DC *	dc,
		string	mesh,
		string	formula
	)

inline

Definition at line 125 of file DerivedVar.h.

◆ ~DerivedCFVertCoordVar()

virtual VAPoR::DerivedCFVertCoordVar::~DerivedCFVertCoordVar ( )

inlinevirtual

Definition at line 127 of file DerivedVar.h.

Member Function Documentation

◆ GetCoordVarInfo()

virtual bool VAPoR::DerivedCFVertCoordVar::GetCoordVarInfo ( DC::CoordVar & cvar ) const

pure virtual

Implements VAPoR::DerivedCoordVar.

Implemented in VAPoR::DerivedCoordVarStandardWRF_Terrain, VAPoR::DerivedCoordVarStandardOceanSCoordinate, and VAPoR::DerivedCoordVarStandardAHSPC.

◆ ParseFormula()

static bool VAPoR::DerivedCFVertCoordVar::ParseFormula	(	string	formula_terms,
		map< string, string > &	parsed_terms
	)

static

Parse a CF conventions forumla string into terms and variables

This static method parse the CF conventions formula string, typically associated with the formula_terms attribute, into a std::map of term names and variable names.

If formula cannot be parsed false is returned.

Parameters

[in]	formula	: A formatted CF formula string
[out]	parse_terms	A map from term names to variable names

See also: http://cfconventions.org/

◆ ValidFormula()

static bool VAPoR::DerivedCFVertCoordVar::ValidFormula	(	const vector< string > &	required_terms,
		string	formula
	)

static

validate that a CF conventions forumla string is syntactically correct

This static method checks to see if formula contains a syntactically valid CF conventions formula string, typically associated with the formula_terms attribute, and ensures that all of required formula terms in required_terms are present in the forumla string. If either of these conditions are not met the method returns false, otherwise true is returned

Parameters

[in]	required_terms	: A vector of term names required to be found in `formula`
[in]	formula	: A formatted CF formula string

See also: http://cfconventions.org/

Member Data Documentation

◆ _dc

DC* VAPoR::DerivedCFVertCoordVar::_dc

protected

Definition at line 165 of file DerivedVar.h.

◆ _formula

string VAPoR::DerivedCFVertCoordVar::_formula

protected

Definition at line 167 of file DerivedVar.h.

◆ _mesh

string VAPoR::DerivedCFVertCoordVar::_mesh

protected

Definition at line 166 of file DerivedVar.h.

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

/Users/pearse/VAPOR/include/vapor/DerivedVar.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DerivedCFVertCoordVar()

◆ ~DerivedCFVertCoordVar()

Member Function Documentation

◆ GetCoordVarInfo()

◆ ParseFormula()

◆ ValidFormula()

Member Data Documentation

◆ _dc

◆ _formula

◆ _mesh