GDAL

Class modeling a a dimension / axis used to index multidimensional arrays. More...
#include <gdal_priv.h>
Public Member Functions  
const std::string &  GetName () const 
Return the name.  
const std::string &  GetFullName () const 
Return the full name.  
const std::string &  GetType () const 
Return the axis type.  
const std::string &  GetDirection () const 
Return the axis direction.  
GUInt64  GetSize () const 
Return the size, that is the number of values along the dimension.  
virtual std::shared_ptr< GDALMDArray >  GetIndexingVariable () const 
Return the variable that is used to index the dimension (if there is one).  
virtual bool  SetIndexingVariable (std::shared_ptr< GDALMDArray > poIndexingVariable) 
Set the variable that is used to index the dimension.  
virtual bool  Rename (const std::string &osNewName) 
Rename the dimension.  
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 optionally point to a GDALMDArray variable, typically onedimensional, 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.

inline 
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()

inline 
Return the full name.
This is the same as the C function GDALDimensionGetFullName()

virtual 
Return the variable that is used to index the dimension (if there is one).
This is the array, typically onedimensional, describing the values taken by the dimension.

inline 
Return the name.
This is the same as the C function GDALDimensionGetName()

inline 
Return the size, that is the number of values along the dimension.
This is the same as the C function GDALDimensionGetSize()

inline 
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()

virtual 
Rename the dimension.
This is not implemented by all drivers.
Drivers known to implement it: MEM, netCDF, ZARR.
This is the same as the C function GDALDimensionRename().
osNewName  New name. 

virtual 
Set the variable that is used to index the dimension.
This is the array, typically onedimensional, describing the values taken by the dimension.
Optionally implemented by drivers.
Drivers known to implement it: MEM.
poArray  Variable to use to index the dimension. 