\hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}{}\doxysection{osgeo\+::proj\+::cs\+::Coordinate\+System\+Axis Class Reference}
\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}


The definition of a coordinate system axis.  




{\ttfamily \#include $<$coordinatesystem.\+hpp$>$}



Inheritance diagram for osgeo\+::proj\+::cs\+::Coordinate\+System\+Axis\+:
% FIG 0


Collaboration diagram for osgeo\+::proj\+::cs\+::Coordinate\+System\+Axis\+:
% FIG 1
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const std\+::string \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a5f4420431c1660a8b55a74cb89eeb2a7}{abbreviation}} ()
\begin{DoxyCompactList}\small\item\em Return the axis abbreviation. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1AxisDirection}{Axis\+Direction}} \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac9ca82cdccd93ced1f9fc41c34160b9f}{direction}} ()
\begin{DoxyCompactList}\small\item\em Return the axis direction. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{classosgeo_1_1proj_1_1common_1_1UnitOfMeasure}{common\+::\+Unit\+Of\+Measure}} \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_aa2ca35f6b1ea464374d6db27353669e5}{unit}} ()
\begin{DoxyCompactList}\small\item\em Return the axis unit. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1optional}{util\+::optional}}$<$ double $>$ \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac8a992c3d8b83c547a53e4b8ee45cfd8}{minimum\+Value}} ()
\begin{DoxyCompactList}\small\item\em Return the minimum value normally allowed for this axis, in the unit for the axis. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1optional}{util\+::optional}}$<$ double $>$ \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_adbde9c493dd93adea424c60e54d492b8}{maximum\+Value}} ()
\begin{DoxyCompactList}\small\item\em Return the maximum value normally allowed for this axis, in the unit for the axis. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_afa4113d8f296357469f7ff94c95869d9}{Meridian\+Ptr}} \& \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a78af68ef700b34098fb024f64d386212}{meridian}} ()
\begin{DoxyCompactList}\small\item\em Return the meridian that the axis follows from the pole, for a coordinate reference system centered on a pole. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_a4396703d26406bc3776aa97e4684347c}{Coordinate\+System\+Axis\+NNPtr}} \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ab661c7f1093f0971e6e91fb7717c4873}{create}} (const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1PropertyMap}{util\+::\+Property\+Map}} \&properties, const std\+::string \&abbreviation\+In, const \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1AxisDirection}{Axis\+Direction}} \&direction\+In, const \mbox{\hyperlink{classosgeo_1_1proj_1_1common_1_1UnitOfMeasure}{common\+::\+Unit\+Of\+Measure}} \&unit\+In, const \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_afa4113d8f296357469f7ff94c95869d9}{Meridian\+Ptr}} \&meridian\+In=nullptr)
\begin{DoxyCompactList}\small\item\em Instantiate a \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}{Coordinate\+System\+Axis}}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Additional Inherited Members}


\doxysubsection{Detailed Description}
The definition of a coordinate system axis. 

\begin{DoxyRemark}{Remarks}
Implements \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}{Coordinate\+System\+Axis}} from \mbox{\hyperlink{general_doc_ISO_19111_2019}{ISO 19111\+:2019}} 
\end{DoxyRemark}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a5f4420431c1660a8b55a74cb89eeb2a7}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a5f4420431c1660a8b55a74cb89eeb2a7}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!abbreviation@{abbreviation}}
\index{abbreviation@{abbreviation}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{abbreviation()}{abbreviation()}}
{\footnotesize\ttfamily const std\+::string \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::abbreviation (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the axis abbreviation. 

The abbreviation used for this coordinate system axis; this abbreviation is also used to identify the coordinates in the coordinate tuple. Examples are X and Y.

\begin{DoxyReturn}{Returns}
the abbreviation. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ab661c7f1093f0971e6e91fb7717c4873}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ab661c7f1093f0971e6e91fb7717c4873}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!create@{create}}
\index{create@{create}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{create()}{create()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_a4396703d26406bc3776aa97e4684347c}{Coordinate\+System\+Axis\+NNPtr}} osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::create (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1PropertyMap}{util\+::\+Property\+Map}} \&}]{properties,  }\item[{const std\+::string \&}]{abbreviation\+In,  }\item[{const \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1AxisDirection}{Axis\+Direction}} \&}]{direction\+In,  }\item[{const \mbox{\hyperlink{classosgeo_1_1proj_1_1common_1_1UnitOfMeasure}{common\+::\+Unit\+Of\+Measure}} \&}]{unit\+In,  }\item[{const \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_afa4113d8f296357469f7ff94c95869d9}{Meridian\+Ptr}} \&}]{meridian\+In = {\ttfamily nullptr} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Instantiate a \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}{Coordinate\+System\+Axis}}. 


\begin{DoxyParams}{Parameters}
{\em properties} & See \mbox{\hyperlink{general_doc_general_properties}{General properties}}. The name should generally be defined. \\
\hline
{\em abbreviation\+In} & Axis abbreviation (might be empty) \\
\hline
{\em direction\+In} & Axis direction \\
\hline
{\em unit\+In} & Axis unit \\
\hline
{\em meridian\+In} & The meridian that the axis follows from the pole, for a coordinate reference system centered on a pole, or nullptr \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a new \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis}{Coordinate\+System\+Axis}}. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac9ca82cdccd93ced1f9fc41c34160b9f}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac9ca82cdccd93ced1f9fc41c34160b9f}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!direction@{direction}}
\index{direction@{direction}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{direction()}{direction()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{classosgeo_1_1proj_1_1cs_1_1AxisDirection}{Axis\+Direction}} \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::direction (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the axis direction. 

The direction of this coordinate system axis (or in the case of Cartesian projected coordinates, the direction of this coordinate system axis locally) Examples\+: north or south, east or west, up or down. Within any set of coordinate system axes, only one of each pair of terms can be used. For Earth-\/fixed CRSs, this direction is often approximate and intended to provide a human interpretable meaning to the axis. When a geodetic reference frame is used, the precise directions of the axes may therefore vary slightly from this approximate direction. Note that an Engineering\+CRS often requires specific descriptions of the directions of its coordinate system axes.

\begin{DoxyReturn}{Returns}
the direction. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_adbde9c493dd93adea424c60e54d492b8}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_adbde9c493dd93adea424c60e54d492b8}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!maximumValue@{maximumValue}}
\index{maximumValue@{maximumValue}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{maximumValue()}{maximumValue()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1optional}{util\+::optional}}$<$ double $>$ \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::maximum\+Value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the maximum value normally allowed for this axis, in the unit for the axis. 

\begin{DoxyReturn}{Returns}
the maximum value, or empty. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a78af68ef700b34098fb024f64d386212}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_a78af68ef700b34098fb024f64d386212}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!meridian@{meridian}}
\index{meridian@{meridian}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{meridian()}{meridian()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespaceosgeo_1_1proj_1_1cs_afa4113d8f296357469f7ff94c95869d9}{Meridian\+Ptr}} \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::meridian (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the meridian that the axis follows from the pole, for a coordinate reference system centered on a pole. 

\begin{DoxyReturn}{Returns}
the meridian, or null. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac8a992c3d8b83c547a53e4b8ee45cfd8}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_ac8a992c3d8b83c547a53e4b8ee45cfd8}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!minimumValue@{minimumValue}}
\index{minimumValue@{minimumValue}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{minimumValue()}{minimumValue()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{classosgeo_1_1proj_1_1util_1_1optional}{util\+::optional}}$<$ double $>$ \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::minimum\+Value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the minimum value normally allowed for this axis, in the unit for the axis. 

\begin{DoxyReturn}{Returns}
the minimum value, or empty. 
\end{DoxyReturn}
\mbox{\Hypertarget{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_aa2ca35f6b1ea464374d6db27353669e5}\label{classosgeo_1_1proj_1_1cs_1_1CoordinateSystemAxis_aa2ca35f6b1ea464374d6db27353669e5}} 
\index{osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}!unit@{unit}}
\index{unit@{unit}!osgeo::proj::cs::CoordinateSystemAxis@{osgeo::proj::cs::CoordinateSystemAxis}}
\doxysubsubsection{\texorpdfstring{unit()}{unit()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{classosgeo_1_1proj_1_1common_1_1UnitOfMeasure}{common\+::\+Unit\+Of\+Measure}} \& osgeo\+::proj\+::cs\+::\+Coordinate\+System\+Axis\+::unit (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Return the axis unit. 

This is the spatial unit or temporal quantity used for this coordinate system axis. The value of a coordinate in a coordinate tuple shall be recorded using this unit.

\begin{DoxyReturn}{Returns}
the axis unit. 
\end{DoxyReturn}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
include/proj/coordinatesystem.\+hpp\item 
src/iso19111/coordinatesystem.\+cpp\end{DoxyCompactItemize}
