diff options
Diffstat (limited to 'c++/src/cpplus_RM/_h5_attribute_8h_source.html')
| -rw-r--r-- | c++/src/cpplus_RM/_h5_attribute_8h_source.html | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/c++/src/cpplus_RM/_h5_attribute_8h_source.html b/c++/src/cpplus_RM/_h5_attribute_8h_source.html new file mode 100644 index 0000000..278b1c6 --- /dev/null +++ b/c++/src/cpplus_RM/_h5_attribute_8h_source.html @@ -0,0 +1,203 @@ +<!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: H5Attribute.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">H5Attribute.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 __H5Attribute_H</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __H5Attribute_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="l00032"></a><span class="lineno"><a class="line" href="class_h5_1_1_attribute.html"> 32</a></span> <span class="keyword">class </span>H5_DLLCPP <a class="code" href="class_h5_1_1_attribute.html">Attribute</a> : <span class="keyword">public</span> <a class="code" href="class_h5_1_1_abstract_ds.html">AbstractDs</a>, <span class="keyword">public</span> <a class="code" href="class_h5_1_1_id_component.html">IdComponent</a> {</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">public</span>:</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// Closes this attribute.</span></div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> close();</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Gets the name of the file, in which this attribute belongs.</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  H5std_string getFileName() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Gets the name of this attribute.</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  ssize_t getName(<span class="keywordtype">char</span>* attr_name, <span class="keywordtype">size_t</span> buf_size = 0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  H5std_string getName(<span class="keywordtype">size_t</span> len) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  H5std_string getName() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ssize_t getName(H5std_string& attr_name, <span class="keywordtype">size_t</span> len = 0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// The overloaded function below is replaced by the one above and it</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// is kept for backward compatibility purpose.</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ssize_t getName( <span class="keywordtype">size_t</span> buf_size, H5std_string& attr_name ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Gets a copy of the dataspace for this attribute.</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <a class="code" href="class_h5_1_1_data_space.html">DataSpace</a> getSpace() <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 amount of storage size required for this attribute.</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> hsize_t getStorageSize() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// Returns the in memory size of this attribute's data.</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getInMemDataSize() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// Reads data from this attribute.</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> read( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, <span class="keywordtype">void</span> *buf ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> read( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, H5std_string& strg ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Writes data to this attribute.</span></div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> write(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> write(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, <span class="keyword">const</span> H5std_string& strg ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// Flushes all buffers associated with the file specified by this</span></div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// attribute to disk.</span></div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> flush( H5F_scope_t scope ) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> +<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="class_h5_1_1_attribute.html#a800c95e9bfeaa725b3ed8d86351e90d5"> 71</a></span>  <span class="keyword">virtual</span> H5std_string <a class="code" href="class_h5_1_1_attribute.html#a800c95e9bfeaa725b3ed8d86351e90d5">fromClass</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(<span class="stringliteral">"Attribute"</span>); }</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="comment">// Creates a copy of an existing attribute using the attribute id</span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a>( <span class="keyword">const</span> hid_t attr_id );</div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Copy constructor: makes a copy of an existing Attribute object.</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a>( <span class="keyword">const</span> <a class="code" href="class_h5_1_1_attribute.html">Attribute</a>& original );</div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Default constructor</span></div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="class_h5_1_1_attribute.html">Attribute</a>();</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// Gets the attribute id.</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> hid_t getId() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// Destructor: properly terminates access to this attribute.</span></div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_h5_1_1_attribute.html">Attribute</a>();</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span> <span class="comment">// Sets the attribute id.</span></div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> p_setId(<span class="keyword">const</span> hid_t new_id);</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // DOXYGEN_SHOULD_SKIP_THIS</span></div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">private</span>:</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  hid_t id; <span class="comment">// HDF5 attribute id</span></div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// This function contains the common code that is used by</span></div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// getTypeClass and various API functions getXxxType</span></div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// defined in AbstractDs for generic datatype and specific</span></div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// sub-types</span></div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">virtual</span> hid_t p_get_type() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// Reads variable or fixed len strings from this attribute.</span></div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> p_read_variable_len(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, H5std_string& strg) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> p_read_fixed_len(<span class="keyword">const</span> <a class="code" href="class_h5_1_1_data_type.html">DataType</a>& mem_type, H5std_string& strg) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// do not inherit H5Object::iterateAttrs</span></div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">int</span> iterateAttrs() { <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// do not inherit H5Object::renameAttr</span></div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> renameAttr() {}</div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span></div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"></span>}</div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __H5Attribute_H</span></div> +<div class="ttc" id="class_h5_1_1_attribute_html_a800c95e9bfeaa725b3ed8d86351e90d5"><div class="ttname"><a href="class_h5_1_1_attribute.html#a800c95e9bfeaa725b3ed8d86351e90d5">H5::Attribute::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> H5Attribute.h:71</div></div> +<div class="ttc" id="class_h5_1_1_id_component_html"><div class="ttname"><a href="class_h5_1_1_id_component.html">H5::IdComponent</a></div><div class="ttdoc">Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier. </div><div class="ttdef"><b>Definition:</b> H5IdComponent.h:32</div></div> +<div class="ttc" id="class_h5_1_1_data_space_html"><div class="ttname"><a href="class_h5_1_1_data_space.html">H5::DataSpace</a></div><div class="ttdoc">Class DataSpace operates on HDF5 dataspaces. </div><div class="ttdef"><b>Definition:</b> H5DataSpace.h:25</div></div> +<div class="ttc" id="class_h5_1_1_attribute_html"><div class="ttname"><a href="class_h5_1_1_attribute.html">H5::Attribute</a></div><div class="ttdoc">Class Attribute operates on HDF5 attributes. </div><div class="ttdef"><b>Definition:</b> H5Attribute.h:32</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_abstract_ds_html"><div class="ttname"><a href="class_h5_1_1_abstract_ds.html">H5::AbstractDs</a></div><div class="ttdoc">AbstractDs is an abstract base class, inherited by Attribute and DataSet. </div><div class="ttdef"><b>Definition:</b> H5AbstractDs.h:39</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> |