mirror of https://github.com/ecmwf/eccodes.git
351 lines
18 KiB
HTML
351 lines
18 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_index_select 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__index__select.html">codes_index_select</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_index_select Interface Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Select the message subset with key==value.
|
|
<a href="interfaceeccodes_1_1codes__index__select.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:ac84dca14749c6c8f7b1b32dbcb8c8f88"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__index__select.html#ac84dca14749c6c8f7b1b32dbcb8c8f88">codes_index_select_int</a> (indexid, key, value, status)</td></tr>
|
|
<tr class="memdesc:ac84dca14749c6c8f7b1b32dbcb8c8f88"><td class="mdescLeft"> </td><td class="mdescRight">Select the message subset with key==value. <a href="#ac84dca14749c6c8f7b1b32dbcb8c8f88">More...</a><br/></td></tr>
|
|
<tr class="separator:ac84dca14749c6c8f7b1b32dbcb8c8f88"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6acd94d169fc462c5babb5d654c07612"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__index__select.html#a6acd94d169fc462c5babb5d654c07612">codes_index_select_long</a> (indexid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a6acd94d169fc462c5babb5d654c07612"><td class="mdescLeft"> </td><td class="mdescRight">Select the message subset with key==value. <a href="#a6acd94d169fc462c5babb5d654c07612">More...</a><br/></td></tr>
|
|
<tr class="separator:a6acd94d169fc462c5babb5d654c07612"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a500fe1c101af888362bb60a94c68085e"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__index__select.html#a500fe1c101af888362bb60a94c68085e">codes_index_select_string</a> (indexid, key, value, status)</td></tr>
|
|
<tr class="memdesc:a500fe1c101af888362bb60a94c68085e"><td class="mdescLeft"> </td><td class="mdescRight">Select the message subset with key==value. <a href="#a500fe1c101af888362bb60a94c68085e">More...</a><br/></td></tr>
|
|
<tr class="separator:a500fe1c101af888362bb60a94c68085e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1a4e9f83a13d8ce9b046f141ee990cd"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__index__select.html#ae1a4e9f83a13d8ce9b046f141ee990cd">codes_index_select_real8</a> (indexid, key, value, status)</td></tr>
|
|
<tr class="memdesc:ae1a4e9f83a13d8ce9b046f141ee990cd"><td class="mdescLeft"> </td><td class="mdescRight">Select the message subset with key==value. <a href="#ae1a4e9f83a13d8ce9b046f141ee990cd">More...</a><br/></td></tr>
|
|
<tr class="separator:ae1a4e9f83a13d8ce9b046f141ee990cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Select the message subset with key==value. </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> index.f90</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
|
|
<tr><td class="paramname">key</td><td>key to be selected </td></tr>
|
|
<tr><td class="paramname">value</td><td>value of the key to select </td></tr>
|
|
<tr><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="ac84dca14749c6c8f7b1b32dbcb8c8f88"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_index_select_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>indexid</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(in) </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>Select the message subset with key==value. </p>
|
|
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</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> grib_index.f90</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
|
|
<tr><td class="paramname">key</td><td>key to be selected </td></tr>
|
|
<tr><td class="paramname">value</td><td>value of the key to select </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="a6acd94d169fc462c5babb5d654c07612"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_index_select_long </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>indexid</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(in) </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>Select the message subset with key==value. </p>
|
|
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</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> grib_index.f90</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
|
|
<tr><td class="paramname">key</td><td>key to be selected </td></tr>
|
|
<tr><td class="paramname">value</td><td>value of the key to select </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="ae1a4e9f83a13d8ce9b046f141ee990cd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_index_select_real8 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>indexid</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(in) </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>Select the message subset with key==value. </p>
|
|
<p>The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.</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> grib_index.f90</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
|
|
<tr><td class="paramname">key</td><td>key to be selected </td></tr>
|
|
<tr><td class="paramname">value</td><td>value of the key to select </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="a500fe1c101af888362bb60a94c68085e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">subroutine codes_index_select_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype">integer(kind=kindofint), intent(in) </td>
|
|
<td class="paramname"><em>indexid</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(in) </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>Select the message subset with key==value. </p>
|
|
<p>The value is a integer. The key must have been created with string type or have string as native type if the type was not explicitly defined in the index creation.</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> grib_index.f90</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
|
|
<tr><td class="paramname">key</td><td>key to be selected </td></tr>
|
|
<tr><td class="paramname">value</td><td>value of the key to select </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>
|