Skip to content

GitLab

Commit 61d0ad95 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent c7a742f2
Hide whitespace changes
Inline Side-by-side
doc/tex/FUNCTIONS
View file @ 61d0ad95
......@@ -86,12 +86,12 @@ Function catalog:
-------------------------------------------------------------
cdiInqNatts Get number of attributes
cdiInqAtt Get information about an attribute
cdiDefAttTxt Define a text attribute
cdiInqAttTxt Get the value(s) of a text attribute
cdiDefAttInt Define an integer attribute
cdiInqAttInt Get the value(s) of an integer attribute
cdiDefAttFlt Define a floating point attribute
cdiInqAttFlt Get the value(s) of a floating point attribute
cdiDefAttTxt Define a text attribute
cdiInqAttTxt Get the value(s) of a text attribute
-------------------------------------------------------------
grid
-------------------------------------------------------------
......@@ -114,26 +114,12 @@ Function catalog:
gridInqXbounds Get the bounds of a X-axis
gridDefYbounds Define the bounds of a Y-axis
gridInqYbounds Get the bounds of a Y-axis
gridDefXname Define the name of a X-axis
gridInqXname Get the name of a X-axis
gridDefXlongname Define the longname of a X-axis
gridInqXlongname Get the longname of a X-axis
gridDefXunits Define the units of a X-axis
gridInqXunits Get the units of a X-axis
gridDefYname Define the name of a Y-axis
gridInqYname Get the name of a Y-axis
gridDefYlongname Define the longname of a Y-axis
gridInqYlongname Get the longname of a Y-axis
gridDefYunits Define the units of a Y-axis
gridInqYunits Get the units of a Y-axis
gridDefNumber Define the reference number for an unstructured grid
gridInqNumber Get the reference number to an unstructured grid
gridDefPosition Define the position of grid in the reference file
gridInqPosition Get the position of grid in the reference file
gridDefReference Define the reference URI for an unstructured grid
gridInqReference Get the reference URI to an unstructured grid
gridDefUUID Define the UUID for an unstructured grid
gridInqUUID Get the UUID to an unstructured grid
-------------------------------------------------------------
zaxis
-------------------------------------------------------------
......@@ -144,12 +130,6 @@ Function catalog:
zaxisDefLevels Define the levels of a Z-axis
zaxisInqLevels Get all levels of a Z-axis
zaxisInqLevel Get one level of a Z-axis
zaxisDefName Define the name of a Z-axis
zaxisInqName Get the name of a Z-axis
zaxisDefLongname Define the longname of a Z-axis
zaxisInqLongname Get the longname of a Z-axis
zaxisDefUnits Define the units of a Z-axis
zaxisInqUnits Get the units of a Z-axis
-------------------------------------------------------------
taxis
-------------------------------------------------------------
......
doc/tex/Modules
View file @ 61d0ad95
......@@ -61,12 +61,12 @@ cdiInqKeyBytes cdi_key
cdiInqNatts cdi_att
cdiInqAtt cdi_att
cdiDelAtt cdi_att
cdiDefAttTxt cdi_att
cdiInqAttTxt cdi_att
cdiDefAttInt cdi_att
cdiInqAttInt cdi_att
cdiDefAttFlt cdi_att
cdiInqAttFlt cdi_att
cdiDefAttTxt cdi_att
cdiInqAttTxt cdi_att
gridCreate grid
gridDestroy grid
gridDuplicate grid
......@@ -90,18 +90,6 @@ gridDefYbounds grid
gridInqYbounds grid
gridDefXpole grid
gridInqXpole grid
gridDefXname grid
gridInqXname grid
gridDefXlongname grid
gridInqXlongname grid
gridDefXunits grid
gridInqXunits grid
gridDefYname grid
gridInqYname grid
gridDefYlongname grid
gridInqYlongname grid
gridDefYunits grid
gridInqYunits grid
gridDefLambert grid
gridInqLambert grid
gridDefNumber grid
......@@ -110,8 +98,6 @@ gridDefPosition grid
gridInqPosition grid
gridDefReference grid
gridInqReference grid
gridDefUUID grid
gridInqUUID grid
zaxisCreate zaxis
zaxisDestroy zaxis
zaxisDuplicate zaxis
......@@ -127,12 +113,6 @@ zaxisInqLevel zaxis
zaxisDefVct zaxis
zaxisInqVctSize zaxis
zaxisInqVct zaxis
zaxisDefName zaxis
zaxisInqName zaxis
zaxisDefLongname zaxis
zaxisInqLongname zaxis
zaxisDefUnits zaxis
zaxisInqUnits zaxis
taxisCreate taxis
taxisDestroy taxis
taxisDuplicate taxis
......
doc/tex/attribute.tex
View file @ 61d0ad95
Attributes may be associated with each variable to specify non
CDI standard properties. CDI standard properties as code, name,
units, and missing value are directly associated with each variable by
the corresponding CDI function (e.g. {\htmlref{\texttt{vlistDefVarName}}{vlistDefVarName}}).
Attributes are metadata used to describe variables or a data set.
CDI distinguishes between key attributes and user attributes.
Key attributes are described in the last chapter.
User defined attributes are additional attributes that are not interpreted by CDI.
These attributes are only available for NetCDF datasets. Here they
correspond to all attributes that are not used by CDI as key attributes.
A user defined attribute has a variable to which it is assigned, a name, a type,
a length, and a sequence of one or more values.
The attributes have to be defined after the variable is created and
before the variable list is associated with a stream.
User defined attributes are only used for NetCDF datasets.
before the variables list is associated with a stream.
It is also possible to have attributes that are not associated with any variable.
These are called global attributes and are identified by using CDI\_GLOBAL as a
......
doc/tex/c_cdi_att.tex
View file @ 61d0ad95
......@@ -58,181 +58,199 @@ Pointer to location for returned attribute number.
\end{minipage}
\subsection{Define an integer attribute: \texttt{cdiDefAttInt}}
\index{cdiDefAttInt}
\label{cdiDefAttInt}
\subsection{Define a text attribute: \texttt{cdiDefAttTxt}}
\index{cdiDefAttTxt}
\label{cdiDefAttTxt}
The function {\texttt{cdiDefAttInt}} defines an integer attribute.
The function {\texttt{cdiDefAttTxt}} defines a text attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len,
const int *ip);
int cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{type}]
External data type ({\texttt{CDI\_DATATYPE\_INT16}} or {\texttt{CDI\_DATATYPE\_INT32}}).
\item[\texttt{len}]
Number of values provided for the attribute.
\item[\texttt{ip}]
Pointer to one or more integer values.
\item[\texttt{tp}]
Pointer to one or more character values.
\end{deflist}
\end{minipage}
\subsubsection*{Example}
\subsection{Get the value(s) of an integer attribute: \texttt{cdiInqAttInt}}
\index{cdiInqAttInt}
\label{cdiInqAttInt}
Here is an example using {\texttt{cdiDefAttTxt}} to define the attribute "description":
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
#include "cdi.h"
...
int vlistID, varID, status;
char text[] = "description of the variable";
...
vlistID = vlistCreate();
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARYING);
...
status = cdiDefAttTxt(vlistID, varID, "description", LEN(text), text);
...
\end{lstlisting}
The function {\texttt{cdiInqAttInt}} gets the values(s) of an integer attribute.
\subsection{Get the value(s) of a text attribute: \texttt{cdiInqAttTxt}}
\index{cdiInqAttTxt}
\label{cdiInqAttTxt}
The function {\texttt{cdiInqAttTxt}} gets the values(s) of a text attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int *ip);
int cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[\texttt{ip}]
Pointer location for returned integer attribute value(s).
\item[\texttt{tp}]
Pointer location for returned text attribute value(s).
\end{deflist}
\end{minipage}
\subsection{Define a floating point attribute: \texttt{cdiDefAttFlt}}
\index{cdiDefAttFlt}
\label{cdiDefAttFlt}
\subsection{Define an integer attribute: \texttt{cdiDefAttInt}}
\index{cdiDefAttInt}
\label{cdiDefAttInt}
The function {\texttt{cdiDefAttFlt}} defines a floating point attribute.
The function {\texttt{cdiDefAttInt}} defines an integer attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len,
const double *dp);
int cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len,
const int *ip);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{type}]
External data type ({\texttt{CDI\_DATATYPE\_FLT32}} or {\texttt{CDI\_DATATYPE\_FLT64}}).
External data type ({\texttt{CDI\_DATATYPE\_INT16}} or {\texttt{CDI\_DATATYPE\_INT32}}).
\item[\texttt{len}]
Number of values provided for the attribute.
\item[\texttt{dp}]
Pointer to one or more floating point values.
\item[\texttt{ip}]
Pointer to one or more integer values.
\end{deflist}
\end{minipage}
\subsection{Get the value(s) of a floating point attribute: \texttt{cdiInqAttFlt}}
\index{cdiInqAttFlt}
\label{cdiInqAttFlt}
\subsection{Get the value(s) of an integer attribute: \texttt{cdiInqAttInt}}
\index{cdiInqAttInt}
\label{cdiInqAttInt}
The function {\texttt{cdiInqAttFlt}} gets the values(s) of a floating point attribute.
The function {\texttt{cdiInqAttInt}} gets the values(s) of an integer attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double *dp);
int cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int *ip);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[\texttt{dp}]
Pointer location for returned floating point attribute value(s).
\item[\texttt{ip}]
Pointer location for returned integer attribute value(s).
\end{deflist}
\end{minipage}
\subsection{Define a text attribute: \texttt{cdiDefAttTxt}}
\index{cdiDefAttTxt}
\label{cdiDefAttTxt}
\subsection{Define a floating point attribute: \texttt{cdiDefAttFlt}}
\index{cdiDefAttFlt}
\label{cdiDefAttFlt}
The function {\texttt{cdiDefAttTxt}} defines a text attribute.
The function {\texttt{cdiDefAttFlt}} defines a floating point attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp);
int cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len,
const double *dp);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{type}]
External data type ({\texttt{CDI\_DATATYPE\_FLT32}} or {\texttt{CDI\_DATATYPE\_FLT64}}).
\item[\texttt{len}]
Number of values provided for the attribute.
\item[\texttt{tp}]
Pointer to one or more character values.
\item[\texttt{dp}]
Pointer to one or more floating point values.
\end{deflist}
\end{minipage}
\subsection{Get the value(s) of a text attribute: \texttt{cdiInqAttTxt}}
\index{cdiInqAttTxt}
\label{cdiInqAttTxt}
\subsection{Get the value(s) of a floating point attribute: \texttt{cdiInqAttFlt}}
\index{cdiInqAttFlt}
\label{cdiInqAttFlt}
The function {\texttt{cdiInqAttTxt}} gets the values(s) of a text attribute.
The function {\texttt{cdiInqAttFlt}} gets the values(s) of a floating point attribute.
\subsubsection*{Usage}
\begin{verbatim}
int cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp);
int cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double *dp);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[\texttt{tp}]
Pointer location for returned text attribute value(s).
\item[\texttt{dp}]
Pointer location for returned floating point attribute value(s).
\end{deflist}
\end{minipage}
doc/tex/c_grid.tex
View file @ 61d0ad95
......@@ -16,8 +16,8 @@ The function {\texttt{gridCreate}} creates a horizontal Grid.
\begin{deflist}{\texttt{gridtype}\ }
\item[\texttt{gridtype}]
The type of the grid, one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\texttt{GRID\_GENERIC}}, {\texttt{GRID\_GAUSSIAN}},
{\texttt{GRID\_LONLAT}}, {\texttt{GRID\_PROJECTION}}, {\texttt{GRID\_SPECTRAL}},
The valid {\CDI} grid types are {\texttt{GRID\_GENERIC}}, {\texttt{GRID\_LONLAT}},
{\texttt{GRID\_GAUSSIAN}}, {\texttt{GRID\_PROJECTION}}, {\texttt{GRID\_SPECTRAL}},
{\texttt{GRID\_GME}}, {\texttt{GRID\_CURVILINEAR}} and {\texttt{GRID\_UNSTRUCTURED}}.
\item[\texttt{size}]
Number of gridpoints.
......@@ -122,8 +122,8 @@ Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}} or
{\texttt{gridInqType}} returns the type of the grid,
one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\texttt{GRID\_GENERIC}}, {\texttt{GRID\_GAUSSIAN}},
{\texttt{GRID\_LONLAT}}, {\texttt{GRID\_PROJECTION}}, {\texttt{GRID\_SPECTRAL}}, {\texttt{GRID\_GME}},
The valid {\CDI} grid types are {\texttt{GRID\_GENERIC}}, {\texttt{GRID\_LONLAT}},
{\texttt{GRID\_GAUSSIAN}}, {\texttt{GRID\_PROJECTION}}, {\texttt{GRID\_SPECTRAL}}, {\texttt{GRID\_GME}},
{\texttt{GRID\_CURVILINEAR}} and {\texttt{GRID\_UNSTRUCTURED}}.
......@@ -519,324 +519,6 @@ Otherwise, 0 is returned and {\texttt{ybounds}} is empty.
\subsection{Define the name of a X-axis: \texttt{gridDefXname}}
\index{gridDefXname}
\label{gridDefXname}
The function {\texttt{gridDefXname}} defines the name of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXname(int gridID, const char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{name}]
Name of the X-axis.
\end{deflist}
\end{minipage}
\subsection{Get the name of a X-axis: \texttt{gridInqXname}}
\index{gridInqXname}
\label{gridInqXname}
The function {\texttt{gridInqXname}} returns the name of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridInqXname(int gridID, char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{vlistInqVarGrid}}{vlistInqVarGrid}}.
\item[\texttt{name}]
Name of the X-axis. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{gridInqXname}} returns the name of the X-axis to the parameter name.
\subsection{Define the longname of a X-axis: \texttt{gridDefXlongname}}
\index{gridDefXlongname}
\label{gridDefXlongname}
The function {\texttt{gridDefXlongname}} defines the longname of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXlongname(int gridID, const char *longname);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{longname}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{longname}]
Longname of the X-axis.
\end{deflist}
\end{minipage}
\subsection{Get the longname of a X-axis: \texttt{gridInqXlongname}}
\index{gridInqXlongname}
\label{gridInqXlongname}
The function {\texttt{gridInqXlongname}} returns the longname of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridInqXlongname(int gridID, char *longname);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{longname}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{vlistInqVarGrid}}{vlistInqVarGrid}}.
\item[\texttt{longname}]
Longname of the X-axis. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{gridInqXlongname}} returns the longname of the X-axis to the parameter longname.
\subsection{Define the units of a X-axis: \texttt{gridDefXunits}}
\index{gridDefXunits}
\label{gridDefXunits}
The function {\texttt{gridDefXunits}} defines the units of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXunits(int gridID, const char *units);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{units}]
Units of the X-axis.
\end{deflist}
\end{minipage}
\subsection{Get the units of a X-axis: \texttt{gridInqXunits}}
\index{gridInqXunits}
\label{gridInqXunits}
The function {\texttt{gridInqXunits}} returns the units of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridInqXunits(int gridID, char *units);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{vlistInqVarGrid}}{vlistInqVarGrid}}.
\item[\texttt{units}]
Units of the X-axis. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{gridInqXunits}} returns the units of the X-axis to the parameter units.
\subsection{Define the name of a Y-axis: \texttt{gridDefYname}}
\index{gridDefYname}
\label{gridDefYname}
The function {\texttt{gridDefYname}} defines the name of a Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefYname(int gridID, const char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{name}]
Name of the Y-axis.
\end{deflist}
\end{minipage}
\subsection{Get the name of a Y-axis: \texttt{gridInqYname}}
\index{gridInqYname}
\label{gridInqYname}
The function {\texttt{gridInqYname}} returns the name of a Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridInqYname(int gridID, char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{gridID}\ }
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{vlistInqVarGrid}}{vlistInqVarGrid}}.
\item[\texttt{name}]
Name of the Y-axis. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{gridInqYname}} returns the name of the Y-axis to the parameter name.
\subsection{Define the longname of a Y-axis: \texttt{gridDefYlongname}}
\index{gridDefYlongname}
\label{gridDefYlongname}
The function {\texttt{gridDefYlongname}} defines the longname of a Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefYlongname(int gridID, const char *longname);
\end{verbatim}