mirror of https://github.com/ecmwf/eccodes.git
627 lines
32 KiB
HTML
627 lines
32 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>eccodes: eccodes::codes_get Interface Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">eccodes
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>C Interface</span></a></li>
|
|
<li><a href="classeccodes.html"><span>F90 Interface</span></a></li>
|
|
<li><a href="namespaces.html"><span>Python Interface</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="functions.html"><span>Data Fields</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classeccodes.html">eccodes</a></li><li class="navelem"><a class="el" href="interfaceeccodes_1_1codes__get.html">codes_get</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">eccodes::codes_get Interface Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Get the value for a key from a grib message.
|
|
<a href="interfaceeccodes_1_1codes__get.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a15e9f187ba45e4a334f270884c59651e"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#a15e9f187ba45e4a334f270884c59651e">codes_get_int</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a15e9f187ba45e4a334f270884c59651e"><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value of a key from a message. <a href="#a15e9f187ba45e4a334f270884c59651e">More...</a><br/></td></tr>
|
|
<tr class="separator:a15e9f187ba45e4a334f270884c59651e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad85e9d6d052fdcbfade2d201357e391d"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#ad85e9d6d052fdcbfade2d201357e391d">codes_get_long</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:ad85e9d6d052fdcbfade2d201357e391d"><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value of a key from a message. <a href="#ad85e9d6d052fdcbfade2d201357e391d">More...</a><br/></td></tr>
|
|
<tr class="separator:ad85e9d6d052fdcbfade2d201357e391d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6c505dfdf5a75f51c07683abed39b68"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#ab6c505dfdf5a75f51c07683abed39b68">codes_get_real4</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:ab6c505dfdf5a75f51c07683abed39b68"><td class="mdescLeft"> </td><td class="mdescRight">Get the real(4) value of a key from a message. <a href="#ab6c505dfdf5a75f51c07683abed39b68">More...</a><br/></td></tr>
|
|
<tr class="separator:ab6c505dfdf5a75f51c07683abed39b68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ca22327e21aca686d29f8953e235839"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#a2ca22327e21aca686d29f8953e235839">codes_get_real8</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a2ca22327e21aca686d29f8953e235839"><td class="mdescLeft"> </td><td class="mdescRight">Get the real(8) value of a key from a message. <a href="#a2ca22327e21aca686d29f8953e235839">More...</a><br/></td></tr>
|
|
<tr class="separator:a2ca22327e21aca686d29f8953e235839"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b71df8830b162b7773cf4d1446b4303"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#a9b71df8830b162b7773cf4d1446b4303">codes_get_string</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a9b71df8830b162b7773cf4d1446b4303"><td class="mdescLeft"> </td><td class="mdescRight">Get the character value of a key from a message. <a href="#a9b71df8830b162b7773cf4d1446b4303">More...</a><br/></td></tr>
|
|
<tr class="separator:a9b71df8830b162b7773cf4d1446b4303"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adee61373d840f0f6a73be5d574a47a1e"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#adee61373d840f0f6a73be5d574a47a1e">codes_get_byte_array</a> (msgid, key, value, length, status)</td></tr>
|
|
<tr class="memdesc:adee61373d840f0f6a73be5d574a47a1e"><td class="mdescLeft"> </td><td class="mdescRight">Get the array of bytes (character) for a key from a message. <a href="#adee61373d840f0f6a73be5d574a47a1e">More...</a><br/></td></tr>
|
|
<tr class="separator:adee61373d840f0f6a73be5d574a47a1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a620d907f796a466b9b849be12e96a274"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#a620d907f796a466b9b849be12e96a274">codes_get_int_array</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a620d907f796a466b9b849be12e96a274"><td class="mdescLeft"> </td><td class="mdescRight">Get the integer array of values for a key from a message. <a href="#a620d907f796a466b9b849be12e96a274">More...</a><br/></td></tr>
|
|
<tr class="separator:a620d907f796a466b9b849be12e96a274"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1df5b7389172122fe2c84c4156f18d0"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#ae1df5b7389172122fe2c84c4156f18d0">codes_get_real4_array</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:ae1df5b7389172122fe2c84c4156f18d0"><td class="mdescLeft"> </td><td class="mdescRight">Get the real(4) array of values for a key from a message. <a href="#ae1df5b7389172122fe2c84c4156f18d0">More...</a><br/></td></tr>
|
|
<tr class="separator:ae1df5b7389172122fe2c84c4156f18d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b28e570e54dad5a779e0452d3ed66d4"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__get.html#a4b28e570e54dad5a779e0452d3ed66d4">codes_get_real8_array</a> (msgid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a4b28e570e54dad5a779e0452d3ed66d4"><td class="mdescLeft"> </td><td class="mdescRight">Get the real(8) array of values for a key from a message. <a href="#a4b28e570e54dad5a779e0452d3ed66d4">More...</a><br/></td></tr>
|
|
<tr class="separator:a4b28e570e54dad5a779e0452d3ed66d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Get the value for a key from a grib message. </p>
|
|
<p>Given a <em>gribid</em> and <em>key</em> as input a <em>value</em> for the <em>key</em> is returned. In some cases the <em>value</em> can be an array rather than a scalar. As examples of array keys we have "values","pl", "pv" respectively the data values, the list of number of points for each latitude in a reduced grid and the list of vertical levels. In these cases the <em>value</em> array must be allocated by the caller and their required dimension can be obtained with <a class="el" href="interfaceeccodes_1_1codes__get__size.html">codes_get_size</a>. <br/>
|
|
The <em>value</em> can be integer(4), real(4), real(8), character. Although each key has its own native type, a key of type integer can be retrieved (with <a class="el" href="interfaceeccodes_1_1codes__get.html">codes_get</a>) as real(4), real(8) or character. Analogous conversions are always provided when possible. Illegal conversions are real to integer and character to any other type.</p>
|
|
<p>The <em>gribid</em> references to a grib message loaded in memory.</p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a>, <a href="https://confluence.ecmwf.int/display/ECC/grib_print_data" target="_blank">grib_print_data.f90</a></p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__set.html" title="Set the value for a key in a grib message. ">codes_set</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>value can be a scalar or array of integer(4),real(4),real(8),character </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
|
|
<a class="anchor" id="adee61373d840f0f6a73be5d574a47a1e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_byte_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=1), dimension(:), intent(inout) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>length</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the array of bytes (character) for a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>character(len=1) array of byte values </td></tr>
|
|
<tr><td class="paramname">length</td><td>(optional) output: number of values retrieved </td></tr>
|
|
<tr><td class="paramname">status</td><td>(optional) CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a15e9f187ba45e4a334f270884c59651e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind = kindofint), intent(out) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the integer value of a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>the integer(4) value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a620d907f796a466b9b849be12e96a274"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_int_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), dimension(:), intent(inout), allocatable </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the integer array of values for a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.<br/>
|
|
Note: This function supports the <b>allocatable</b> array attribute</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>integer(4) array value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad85e9d6d052fdcbfade2d201357e391d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_long </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind = kindoflong), intent(out) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the integer value of a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>the integer(4) value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab6c505dfdf5a75f51c07683abed39b68"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_real4 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">real(kind = kindoffloat), intent(out) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the real(4) value of a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>the real(4) value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae1df5b7389172122fe2c84c4156f18d0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_real4_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">real(kind = kindoffloat), dimension(:), intent(inout), allocatable </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the real(4) array of values for a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.<br/>
|
|
Note: This function supports the <b>allocatable</b> array attribute</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>real(4) array value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2ca22327e21aca686d29f8953e235839"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_real8 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">real(kind = kindofdouble), intent(out) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the real(8) value of a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>the real(8) value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4b28e570e54dad5a779e0452d3ed66d4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_real8_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">real(kind = kindofdouble), dimension(:), intent(inout), allocatable </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the real(8) array of values for a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.<br/>
|
|
Note: This function supports the <b>allocatable</b> array attribute</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>real(8) array value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9b71df8830b162b7773cf4d1446b4303"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_get_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>msgid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(in) </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">character(len=*), intent(out) </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(out), optional </td>
|
|
<td class="paramname"><em>status</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the character value of a key from a message. </p>
|
|
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
|
|
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
|
|
<tr><td class="paramname">key</td><td>key name </td></tr>
|
|
<tr><td class="paramname">value</td><td>the character value </td></tr>
|
|
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this interface was generated from the following file:<ul>
|
|
<li>eccodes_f90.f90</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|