GDALDimension C++ API

class GDALDimension

Class modeling a a dimension / axis used to index multidimensional arrays.

It has a name, a size (that is the number of values that can be indexed along the dimension), a type (see GDALDimension::GetType()), a direction (see GDALDimension::GetDirection()), a unit and can optionaly point to a GDALMDArray variable, typically one-dimensional, describing the values taken by the dimension. For a georeferenced GDALMDArray and its X dimension, this will be typically the values of the easting/longitude for each grid point.

Since

GDAL 3.1

Public Functions

const std::string &GetName() const

Return the name.

This is the same as the C function GDALDimensionGetName()

const std::string &GetFullName() const

Return the full name.

This is the same as the C function GDALDimensionGetFullName()

const std::string &GetType() const

Return the axis type.

Predefined values are: HORIZONTAL_X, HORIZONTAL_Y, VERTICAL, TEMPORAL, PARAMETRIC Other values might be returned. Empty value means unknown.

This is the same as the C function GDALDimensionGetType()

const std::string &GetDirection() const

Return the axis direction.

Predefined values are: EAST, WEST, SOUTH, NORTH, UP, DOWN, FUTURE, PAST Other values might be returned. Empty value means unknown.

This is the same as the C function GDALDimensionGetDirection()

GUInt64 GetSize() const

Return the size, that is the number of values along the dimension.

This is the same as the C function GDALDimensionGetSize()

std::shared_ptr<GDALMDArray> GetIndexingVariable() const

Return the variable that is used to index the dimension (if there is one).

This is the array, typically one-dimensional, describing the values taken by the dimension.

bool SetIndexingVariable(std::shared_ptr<GDALMDArray> poIndexingVariable)

Set the variable that is used to index the dimension.

This is the array, typically one-dimensional, describing the values taken by the dimension.

Optionaly implemented by drivers.

Drivers known to implement it: MEM.

Return

true in case of success.

Parameters
  • poArray: Variable to use to index the dimension.