Commit e35cce89 authored by Fabian Wachsmann's avatar Fabian Wachsmann
Browse files

Added Showattribute documentation

parent 71f2600b
......@@ -3,6 +3,7 @@ Sinfo Information
Diff Information
Ninfo Information
Showinfo Information
Showattribute Information
Filedes Information
Copy File operations
Tee File operations
......
@BeginModule
@NewPage
@Name = Showattribute
@Title = Show a global attribute, a variable attribute or all attributes of one variable
@Section = Information
@Class = Information
@Arguments = infile
@Operators = showattribute showattsvar
@BeginDescription
This operator prints attributes of a dataset.
If a global attribute should be printed, the attribute name can be specified as a parameter directly.
If a variable attribute should be printed, the following format is requested:
@bold{var_nm}@@bold{att_nm}
@IfMan
var_nm Variable name. Example: pressure
att_nm Attribute name. Example: units
@EndifMan
@IfDoc
\begin{defalist}{\textbf{var_nm}}
\item[\ \ \ \textbf{var_nm}\ \ \hfill] Variable name. Example: pressure
\item[\ \ \ \textbf{att_nm}\ \ \hfill] Attribute name. Example: units
\end{defalist}
@EndifDoc
@EndDescription
@EndModule
@BeginOperator_showattribute
@Title = Show a global attribute or a variable attribute
@Parameter = attribute
@EndOperator
@BeginOperator_showattsvar
@Title = Show all variable attributes. If var_nm is specified, only for a subset of variables.
@Parameter = [var_nm]
@EndOperator
@BeginParameter
@Item = attribute
STRING Attribute in the format [var_nm@]att_nm
@Item = var_nm
STRING Variable name
@EndParameter
......@@ -5,7 +5,7 @@
@Section = Information
@Class = Information
@Arguments = infile
@Operators = showformat showcode showname showstdname showlevel showltype showyear showmon showdate showtime showtimestamp
@Operators = showformat showcode showname showstdname showatts showattsglob showlevel showltype showyear showmon showdate showtime showtimestamp
@BeginDescription
This module prints the format, variables, levels or times of the input dataset.
......@@ -48,6 +48,22 @@ Prints the standard name of all variables.
@EndDescription
@EndOperator
@BeginOperator_showatts
@Title = Show all attributes
@BeginDescription
Prints all variable and global attributes.
@EndDescription
@EndOperator
@BeginOperator_showattsglob
@Title = Show all global attributes
@BeginDescription
Prints all global attributes.
@EndDescription
@EndOperator
@BeginOperator_showlevel
......
......@@ -946,7 +946,7 @@ void init_modules()
add_module("Setzaxis" , {Setzaxis , SetzaxisHelp , SetzaxisOperators , 1 , CDI_BOTH , 1 , 1 });
add_module("Shiftxy" , {Shiftxy , {} , ShiftxyOperators , 1 , CDI_REAL , 1 , 1 });
add_module("Showinfo" , {Showinfo , ShowinfoHelp , ShowinfoOperators , 1 , CDI_BOTH , 1 , 0 });
add_module("Showattribute" , {Showattribute , {} , ShowattributeOperators , 1 , CDI_REAL , 1 , 0 });
add_module("Showattribute" , {Showattribute , ShowattributeHelp , ShowattributeOperators , 1 , CDI_REAL , 1 , 0 });
add_module("Sinfo" , {Sinfo , SinfoHelp , SinfoOperators , 1 , CDI_BOTH , -1 , 0 });
add_module("Smooth" , {Smooth , SmoothHelp , SmoothOperators , 1 , CDI_REAL , 1 , 1 });
add_module("Sort" , {Sort , {} , SortOperators , 1 , CDI_REAL , 1 , 1 });
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment