# MI - Fimex: MetNoFimex::SpatialAxisSpec Class Reference

# MetNoFimex::SpatialAxisSpec Class Reference

`#include <SpatialAxisSpec.h>`

List of all members.

## Public Member Functions

| SpatialAxisSpec (const std::string &axisSpec) throw (CDMException)
| SpatialAxisSpec (const std::string &axisSpec, double start, double end) throw (CDMException)
virtual | ~SpatialAxisSpec ()
bool | requireStartEnd ()
void | setStartEnd (double start, double end)
const std::vector< double > & | getAxisSteps ()

## Detailed Description

This class can be used to describe a list of spatial units in an efficient textual way.

- UNIT: see udunit, compatible with degree or m: default: m
- RELVALUE: float-number
- RELVALUES: comma-separated list of values with possible ... extension, ... meaning continuation of the difference of the previous two values 0 is the first time in the original time-axis, x is the last time-value in the original time-axis

A SpatialAxisSpec consists of at least of values:

- axisspec := VALUES[;unit=UNIT] | RELVALUES;relativeStart=VALUE[;unit=UNIT]

relativeStart will reset the relative value 0 to the first value larger than x0 (original start time) with x0 = i * (v1-v0)* unit with i being a integer.

     axisspec = -450000,-400000,...,50000

     timespec = -50,0,...,x,x+50;relativeStart=17;unit=km

Warning:
  The 'unit' parameter is currently not supported, please enter values as m or degree

  the RELVALUES currently must be in m, degree not supported (yet?)

## Constructor & Destructor Documentation

MetNoFimex::SpatialAxisSpec::SpatialAxisSpec | ( | const std::string & | axisSpec | ) | throw (CDMException)`[inline]`

Define a spatialAxisSpec. Depending on the axisSpec (relativeStart?), start and end must be given later

Parameters:

  | axisSpec | string representation as explained above

MetNoFimex::SpatialAxisSpec::SpatialAxisSpec | ( | const std::string & | axisSpec,
|  | double | start,
|  | double | end |
| ) |  |  | throw (CDMException)`[inline]`

Define a spatialAxisSpec

Parameters:

  | axisSpec | string representation as explained above
  | start | place of data start, in degree or m
  | end | place to end, in degree or m

virtual MetNoFimex::SpatialAxisSpec::~SpatialAxisSpec | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

bool MetNoFimex::SpatialAxisSpec::requireStartEnd | ( |  | ) |

Check if axisSpec still requires start and end place. This returns false if a) start and end have been given already b) the axisSpec is independant of start and end

void MetNoFimex::SpatialAxisSpec::setStartEnd | ( | double | start,
|  | double | end |
| ) |  |  | `[inline]`

const std::vector<double>& MetNoFimex::SpatialAxisSpec::getAxisSteps | ( |  | ) | `[inline]`

Returns:
  steps on the axis in degree or m

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

- include/fimex/SpatialAxisSpec.h