Sophie

Sophie

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

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: OfxTransactionContainer 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>OfxTransactionContainer Class Reference</h1><!-- doxytag: class="OfxTransactionContainer" --><!-- doxytag: inherits="OfxGenericContainer,OfxGenericContainer" --><p>Inheritance diagram for OfxTransactionContainer:
<p><center><img src="classOfxTransactionContainer.png" usemap="#OfxTransactionContainer_map" border="0" alt=""></center>
<map name="OfxTransactionContainer_map">
<area href="classOfxGenericContainer.html" alt="OfxGenericContainer" shape="rect" coords="222,0,434,24">
<area href="classOfxGenericContainer.html" alt="OfxGenericContainer" shape="rect" coords="444,0,656,24">
<area href="classOfxBankTransactionContainer.html" alt="OfxBankTransactionContainer" shape="rect" coords="0,112,212,136">
<area href="classOfxBankTransactionContainer.html" alt="OfxBankTransactionContainer" shape="rect" coords="222,112,434,136">
<area href="classOfxInvestmentTransactionContainer.html" alt="OfxInvestmentTransactionContainer" shape="rect" coords="444,112,656,136">
<area href="classOfxInvestmentTransactionContainer.html" alt="OfxInvestmentTransactionContainer" shape="rect" coords="666,112,878,136">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a generic transaction. 
<p>

<p>
Definition at line <a class="el" href="ofx__containers_8hh-source.html#l00193">193</a> of file <a class="el" href="ofx__containers_8hh-source.html">ofx_containers.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"><a class="anchor" name="d43b43b1006be733490c4e25f8a41434"></a><!-- doxytag: member="OfxTransactionContainer::OfxTransactionContainer" ref="d43b43b1006be733490c4e25f8a41434" args="(LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#d43b43b1006be733490c4e25f8a41434">OfxTransactionContainer</a> (<a class="el" href="classLibofxContext.html">LibofxContext</a> *p_libofx_context, <a class="el" href="classOfxGenericContainer.html">OfxGenericContainer</a> *para_parentcontainer, string para_tag_identifier)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c24bf77f0154df5bdf134ebac97b12e"></a><!-- doxytag: member="OfxTransactionContainer::~OfxTransactionContainer" ref="8c24bf77f0154df5bdf134ebac97b12e" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#8c24bf77f0154df5bdf134ebac97b12e">~OfxTransactionContainer</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#efafa4ee0b6745e46e40b5bcafb322e6">add_attribute</a> (const string identifier, const string value)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add data to a container object.  <a href="#efafa4ee0b6745e46e40b5bcafb322e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3228dd35282322803e75f9f9015422f"></a><!-- doxytag: member="OfxTransactionContainer::add_account" ref="c3228dd35282322803e75f9f9015422f" args="(OfxAccountData *account_data)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#c3228dd35282322803e75f9f9015422f">add_account</a> (<a class="el" href="structOfxAccountData.html">OfxAccountData</a> *account_data)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#733ee231fef8e72248cd9ab78b169a99">gen_event</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate libofx.h events.  <a href="#733ee231fef8e72248cd9ab78b169a99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#f3e7ffa3a55d3c0c67229c436875ed1d">add_to_main_tree</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add this container to the main tree.  <a href="#f3e7ffa3a55d3c0c67229c436875ed1d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d43b43b1006be733490c4e25f8a41434"></a><!-- doxytag: member="OfxTransactionContainer::OfxTransactionContainer" ref="d43b43b1006be733490c4e25f8a41434" args="(LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>OfxTransactionContainer</b> (<a class="el" href="classLibofxContext.html">LibofxContext</a> *p_libofx_context, <a class="el" href="classOfxGenericContainer.html">OfxGenericContainer</a> *para_parentcontainer, string para_tag_identifier)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#2f1b9bed927fd4ae1b9f8dc7f70ba48b">add_attribute</a> (const string identifier, const string value)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add data to a container object.  <a href="#2f1b9bed927fd4ae1b9f8dc7f70ba48b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3228dd35282322803e75f9f9015422f"></a><!-- doxytag: member="OfxTransactionContainer::add_account" ref="c3228dd35282322803e75f9f9015422f" args="(OfxAccountData *account_data)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>add_account</b> (<a class="el" href="structOfxAccountData.html">OfxAccountData</a> *account_data)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#7281e2998d54cac58cbdeb46ebe16ede">gen_event</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate libofx.h events.  <a href="#7281e2998d54cac58cbdeb46ebe16ede"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#44769e07a94afa5f75ef8076729fc090">add_to_main_tree</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add this container to the main tree.  <a href="#44769e07a94afa5f75ef8076729fc090"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="309aeafe456a5fd7adb1f94adbfc91a1"></a><!-- doxytag: member="OfxTransactionContainer::data" ref="309aeafe456a5fd7adb1f94adbfc91a1" args="" -->
<a class="el" href="structOfxTransactionData.html">OfxTransactionData</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxTransactionContainer.html#309aeafe456a5fd7adb1f94adbfc91a1">data</a></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="efafa4ee0b6745e46e40b5bcafb322e6"></a><!-- doxytag: member="OfxTransactionContainer::add_attribute" ref="efafa4ee0b6745e46e40b5bcafb322e6" args="(const string identifier, const string value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxTransactionContainer::add_attribute           </td>
          <td>(</td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add data to a container object. 
<p>
Must be called once completed parsing an OFX SGML data element. The parent container should know what to do with it. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>identifier</em>&nbsp;</td><td>The name of the data element </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The concatenated string of the data </td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#6168716a931dc8e74bcb534fdadaf778">OfxGenericContainer</a>.
<p>
Reimplemented in <a class="el" href="classOfxBankTransactionContainer.html#9978c004a174afd5d013ca9806464d6d">OfxBankTransactionContainer</a>, <a class="el" href="classOfxInvestmentTransactionContainer.html#9122d7feb698cf423f92ec03aecb1e45">OfxInvestmentTransactionContainer</a>, <a class="el" href="classOfxBankTransactionContainer.html#9978c004a174afd5d013ca9806464d6d">OfxBankTransactionContainer</a>, and <a class="el" href="classOfxInvestmentTransactionContainer.html#9122d7feb698cf423f92ec03aecb1e45">OfxInvestmentTransactionContainer</a>.
<p>
Definition at line <a class="el" href="ofx__container__transaction_8cpp-source.html#l00093">93</a> of file <a class="el" href="ofx__container__transaction_8cpp-source.html">ofx_container_transaction.cpp</a>.
<p>
Referenced by <a class="el" href="ofx__container__transaction_8cpp-source.html#l00333">OfxInvestmentTransactionContainer::add_attribute()</a>, and <a class="el" href="ofx__container__transaction_8cpp-source.html#l00161">OfxBankTransactionContainer::add_attribute()</a>.
</div>
</div><p>
<a class="anchor" name="733ee231fef8e72248cd9ab78b169a99"></a><!-- doxytag: member="OfxTransactionContainer::gen_event" ref="733ee231fef8e72248cd9ab78b169a99" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OfxTransactionContainer::gen_event           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Generate libofx.h events. 
<p>
gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a callback function vas called, false otherwise. </dd></dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#a8ffd0a68bcea4f0048b392af5078105">OfxGenericContainer</a>.
<p>
Definition at line <a class="el" href="ofx__container__transaction_8cpp-source.html#l00065">65</a> of file <a class="el" href="ofx__container__transaction_8cpp-source.html">ofx_container_transaction.cpp</a>.
</div>
</div><p>
<a class="anchor" name="f3e7ffa3a55d3c0c67229c436875ed1d"></a><!-- doxytag: member="OfxTransactionContainer::add_to_main_tree" ref="f3e7ffa3a55d3c0c67229c436875ed1d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OfxTransactionContainer::add_to_main_tree           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add this container to the main tree. 
<p>
add_to_main_treegen_event will add the container to the main trees stored int the <a class="el" href="classOfxMainContainer.html">OfxMainContainer</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if successfull, false otherwise. </dd></dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#e9ddc283e5d9a2853d7e02b4d9584036">OfxGenericContainer</a>.
<p>
Definition at line <a class="el" href="ofx__container__transaction_8cpp-source.html#l00079">79</a> of file <a class="el" href="ofx__container__transaction_8cpp-source.html">ofx_container_transaction.cpp</a>.
</div>
</div><p>
<a class="anchor" name="2f1b9bed927fd4ae1b9f8dc7f70ba48b"></a><!-- doxytag: member="OfxTransactionContainer::add_attribute" ref="2f1b9bed927fd4ae1b9f8dc7f70ba48b" args="(const string identifier, const string value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void OfxTransactionContainer::add_attribute           </td>
          <td>(</td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add data to a container object. 
<p>
Must be called once completed parsing an OFX SGML data element. The parent container should know what to do with it. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>identifier</em>&nbsp;</td><td>The name of the data element </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>value</em>&nbsp;</td><td>The concatenated string of the data </td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#6168716a931dc8e74bcb534fdadaf778">OfxGenericContainer</a>.
<p>
Reimplemented in <a class="el" href="classOfxBankTransactionContainer.html#9978c004a174afd5d013ca9806464d6d">OfxBankTransactionContainer</a>, <a class="el" href="classOfxInvestmentTransactionContainer.html#9122d7feb698cf423f92ec03aecb1e45">OfxInvestmentTransactionContainer</a>, <a class="el" href="classOfxBankTransactionContainer.html#9978c004a174afd5d013ca9806464d6d">OfxBankTransactionContainer</a>, and <a class="el" href="classOfxInvestmentTransactionContainer.html#9122d7feb698cf423f92ec03aecb1e45">OfxInvestmentTransactionContainer</a>.
</div>
</div><p>
<a class="anchor" name="7281e2998d54cac58cbdeb46ebe16ede"></a><!-- doxytag: member="OfxTransactionContainer::gen_event" ref="7281e2998d54cac58cbdeb46ebe16ede" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int OfxTransactionContainer::gen_event           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Generate libofx.h events. 
<p>
gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a callback function vas called, false otherwise. </dd></dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#a8ffd0a68bcea4f0048b392af5078105">OfxGenericContainer</a>.
</div>
</div><p>
<a class="anchor" name="44769e07a94afa5f75ef8076729fc090"></a><!-- doxytag: member="OfxTransactionContainer::add_to_main_tree" ref="44769e07a94afa5f75ef8076729fc090" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int OfxTransactionContainer::add_to_main_tree           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add this container to the main tree. 
<p>
add_to_main_treegen_event will add the container to the main trees stored int the <a class="el" href="classOfxMainContainer.html">OfxMainContainer</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if successfull, false otherwise. </dd></dl>

<p>
Reimplemented from <a class="el" href="classOfxGenericContainer.html#e9ddc283e5d9a2853d7e02b4d9584036">OfxGenericContainer</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ofx__containers_8hh-source.html">ofx_containers.hh</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__containers_8hh-source.html">fx-0.9.1/lib/ofx_containers.hh</a><li><a class="el" href="ofx__container__transaction_8cpp-source.html">ofx_container_transaction.cpp</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__container__transaction_8cpp-source.html">fx-0.9.1/lib/ofx_container_transaction.cpp</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>