diff options
Diffstat (limited to 'c++/src/cpplus_RM/_h5_enum_type_8h_source.html')
| -rw-r--r-- | c++/src/cpplus_RM/_h5_enum_type_8h_source.html | 171 |
1 files changed, 171 insertions, 0 deletions
diff --git a/c++/src/cpplus_RM/_h5_enum_type_8h_source.html b/c++/src/cpplus_RM/_h5_enum_type_8h_source.html new file mode 100644 index 0000000..e3b58e1 --- /dev/null +++ b/c++/src/cpplus_RM/_h5_enum_type_8h_source.html @@ -0,0 +1,171 @@ +<!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>HDF5 C++ API: H5EnumType.h Source File</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 id="projectlogo"><img alt="Logo" src="hdf_logo.jpg"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">HDF5 C++ API +  <span id="projectnumber">1.8.13</span> + </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="annotated.html"><span>Classes</span></a></li> + <li><a href="examples.html"><span>Examples</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><!-- top --> +<!-- 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>Classes</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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</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 class="header"> + <div class="headertitle"> +<div class="title">H5EnumType.h</div> </div> +</div><!--header--> +<div class="contents"> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// C++ informative line for the emacs editor: -*- C++ -*-</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright by The HDF Group. *</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright by the Board of Trustees of the University of Illinois. *</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * All rights reserved. *</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * *</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This file is part of HDF5. The full HDF5 copyright notice, including *</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * terms governing use, modification, and redistribution, is contained in *</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the files COPYING and Copyright.html. COPYING can be found at the root *</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * of the source code distribution tree; Copyright.html can be found at the *</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * root level of an installed copy of the electronic HDF5 document set and *</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * is linked from the top-level documents page. It can also be found at *</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * access to either file, you may request a copy from help@hdfgroup.org. *</span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __H5EnumType_H</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __H5EnumType_H</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="keyword">namespace </span>H5 {</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_h5_1_1_enum_type.html"> 25</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a> : <span class="keyword">public</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a> {</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">public</span>:</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// Creates an empty enumeration datatype based on a native signed</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// integer type, whose size is given by size.</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>( <span class="keywordtype">size_t</span> size );</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">// Gets the enum datatype of the specified dataset</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_set.html">DataSet</a>& dataset ); <span class="comment">// H5Dget_type</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Creates a new enum datatype based on an integer datatype</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_int_type.html">IntType</a>& data_type ); <span class="comment">// H5Tenum_create</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Returns the number of members in this enumeration datatype.</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">int</span> getNmembers () <span class="keyword">const</span>;</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Returns the index of a member in this enumeration data type.</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> getMemberIndex(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">int</span> getMemberIndex(<span class="keyword">const</span> H5std_string& name) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Returns the value of an enumeration datatype member</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> getMemberValue( <span class="keywordtype">unsigned</span> memb_no, <span class="keywordtype">void</span> *value ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Inserts a new member to this enumeration type.</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> insert( <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">void</span> *value ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> insert( <span class="keyword">const</span> H5std_string& name, <span class="keywordtype">void</span> *value ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Returns the symbol name corresponding to a specified member</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// of this enumeration datatype.</span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  H5std_string nameOf( <span class="keywordtype">void</span> *value, <span class="keywordtype">size_t</span> size ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Returns the value corresponding to a specified member of this</span></div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// enumeration datatype.</span></div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> valueOf( <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">void</span> *value ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> valueOf( <span class="keyword">const</span> H5std_string& name, <span class="keywordtype">void</span> *value ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> +<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_h5_1_1_enum_type.html#a03bd511aa2455d34bb092a183408a734"> 62</a></span>  <span class="keyword">virtual</span> H5std_string <a class="code" href="class_h5_1_1_enum_type.html#a03bd511aa2455d34bb092a183408a734">fromClass</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(<span class="stringliteral">"EnumType"</span>); }</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Default constructor</span></div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>();</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Creates an enumeration datatype using an existing id</span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>( <span class="keyword">const</span> hid_t existing_id );</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Copy constructor: makes a copy of the original EnumType object.</span></div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>& original );</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_enum_type.html">EnumType</a>();</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> };</div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span>}</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __H5EnumType_H</span></div> +<div class="ttc" id="class_h5_1_1_enum_type_html"><div class="ttname"><a href="class_h5_1_1_enum_type.html">H5::EnumType</a></div><div class="ttdoc">Class EnumType operates on HDF5 enum datatypes. </div><div class="ttdef"><b>Definition:</b> H5EnumType.h:25</div></div> +<div class="ttc" id="class_h5_1_1_int_type_html"><div class="ttname"><a href="class_h5_1_1_int_type.html">H5::IntType</a></div><div class="ttdoc">Class IntType operates on HDF5 integer datatype. </div><div class="ttdef"><b>Definition:</b> H5IntType.h:25</div></div> +<div class="ttc" id="class_h5_1_1_data_type_html"><div class="ttname"><a href="class_h5_1_1_data_type.html">H5::DataType</a></div><div class="ttdoc">Class DataType provides generic operations on HDF5 datatypes. </div><div class="ttdef"><b>Definition:</b> H5DataType.h:31</div></div> +<div class="ttc" id="class_h5_1_1_data_set_html"><div class="ttname"><a href="class_h5_1_1_data_set.html">H5::DataSet</a></div><div class="ttdoc">Class DataSet operates on HDF5 datasets. </div><div class="ttdef"><b>Definition:</b> H5DataSet.h:31</div></div> +<div class="ttc" id="class_h5_1_1_enum_type_html_a03bd511aa2455d34bb092a183408a734"><div class="ttname"><a href="class_h5_1_1_enum_type.html#a03bd511aa2455d34bb092a183408a734">H5::EnumType::fromClass</a></div><div class="ttdeci">virtual H5std_string fromClass() const </div><div class="ttdoc">Returns this class name. </div><div class="ttdef"><b>Definition:</b> H5EnumType.h:62</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Jul 21 2014 10:58:44 for HDF5 C++ API 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> |