MI - Fimex
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
MetNoFimex::Height Class Reference

#include <fimex/coordSys/verticalTransform/Height.h>

Inheritance diagram for MetNoFimex::Height:
MetNoFimex::VerticalTransformation

Public Member Functions

 Height (const std::string &height)
 
virtual ~Height ()
 
virtual std::string getName () const
 
virtual int getPreferredVerticalType () const
 the most natural vertical type, one of the MIFI_VINT_* in fimex/mifi_constants.h More...
 
virtual std::string getParameterString () const
 list the parameters More...
 
virtual bool isComplete () const
 
- Public Member Functions inherited from MetNoFimex::VerticalTransformation
virtual ~VerticalTransformation ()
 
virtual boost::shared_ptr< ToVLevelConvertergetConverter (const boost::shared_ptr< CDMReader > &reader, int verticalType, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
 
boost::shared_ptr< ToVLevelConvertergetConverter (const boost::shared_ptr< CDMReader > &reader, int verticalType, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs) const
 same as getConverter, but determines nx, nz, nt using MetNoFimex::getSimpleAxes from CDMUtils More...
 

Static Public Member Functions

static const std::string NAME ()
 

Public Attributes

const std::string height
 name of the height variable More...
 

Protected Member Functions

virtual boost::shared_ptr< ToVLevelConvertergetPressureConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nt) const
 
virtual boost::shared_ptr< ToVLevelConvertergetHeightConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
 
virtual boost::shared_ptr< ToVLevelConvertergetAltitudeConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
 

Constructor & Destructor Documentation

MetNoFimex::Height::Height ( const std::string height)
inline
virtual MetNoFimex::Height::~Height ( )
inlinevirtual

Member Function Documentation

virtual boost::shared_ptr<ToVLevelConverter> MetNoFimex::Height::getAltitudeConverter ( const boost::shared_ptr< CDMReader > &  reader,
size_t  unLimDimPos,
boost::shared_ptr< const CoordinateSystem cs,
size_t  nx,
size_t  ny,
size_t  nz,
size_t  nt 
) const
protectedvirtual

Default implementation: Convert to altitude (height above MSL) with pressure(-converter) and standard atmosphere.

Parameters
reader
unLimDimPos
cs
nx
ny
nz
nt
Returns

Reimplemented from MetNoFimex::VerticalTransformation.

Referenced by isComplete().

virtual boost::shared_ptr<ToVLevelConverter> MetNoFimex::Height::getHeightConverter ( const boost::shared_ptr< CDMReader > &  reader,
size_t  unLimDimPos,
boost::shared_ptr< const CoordinateSystem cs,
size_t  nx,
size_t  ny,
size_t  nz,
size_t  nt 
) const
protectedvirtual

Default implementation: Convert to height above ground with pressure(-converter) and standard atmosphere.

Parameters
reader
unLimDimPos
cs
nx
ny
nz
nt
Returns

Reimplemented from MetNoFimex::VerticalTransformation.

Referenced by isComplete().

virtual std::string MetNoFimex::Height::getName ( ) const
inlinevirtual
Returns
same as static NAME()

Implements MetNoFimex::VerticalTransformation.

References NAME().

virtual std::string MetNoFimex::Height::getParameterString ( ) const
inlinevirtual

list the parameters

Implements MetNoFimex::VerticalTransformation.

References height.

virtual int MetNoFimex::Height::getPreferredVerticalType ( ) const
inlinevirtual

the most natural vertical type, one of the MIFI_VINT_* in fimex/mifi_constants.h

Implements MetNoFimex::VerticalTransformation.

References MIFI_VINT_HEIGHT.

virtual boost::shared_ptr<ToVLevelConverter> MetNoFimex::Height::getPressureConverter ( const boost::shared_ptr< CDMReader > &  reader,
size_t  unLimDimPos,
boost::shared_ptr< const CoordinateSystem cs,
size_t  nx,
size_t  ny,
size_t  nt 
) const
protectedvirtual
virtual bool MetNoFimex::Height::isComplete ( ) const
inlinevirtual

Indicate if all parameters are given to fully describe the transformation.

Even a fully described transformation does not guarantee that a converter exists (e.g. height -> altitude requires in addition topography).

And converters might exist, even if a transformation is not complete.

Implements MetNoFimex::VerticalTransformation.

References getAltitudeConverter(), getHeightConverter(), and getPressureConverter().

static const std::string MetNoFimex::Height::NAME ( )
inlinestatic

static NAME constant

Returns
height

Referenced by getName().

Member Data Documentation

const std::string MetNoFimex::Height::height

name of the height variable

Referenced by getParameterString().


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