Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > f53a3df8ddeca10007257b33f867a55e > files > 16

libofx-devel-0.9.1-2.fc12.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>LibOFX: OfxAggregate Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  </ul></div>
<h1>OfxAggregate Class Reference</h1><!-- doxytag: class="OfxAggregate" --><p>Inheritance diagram for OfxAggregate:
<p><center><img src="classOfxAggregate.png" usemap="#OfxAggregate_map" border="0" alt=""></center>
<map name="OfxAggregate_map">
<area href="classOfxRequest.html" alt="OfxRequest" shape="rect" coords="0,56,144,80">
<area href="classOfxRequest.html" alt="OfxRequest" shape="rect" coords="308,56,452,80">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="154,112,298,136">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="154,168,298,192">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="154,224,298,248">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="154,280,298,304">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="154,336,298,360">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="154,392,298,416">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="462,112,606,136">
<area href="classOfxAccountInfoRequest.html" alt="OfxAccountInfoRequest" shape="rect" coords="462,168,606,192">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="462,224,606,248">
<area href="classOfxPaymentRequest.html" alt="OfxPaymentRequest" shape="rect" coords="462,280,606,304">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="462,336,606,360">
<area href="classOfxStatementRequest.html" alt="OfxStatementRequest" shape="rect" coords="462,392,606,416">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A single aggregate as described in the OFX 1.02 specification. 
<p>
This aggregate has a tag, and optionally a number of subordinate elements and aggregates.<p>
An example is: &lt;CCACCTINFO&gt; &lt;CCACCTFROM&gt; &lt;ACCTID&gt;1234 &lt;/CCACCTFROM&gt; &lt;SUPTXDL&gt;Y &lt;SVCSTATUS&gt;ACTIVE &lt;/CCACCTINFO&gt; 
<p>

<p>
Definition at line <a class="el" href="ofx__aggregate_8hh-source.html#l00042">42</a> of file <a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#cc6e48f024666176d3b6f1feb1acfd77">OfxAggregate</a> (const string &amp;tag)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#5abc7ac34d575eaecde5f16310c766b8">Add</a> (const string &amp;tag, const string &amp;data)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#2b729bb656f47efcf2bcfffaa22814e9">Add</a> (const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &amp;sub)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#80a63abc3354e17ba17ecbe0d6f077b3">Output</a> (void) const</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#cc6e48f024666176d3b6f1feb1acfd77">OfxAggregate</a> (const string &amp;tag)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#5abc7ac34d575eaecde5f16310c766b8">Add</a> (const string &amp;tag, const string &amp;data)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#2b729bb656f47efcf2bcfffaa22814e9">Add</a> (const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &amp;sub)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxAggregate.html#80a63abc3354e17ba17ecbe0d6f077b3">Output</a> (void) const</td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="cc6e48f024666176d3b6f1feb1acfd77"></a><!-- doxytag: member="OfxAggregate::OfxAggregate" ref="cc6e48f024666176d3b6f1feb1acfd77" args="(const string &amp;tag)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OfxAggregate::OfxAggregate           </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>tag</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a new aggregate, using this tag<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>The tag of this aggregate </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="ofx__aggregate_8hh-source.html#l00050">50</a> of file <a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a>.
</div>
</div><p>
<a class="anchor" name="cc6e48f024666176d3b6f1feb1acfd77"></a><!-- doxytag: member="OfxAggregate::OfxAggregate" ref="cc6e48f024666176d3b6f1feb1acfd77" args="(const string &amp;tag)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OfxAggregate::OfxAggregate           </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>tag</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Creates a new aggregate, using this tag<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>The tag of this aggregate </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html#l00050">50</a> of file <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html">fx-0.9.1/lib/ofx_aggregate.hh</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5abc7ac34d575eaecde5f16310c766b8"></a><!-- doxytag: member="OfxAggregate::Add" ref="5abc7ac34d575eaecde5f16310c766b8" args="(const string &amp;tag, const string &amp;data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxAggregate::Add           </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Adds an element to this aggregate<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>The tag of the element to be added </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>The data of the element to be added </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="ofx__aggregate_8hh-source.html#l00059">59</a> of file <a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a>.
<p>
Referenced by <a class="el" href="ofx__request__statement_8cpp-source.html#l00059">OfxStatementRequest::BankStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00086">OfxStatementRequest::CreditCardStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00109">OfxStatementRequest::InvestmentStatementRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00191">libofx_request_payment_status()</a>, <a class="el" href="ofx__request__accountinfo_8cpp-source.html#l00074">OfxAccountInfoRequest::OfxAccountInfoRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00147">OfxPaymentRequest::OfxPaymentRequest()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00044">OfxStatementRequest::OfxStatementRequest()</a>, <a class="el" href="ofx__request_8cpp-source.html#l00110">OfxRequest::RequestMessage()</a>, and <a class="el" href="ofx__request_8cpp-source.html#l00082">OfxRequest::SignOnRequest()</a>.
</div>
</div><p>
<a class="anchor" name="2b729bb656f47efcf2bcfffaa22814e9"></a><!-- doxytag: member="OfxAggregate::Add" ref="2b729bb656f47efcf2bcfffaa22814e9" args="(const OfxAggregate &amp;sub)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxAggregate::Add           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>sub</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Adds a subordinate aggregate to this aggregate<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sub</em>&nbsp;</td><td>The aggregate to be added </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="ofx__aggregate_8hh-source.html#l00069">69</a> of file <a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a>.
</div>
</div><p>
<a class="anchor" name="80a63abc3354e17ba17ecbe0d6f077b3"></a><!-- doxytag: member="OfxAggregate::Output" ref="80a63abc3354e17ba17ecbe0d6f077b3" args="(void) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string OfxAggregate::Output           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Composes this aggregate into a string<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string form of this aggregate </dd></dl>

<p>
Definition at line <a class="el" href="ofx__aggregate_8hh-source.html#l00079">79</a> of file <a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a>.
<p>
Referenced by <a class="el" href="ofx__aggregate_8hh-source.html#l00069">Add()</a>, <a class="el" href="ofx__request__accountinfo_8cpp-source.html#l00030">libofx_request_accountinfo()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00134">libofx_request_payment()</a>, <a class="el" href="ofx__request__statement_8cpp-source.html#l00191">libofx_request_payment_status()</a>, and <a class="el" href="ofx__request__statement_8cpp-source.html#l00031">libofx_request_statement()</a>.
</div>
</div><p>
<a class="anchor" name="5abc7ac34d575eaecde5f16310c766b8"></a><!-- doxytag: member="OfxAggregate::Add" ref="5abc7ac34d575eaecde5f16310c766b8" args="(const string &amp;tag, const string &amp;data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxAggregate::Add           </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Adds an element to this aggregate<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>tag</em>&nbsp;</td><td>The tag of the element to be added </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>The data of the element to be added </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html#l00059">59</a> of file <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html">fx-0.9.1/lib/ofx_aggregate.hh</a>.
</div>
</div><p>
<a class="anchor" name="2b729bb656f47efcf2bcfffaa22814e9"></a><!-- doxytag: member="OfxAggregate::Add" ref="2b729bb656f47efcf2bcfffaa22814e9" args="(const OfxAggregate &amp;sub)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxAggregate::Add           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOfxAggregate.html">OfxAggregate</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>sub</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Adds a subordinate aggregate to this aggregate<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>sub</em>&nbsp;</td><td>The aggregate to be added </td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html#l00069">69</a> of file <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html">fx-0.9.1/lib/ofx_aggregate.hh</a>.
</div>
</div><p>
<a class="anchor" name="80a63abc3354e17ba17ecbe0d6f077b3"></a><!-- doxytag: member="OfxAggregate::Output" ref="80a63abc3354e17ba17ecbe0d6f077b3" args="(void) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string OfxAggregate::Output           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Composes this aggregate into a string<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string form of this aggregate </dd></dl>

<p>
Definition at line <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html#l00079">79</a> of file <a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html">fx-0.9.1/lib/ofx_aggregate.hh</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ofx__aggregate_8hh-source.html">ofx_aggregate.hh</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__aggregate_8hh-source.html">fx-0.9.1/lib/ofx_aggregate.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Feb 9 21:22:00 2009 for LibOFX by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>