diff options
Diffstat (limited to 'classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html')
-rw-r--r-- | classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html b/classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html new file mode 100644 index 0000000..76df520 --- /dev/null +++ b/classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html @@ -0,0 +1,292 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>HDF5: H5FD_ros3_fapl_t Class 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ + $(document).ready(function() { init_search(); }); +/* @license-end */ +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="hdf5doxy.css" rel="stylesheet" type="text/css"> +<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/> + --> +<script type="text/javascript" src="hdf5_navtree_hacks.js"></script> +</head> +<body> +<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div> +<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="HDFG-logo.png"/></td> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> +  <span id="projectnumber">1.15.0.ab4d2ae</span> + </div> + <div id="projectbrief">API Reference</div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.svg" + 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.svg" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</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="summary"> +<a href="#pub-methods">Public Member Functions</a> </div> + <div class="headertitle"> +<div class="title">H5FD_ros3_fapl_t Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Java representation of the ROS3 VFD file access property list (fapl) structure.</p> +<p>Used for the access of files hosted remotely on S3 by Amazon.</p> +<p>For simplicity, implemented assuming that all ROS3 fapls have components:</p><ul> +<li>version</li> +<li>authenticate</li> +<li>aws_region</li> +<li>secret_id</li> +<li>secret_key</li> +</ul> +<p>Future implementations may be created to enable different fapl "shapes" depending on provided version.</p> +<p>proposed: </p><pre class="fragment">H5FD_ros3_fapl_t (super class, has only version field) +H5FD_ros3_fapl_v1_t (extends super with Version 1 components) +H5FD_ros3_fapl_v2_t (extends super with Version 2 components) +and so on, for each version + +"super" is passed around, and is version-checked and re-cast as +appropriate +</pre> </div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for H5FD_ros3_fapl_t:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t__inherit__graph.png" border="0" usemap="#a_h5_f_d__ros3__fapl__t_inherit__map" alt="Inheritance graph"/></div> +<map name="a_h5_f_d__ros3__fapl__t_inherit__map" id="a_h5_f_d__ros3__fapl__t_inherit__map"> +<area shape="rect" title=" " alt="" coords="5,80,143,107"/> +<area shape="rect" title=" " alt="" coords="25,5,123,32"/> +</map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for H5FD_ros3_fapl_t:</div> +<div id="dynsection-1-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-1-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t__coll__graph.png" border="0" usemap="#a_h5_f_d__ros3__fapl__t_coll__map" alt="Collaboration graph"/></div> +<map name="a_h5_f_d__ros3__fapl__t_coll__map" id="a_h5_f_d__ros3__fapl__t_coll__map"> +<area shape="rect" title=" " alt="" coords="5,80,143,107"/> +<area shape="rect" title=" " alt="" coords="25,5,123,32"/> +</map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<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:ab1982478329a7b73f8eabd071ba3385b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html#ab1982478329a7b73f8eabd071ba3385b">H5FD_ros3_fapl_t</a> ()</td></tr> +<tr class="separator:ab1982478329a7b73f8eabd071ba3385b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a50bf165c98810bac98842dc0fee670da"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html#a50bf165c98810bac98842dc0fee670da">H5FD_ros3_fapl_t</a> (String region, String id, String key)</td></tr> +<tr class="separator:a50bf165c98810bac98842dc0fee670da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a39e5bc339e3b5924ec96de42fbb8f33f"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html#a39e5bc339e3b5924ec96de42fbb8f33f">equals</a> (Object o)</td></tr> +<tr class="separator:a39e5bc339e3b5924ec96de42fbb8f33f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a077e18fe97323c7194e2665ffc766399"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html#a077e18fe97323c7194e2665ffc766399">hashCode</a> ()</td></tr> +<tr class="separator:a077e18fe97323c7194e2665ffc766399"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad146fa8579a5f8a876c4688cc5a68520"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html#ad146fa8579a5f8a876c4688cc5a68520">toString</a> ()</td></tr> +<tr class="separator:ad146fa8579a5f8a876c4688cc5a68520"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ab1982478329a7b73f8eabd071ba3385b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab1982478329a7b73f8eabd071ba3385b">◆ </a></span>H5FD_ros3_fapl_t() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Create a "default" fapl_t structure, for anonymous access. </p> + +</div> +</div> +<a id="a50bf165c98810bac98842dc0fee670da"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a50bf165c98810bac98842dc0fee670da">◆ </a></span>H5FD_ros3_fapl_t() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a> </td> + <td>(</td> + <td class="paramtype">String </td> + <td class="paramname"><em>region</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">String </td> + <td class="paramname"><em>key</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Create a fapl_t structure with the specified components. If all are the empty string, is anonymous (non-authenticating). Region and ID must both be supplied for authentication.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">region</td><td>"aws region" for authenticating request </td></tr> + <tr><td class="paramname">id</td><td>"secret id" or "access id" for authenticating request </td></tr> + <tr><td class="paramname">key</td><td>"secret key" or "access key" for authenticating request </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a39e5bc339e3b5924ec96de42fbb8f33f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a39e5bc339e3b5924ec96de42fbb8f33f">◆ </a></span>equals()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">boolean equals </td> + <td>(</td> + <td class="paramtype">Object </td> + <td class="paramname"><em>o</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a077e18fe97323c7194e2665ffc766399"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a077e18fe97323c7194e2665ffc766399">◆ </a></span>hashCode()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int hashCode </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="ad146fa8579a5f8a876c4688cc5a68520"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad146fa8579a5f8a876c4688cc5a68520">◆ </a></span>toString()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">String toString </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>java/src/hdf/hdf5lib/structs/<a class="el" href="_h5_f_d__ros3__fapl__t_8java.html">H5FD_ros3_fapl_t.java</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><b>hdf</b></li><li class="navelem"><b>hdf5lib</b></li><li class="navelem"><a class="el" href="namespacehdf_1_1hdf5lib_1_1structs.html">structs</a></li><li class="navelem"><a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f_d__ros3__fapl__t.html">H5FD_ros3_fapl_t</a></li> + <li class="footer">Generated on Mon Jun 26 2023 19:01:41 for HDF5 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li> + </ul> +</div> +</body> +</html> |