Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > c9cfbd1355daacaf3b34517a6d7b18cc > files > 639

libdap-doc-3.11.0-2.fc15.i686.rpm

<!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"/>
<title>libdap++: libdap::DapObj Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">libdap++&#160;<span id="projectnumber">Updated for version 3.8.2</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classlibdap_1_1DapObj.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>libdap::DapObj Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="libdap::DapObj" -->
<p>libdap base object for common functionality of libdap objects  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="DapObj_8h_source.html">DapObj.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for libdap::DapObj:</div>
<div class="dyncontent">
<div class="center"><img src="classlibdap_1_1DapObj__inherit__graph.png" border="0" usemap="#libdap_1_1DapObj_inherit__map" alt="Inheritance graph"/></div>
<map name="libdap_1_1DapObj_inherit__map" id="libdap_1_1DapObj_inherit__map">
<area shape="rect" id="node3" href="classlibdap_1_1AttrTable.html" title="Contains the attributes for a dataset." alt="" coords="1115,147,1405,1354"/><area shape="rect" id="node5" href="classlibdap_1_1BaseType.html" title="The basic data type for the DODS DAP types." alt="" coords="1429,265,1680,1237"/><area shape="rect" id="node37" href="classlibdap_1_1DAS.html" title="Hold attribute data for a DAP2 dataset." alt="" coords="2315,529,2616,973"/><area shape="rect" id="node39" href="classlibdap_1_1DDS.html" title="{libdap::DDS\n|&#45; d_attr\l&#45; d_container\l&#45; d_container_name\l&#45; d_dap_major\l&#45; d_dap_minor\l&#45; d_factory\l&#45; d_filename\l&#45; d_request_xml_base\l&#45; d_timeout\l&#45; name\l&#45; vars\l|+ add_var()\l+ check_semantics()\l+ DDS()\l+ DDS()\l+ del_var()\l+ del_var()\l+ del_var()\l+ dump()\l+ get_attr_table()\l+ get_dap_major()\l+ get_dap_minor()\l+ get_factory()\l+ get_request_xml_base()\l+ get_timeout()\l+ get_var_index()\l+ get_vars_iter()\l+ mark()\l+ mark_all()\l+ num_var()\l+ operator=()\l+ parse()\l+ parse()\l+ parse()\l+ print()\l+ print_constrained()\l+ print_xml()\l+ set_dap_major()\l+ set_dap_minor()\l+ set_dap_version()\l+ set_factory()\l+ set_request_xml_base()\l+ set_timeout()\l+ tag_nested_sequences()\l+ timeout_off()\l+ timeout_on()\l+ transfer_attributes()\l+ var()\l+ var()\l+ var_begin()\l+ var_end()\l+ var_rbegin()\l+ var_rend()\l+ ~DDS()\l+ get_dataset_name()\l+ set_dataset_name()\l+ filename()\l+ filename()\l+ container_name()\l+ container_name()\l+ container()\l# duplicate()\l# exact_match()\l# leaf_match()\l&#45; find_hdf4_dimension_attribute_home()\l* get_dataset_name()\l* set_dataset_name()\l* filename()\l* filename()\l* container_name()\l* container_name()\l* container()\l}" alt="" coords="2640,199,3043,1303"/><area shape="rect" id="node43" href="classlibdap_1_1Marshaller.html" title="abstract base class used to marshal/serialize dap data objects" alt="" coords="3071,617,3273,885"/><area shape="rect" id="node49" href="classlibdap_1_1UnMarshaller.html" title="abstract base class used to unmarshall/deserialize dap data objects" alt="" coords="3681,617,3903,885"/><area shape="rect" id="node7" href="classlibdap_1_1Byte.html" title="Holds a single byte." alt="" coords="60,1953,252,2250"/><area shape="rect" id="node9" href="classlibdap_1_1Constructor.html" title="{libdap::Constructor\n|# _vars\l|+ dump()\l+ get_var_index()\l+ get_vars_iter()\l+ is_linear()\l+ operator=()\l+ print_decl()\l+ print_xml()\l+ transfer_attributes()\l+ var_begin()\l+ var_end()\l+ var_rbegin()\l+ var_rend()\l+ ~Constructor()\l# _duplicate()\l# Constructor()\l# Constructor()\l# Constructor()\l&#45; Constructor()\l&#45; find_hdf4_dimension_attribute_home()\l}" alt="" coords="276,1931,679,2272"/><area shape="rect" id="node17" href="classlibdap_1_1Float32.html" title="Holds a 32&#45;bit floating point value." alt="" coords="703,1953,895,2250"/><area shape="rect" id="node19" href="classlibdap_1_1Float64.html" title="Holds a 64&#45;bit (double precision) floating point value." alt="" coords="919,1953,1111,2250"/><area shape="rect" id="node21" href="classlibdap_1_1Int16.html" title="Holds a 16&#45;bit signed integer value." alt="" coords="1135,1953,1327,2250"/><area shape="rect" id="node23" href="classlibdap_1_1Int32.html" title="Holds a 32&#45;bit signed integer." alt="" coords="1351,1953,1543,2250"/><area shape="rect" id="node25" href="classlibdap_1_1Str.html" title="Holds character string data." alt="" coords="1567,1945,1759,2257"/><area shape="rect" id="node29" href="classlibdap_1_1UInt16.html" title="Holds an unsigned 16&#45;bit integer." alt="" coords="1783,1953,1975,2250"/><area shape="rect" id="node31" href="classlibdap_1_1UInt32.html" title="Holds a 32&#45;bit unsigned integer." alt="" coords="1999,1953,2191,2250"/><area shape="rect" id="node33" href="classlibdap_1_1Vector.html" title="Holds a one&#45;dimensional collection of DAP2 data types." alt="" coords="2215,1403,2647,2800"/><area shape="rect" id="node11" href="classlibdap_1_1Grid.html" title="Holds the Grid data type." alt="" coords="5,3017,288,3666"/><area shape="rect" id="node13" href="classlibdap_1_1Sequence.html" title="Holds a sequence." alt="" coords="312,2848,643,3835"/><area shape="rect" id="node15" href="classlibdap_1_1Structure.html" title="Holds a structure (aggregate) type." alt="" coords="667,3097,899,3585"/><area shape="rect" id="node27" href="classlibdap_1_1Url.html" title="Holds an Internet address (URL)." alt="" coords="1567,3281,1759,3402"/><area shape="rect" id="node35" href="classlibdap_1_1Array.html" title="A multidimensional array of identical data types." alt="" coords="2320,3090,2541,3593"/><area shape="rect" id="node41" href="classlibdap_1_1DataDDS.html" title="Holds a DAP2 DDS." alt="" coords="2671,1938,3012,2265"/><area shape="rect" id="node45" href="classlibdap_1_1XDRFileMarshaller.html" title="marshaller that knows how to marshall/serialize dap data objects to a file using XDR" alt="" coords="3036,1931,3308,2272"/><area shape="rect" id="node47" href="classlibdap_1_1XDRStreamMarshaller.html" title="marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using XDR..." alt="" coords="3332,1916,3623,2287"/><area shape="rect" id="node51" href="classlibdap_1_1XDRFileUnMarshaller.html" title="unmarshaller that knows how to unmarshall/deserialize dap objects using XDR from a file..." alt="" coords="3647,1931,3937,2272"/><area shape="rect" id="node53" href="classlibdap_1_1XDRStreamUnMarshaller.html" title="unmarshaller that knows how to unmarshall/deserialize dap objects using XDR from a file..." alt="" coords="3961,1916,4273,2287"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classlibdap_1_1DapObj-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1DapObj.html#a20c50270e1a9e4526444f7f2c0c935c6">dump</a> (ostream &amp;strm) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">dump the contents of this object to the specified ostream  <a href="#a20c50270e1a9e4526444f7f2c0c935c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlibdap_1_1DapObj.html#a18783d1c71c1ccec3d2d0c8ee995530b">~DapObj</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A base object for any libdap objects to use. Provides simple methods for dumping the contents of the object. </p>

<p>Definition at line <a class="el" href="DapObj_8h_source.html#l00055">55</a> of file <a class="el" href="DapObj_8h_source.html">DapObj.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a18783d1c71c1ccec3d2d0c8ee995530b"></a><!-- doxytag: member="libdap::DapObj::~DapObj" ref="a18783d1c71c1ccec3d2d0c8ee995530b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual libdap::DapObj::~DapObj </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="DapObj_8h_source.html#l00058">58</a> of file <a class="el" href="DapObj_8h_source.html">DapObj.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a20c50270e1a9e4526444f7f2c0c935c6"></a><!-- doxytag: member="libdap::DapObj::dump" ref="a20c50270e1a9e4526444f7f2c0c935c6" args="(ostream &amp;strm) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void libdap::DapObj::dump </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&#160;</td>
          <td class="paramname"><em>strm</em></td><td>)</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This method is implemented by all derived classes to dump their contents, in other words, any state they might have, private variables, etc...</p>
<p>The inline function below can be used to dump the contents of an OPeNDAOObj object. For example, the object Animal is derived from <a class="el" href="classlibdap_1_1DapObj.html" title="libdap base object for common functionality of libdap objects">DapObj</a>. A user could do the following:</p>
<p>Animal *a = new dog( "Sparky" ) ; cout &lt;&lt; a &lt;&lt; endl ;</p>
<p>And the dump method for dog could display the name passed into the constructor, the (this) pointer of the object, etc...</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">strm</td><td>C++ i/o stream to dump the object to </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classlibdap_1_1Array.html#a292d09e6995cbe722e92973c9dc98c7f">libdap::Array</a>, <a class="el" href="classlibdap_1_1AttrTable.html#aa83039e176ada59b990c68b6f3c2cdb7">libdap::AttrTable</a>, <a class="el" href="classlibdap_1_1BaseType.html#a1ecd80ca994b950bd19b5f525fa4c7a2">libdap::BaseType</a>, <a class="el" href="classlibdap_1_1Byte.html#a7a8dcba1239f9e3f3f40f622fc3ce859">libdap::Byte</a>, <a class="el" href="classlibdap_1_1Constructor.html#af411561f4f57c632b4d0a6f091f98ce4">libdap::Constructor</a>, <a class="el" href="classlibdap_1_1DAS.html#a7acd3373e34b8776f08c2a8e49f6fa01">libdap::DAS</a>, <a class="el" href="classlibdap_1_1DataDDS.html#a7241f19eb2d6949cd3dd5522fbd85966">libdap::DataDDS</a>, <a class="el" href="classlibdap_1_1DDS.html#aebc046a3091961db2802334ddc9280e0">libdap::DDS</a>, <a class="el" href="classlibdap_1_1Float32.html#a8244fea2d040cdf884648cebd9892d46">libdap::Float32</a>, <a class="el" href="classlibdap_1_1Float64.html#a86485dcfe248c7fe06d33d50887c686e">libdap::Float64</a>, <a class="el" href="classlibdap_1_1Grid.html#a1ebdcb9b7a3844582c543acaf20cc07c">libdap::Grid</a>, <a class="el" href="classlibdap_1_1Int16.html#ab58ac36f1a81dbfe6dcb99a58ed1140e">libdap::Int16</a>, <a class="el" href="classlibdap_1_1Int32.html#a385daf822e17979dbcb9b4c219020556">libdap::Int32</a>, <a class="el" href="classlibdap_1_1Marshaller.html#a7078da4e7473ec9cc1948a571b756586">libdap::Marshaller</a>, <a class="el" href="classlibdap_1_1Sequence.html#acd0961a9479c9224d7b08021bb4d0c36">libdap::Sequence</a>, <a class="el" href="classlibdap_1_1Str.html#ad706e5b2b72822d8a5a30cf9c50ce570">libdap::Str</a>, <a class="el" href="classlibdap_1_1Structure.html#ad7aacbec3d542618fa6ba4f42e3dde9a">libdap::Structure</a>, <a class="el" href="classlibdap_1_1UInt16.html#a7a497c9339a553c94a55fda54bf5ea31">libdap::UInt16</a>, <a class="el" href="classlibdap_1_1UInt32.html#a145819d11b103bb06e6f2b8aad03b070">libdap::UInt32</a>, <a class="el" href="classlibdap_1_1UnMarshaller.html#a0774e299c794c20f5b712773f6dd749b">libdap::UnMarshaller</a>, <a class="el" href="classlibdap_1_1Vector.html#a719617cae1386c64723abf845651ed4d">libdap::Vector</a>, <a class="el" href="classlibdap_1_1XDRFileMarshaller.html#adec06746eb6502d6166ad96069da0d94">libdap::XDRFileMarshaller</a>, <a class="el" href="classlibdap_1_1XDRFileUnMarshaller.html#afcd9de045c729321164cba5004746c29">libdap::XDRFileUnMarshaller</a>, <a class="el" href="classlibdap_1_1XDRStreamMarshaller.html#ab479a67018cfb49a9e3f46c7aad85302">libdap::XDRStreamMarshaller</a>, and <a class="el" href="classlibdap_1_1XDRStreamUnMarshaller.html#a709892593023e5ea542a0d24541c13d9">libdap::XDRStreamUnMarshaller</a>.</p>

<p>Referenced by <a class="el" href="DapObj_8h_source.html#l00103">operator&lt;&lt;()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DapObj_8h_source.html">DapObj.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacelibdap.html">libdap</a>      </li>
      <li class="navelem"><a class="el" href="classlibdap_1_1DapObj.html">DapObj</a>      </li>
      <li class="footer">Generated on Tue Feb 8 2011 for libdap++ by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>