Sophie

Sophie

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

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: OfxSecurityContainer 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>OfxSecurityContainer Class Reference</h1><!-- doxytag: class="OfxSecurityContainer" --><!-- doxytag: inherits="OfxGenericContainer,OfxGenericContainer" --><p>Inheritance diagram for OfxSecurityContainer:
<p><center><img src="classOfxSecurityContainer.png" usemap="#OfxSecurityContainer_map" border="0" alt=""></center>
<map name="OfxSecurityContainer_map">
<area href="classOfxGenericContainer.html" alt="OfxGenericContainer" shape="rect" coords="0,0,134,24">
<area href="classOfxGenericContainer.html" alt="OfxGenericContainer" shape="rect" coords="144,0,278,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a security, such as a stock or bond. 
<p>

<p>
Definition at line <a class="el" href="ofx__containers_8hh-source.html#l00174">174</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="6463edacc95fc03733c0e7fb6776c15f"></a><!-- doxytag: member="OfxSecurityContainer::OfxSecurityContainer" ref="6463edacc95fc03733c0e7fb6776c15f" args="(LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxSecurityContainer.html#6463edacc95fc03733c0e7fb6776c15f">OfxSecurityContainer</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="5205f0a09177451b4a6420da7420c256"></a><!-- doxytag: member="OfxSecurityContainer::~OfxSecurityContainer" ref="5205f0a09177451b4a6420da7420c256" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxSecurityContainer.html#5205f0a09177451b4a6420da7420c256">~OfxSecurityContainer</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxSecurityContainer.html#97f5d5e139d4cbba9790bedc06fa156e">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="#97f5d5e139d4cbba9790bedc06fa156e"></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="classOfxSecurityContainer.html#22357ade2036de78947ac0cc0ce01f2d">gen_event</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate libofx.h events.  <a href="#22357ade2036de78947ac0cc0ce01f2d"></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="classOfxSecurityContainer.html#cbaa6366a60d903ee3b3748c9874157f">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="#cbaa6366a60d903ee3b3748c9874157f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6463edacc95fc03733c0e7fb6776c15f"></a><!-- doxytag: member="OfxSecurityContainer::OfxSecurityContainer" ref="6463edacc95fc03733c0e7fb6776c15f" args="(LibofxContext *p_libofx_context, OfxGenericContainer *para_parentcontainer, string para_tag_identifier)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>OfxSecurityContainer</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxSecurityContainer.html#97f5d5e139d4cbba9790bedc06fa156e">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="#97f5d5e139d4cbba9790bedc06fa156e"></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="classOfxSecurityContainer.html#847cb92d3247bef45535f8000c688d07">gen_event</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate libofx.h events.  <a href="#847cb92d3247bef45535f8000c688d07"></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="classOfxSecurityContainer.html#ace001be26cc920eefdfc9d695e5f3d9">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="#ace001be26cc920eefdfc9d695e5f3d9"></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="43397c78bdf1a342ca566e7524d36f0d"></a><!-- doxytag: member="OfxSecurityContainer::data" ref="43397c78bdf1a342ca566e7524d36f0d" args="" -->
<a class="el" href="structOfxSecurityData.html">OfxSecurityData</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOfxSecurityContainer.html#43397c78bdf1a342ca566e7524d36f0d">data</a></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="97f5d5e139d4cbba9790bedc06fa156e"></a><!-- doxytag: member="OfxSecurityContainer::add_attribute" ref="97f5d5e139d4cbba9790bedc06fa156e" args="(const string identifier, const string value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxSecurityContainer::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>
Definition at line <a class="el" href="ofx__container__security_8cpp-source.html#l00045">45</a> of file <a class="el" href="ofx__container__security_8cpp-source.html">ofx_container_security.cpp</a>.
</div>
</div><p>
<a class="anchor" name="22357ade2036de78947ac0cc0ce01f2d"></a><!-- doxytag: member="OfxSecurityContainer::gen_event" ref="22357ade2036de78947ac0cc0ce01f2d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OfxSecurityContainer::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__security_8cpp-source.html#l00084">84</a> of file <a class="el" href="ofx__container__security_8cpp-source.html">ofx_container_security.cpp</a>.
</div>
</div><p>
<a class="anchor" name="cbaa6366a60d903ee3b3748c9874157f"></a><!-- doxytag: member="OfxSecurityContainer::add_to_main_tree" ref="cbaa6366a60d903ee3b3748c9874157f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OfxSecurityContainer::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__security_8cpp-source.html#l00090">90</a> of file <a class="el" href="ofx__container__security_8cpp-source.html">ofx_container_security.cpp</a>.
</div>
</div><p>
<a class="anchor" name="97f5d5e139d4cbba9790bedc06fa156e"></a><!-- doxytag: member="OfxSecurityContainer::add_attribute" ref="97f5d5e139d4cbba9790bedc06fa156e" args="(const string identifier, const string value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OfxSecurityContainer::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>.
</div>
</div><p>
<a class="anchor" name="847cb92d3247bef45535f8000c688d07"></a><!-- doxytag: member="OfxSecurityContainer::gen_event" ref="847cb92d3247bef45535f8000c688d07" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int OfxSecurityContainer::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="ace001be26cc920eefdfc9d695e5f3d9"></a><!-- doxytag: member="OfxSecurityContainer::add_to_main_tree" ref="ace001be26cc920eefdfc9d695e5f3d9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int OfxSecurityContainer::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__security_8cpp-source.html">ofx_container_security.cpp</a><li><a class="el" href="fx-0_89_81_2lib_2ofx__container__security_8cpp-source.html">fx-0.9.1/lib/ofx_container_security.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>