Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > 2c293755396b61d5feb669b6e142f13b > files > 212

lib64ofx-devel-0.9.9-2.mga4.x86_64.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>LibOFX: OfxSecurityData Struct 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.4 -->
<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">LibOFX</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="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</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>Data&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</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('structOfxSecurityData.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">OfxSecurityData Struct Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="OfxSecurityData" -->
<p>An abstraction of a security, such as a stock, mutual fund, etc.  
 <a href="structOfxSecurityData.html#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX mandatory elements</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The OFX spec defines the following elements as mandatory. The associated variables should all contain valid data but you should not trust the servers. Check if the associated *_valid is true before using them. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a1ad6b3667ca3ee7e3b3685e63c8bd1c6">unique_id</a> [OFX_UNIQUE_ID_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7ecd355d7f19287032fe54395a28a62"></a><!-- doxytag: member="OfxSecurityData::unique_id_valid" ref="aa7ecd355d7f19287032fe54395a28a62" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>unique_id_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#afddec0de534d0ab20cfd3ac562258615">unique_id_type</a> [OFX_UNIQUE_ID_TYPE_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dd2110777af7a80bdedc2775afa4415"></a><!-- doxytag: member="OfxSecurityData::unique_id_type_valid" ref="a4dd2110777af7a80bdedc2775afa4415" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>unique_id_type_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a24096ad3cb35be8e6adb626b23f45a83">secname</a> [OFX_SECNAME_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52b1cc129ff42506f38d361a91aa6b3b"></a><!-- doxytag: member="OfxSecurityData::secname_valid" ref="a52b1cc129ff42506f38d361a91aa6b3b" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>secname_valid</b></td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX optional elements</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The OFX spec defines the following elements as optional. If the associated *_valid is true, the corresponding element is present and the associated variable contains valid data. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a7d1091abe3015294844107a6c3d27da2">ticker</a> [OFX_TICKER_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70920a7c4c7db99ab3fdff9a69be1dcc"></a><!-- doxytag: member="OfxSecurityData::ticker_valid" ref="a70920a7c4c7db99ab3fdff9a69be1dcc" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>ticker_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#ab7e970b0d2efb4afd77e5140f6377eea">unitprice</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0393e16cd2a2e36ab3c08274eb3d2e4b"></a><!-- doxytag: member="OfxSecurityData::unitprice_valid" ref="a0393e16cd2a2e36ab3c08274eb3d2e4b" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>unitprice_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a39f70a97d1390f293a9726a014ed5736">date_unitprice</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4cd155f29e20ebc3e85de05f6178510"></a><!-- doxytag: member="OfxSecurityData::date_unitprice_valid" ref="ad4cd155f29e20ebc3e85de05f6178510" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>date_unitprice_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a02b3d96724074884948651a394897c95">currency</a> [OFX_CURRENCY_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d16df55fa63534c4d4d7a5c804e9fb6"></a><!-- doxytag: member="OfxSecurityData::currency_valid" ref="a2d16df55fa63534c4d4d7a5c804e9fb6" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>currency_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a097572b1667a4e859fd34578aee8cdd8">memo</a> [OFX_MEMO2_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b21ccb14b1e6cd0c23d5587e7ce51c1"></a><!-- doxytag: member="OfxSecurityData::memo_valid" ref="a3b21ccb14b1e6cd0c23d5587e7ce51c1" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>memo_valid</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#ad7eb637476081e452589d47f150ae83d">fiid</a> [OFX_FIID_LENGTH]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2fbfceb3bf84a0f6c455d783db81f62"></a><!-- doxytag: member="OfxSecurityData::fiid_valid" ref="ac2fbfceb3bf84a0f6c455d783db81f62" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><b>fiid_valid</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An abstraction of a security, such as a stock, mutual fund, etc. </p>
<p>The <a class="el" href="structOfxSecurityData.html" title="An abstraction of a security, such as a stock, mutual fund, etc.">OfxSecurityData</a> stucture is used to hols the securyty information inside a <a class="el" href="structOfxTransactionData.html" title="An abstraction of a transaction in an account.">OfxTransactionData</a> struct for investment transactions. </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00351">351</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>
</div><hr/><h2>Field Documentation</h2>
<a class="anchor" id="a02b3d96724074884948651a394897c95"></a><!-- doxytag: member="OfxSecurityData::currency" ref="a02b3d96724074884948651a394897c95" args="[OFX_CURRENCY_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#a02b3d96724074884948651a394897c95">OfxSecurityData::currency</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The currency is a string in ISO-4217 format. It overrides the one defined in the statement for the unit price </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00387">387</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="a39f70a97d1390f293a9726a014ed5736"></a><!-- doxytag: member="OfxSecurityData::date_unitprice" ref="a39f70a97d1390f293a9726a014ed5736" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">time_t <a class="el" href="structOfxSecurityData.html#a39f70a97d1390f293a9726a014ed5736">OfxSecurityData::date_unitprice</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The date as of which the unit price was valid. </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00382">382</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="ad7eb637476081e452589d47f150ae83d"></a><!-- doxytag: member="OfxSecurityData::fiid" ref="ad7eb637476081e452589d47f150ae83d" args="[OFX_FIID_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#ad7eb637476081e452589d47f150ae83d">OfxSecurityData::fiid</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The currency is a string in ISO-4217 format. It overrides the one defined in the statement for the unit price </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00395">395</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="a097572b1667a4e859fd34578aee8cdd8"></a><!-- doxytag: member="OfxSecurityData::memo" ref="a097572b1667a4e859fd34578aee8cdd8" args="[OFX_MEMO2_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#a097572b1667a4e859fd34578aee8cdd8">OfxSecurityData::memo</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Extra information not included in name </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00390">390</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="a24096ad3cb35be8e6adb626b23f45a83"></a><!-- doxytag: member="OfxSecurityData::secname" ref="a24096ad3cb35be8e6adb626b23f45a83" args="[OFX_SECNAME_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#a24096ad3cb35be8e6adb626b23f45a83">OfxSecurityData::secname</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The full name of the security </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00367">367</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="a7d1091abe3015294844107a6c3d27da2"></a><!-- doxytag: member="OfxSecurityData::ticker" ref="a7d1091abe3015294844107a6c3d27da2" args="[OFX_TICKER_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#a7d1091abe3015294844107a6c3d27da2">OfxSecurityData::ticker</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The ticker symbol of the security </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00375">375</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="a1ad6b3667ca3ee7e3b3685e63c8bd1c6"></a><!-- doxytag: member="OfxSecurityData::unique_id" ref="a1ad6b3667ca3ee7e3b3685e63c8bd1c6" args="[OFX_UNIQUE_ID_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#a1ad6b3667ca3ee7e3b3685e63c8bd1c6">OfxSecurityData::unique_id</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The id of the security being traded. </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00360">360</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="afddec0de534d0ab20cfd3ac562258615"></a><!-- doxytag: member="OfxSecurityData::unique_id_type" ref="afddec0de534d0ab20cfd3ac562258615" args="[OFX_UNIQUE_ID_TYPE_LENGTH]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structOfxSecurityData.html#afddec0de534d0ab20cfd3ac562258615">OfxSecurityData::unique_id_type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Usially "CUSIP" for FIs in north america </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00363">363</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<a class="anchor" id="ab7e970b0d2efb4afd77e5140f6377eea"></a><!-- doxytag: member="OfxSecurityData::unitprice" ref="ab7e970b0d2efb4afd77e5140f6377eea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structOfxSecurityData.html#ab7e970b0d2efb4afd77e5140f6377eea">OfxSecurityData::unitprice</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The price of each unit of the security, as of date_unitprice </p>

<p>Definition at line <a class="el" href="inc_2libofx_8h_source.html#l00378">378</a> of file <a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a>.</p>

<p>Referenced by <a class="el" href="ofx__container__security_8cpp_source.html#l00045">OfxSecurityContainer::add_attribute()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="inc_2libofx_8h_source.html">inc/libofx.h</a></li>
<li><a class="el" href="libofx-0_89_88_2inc_2libofx_8h_source.html">libofx-0.9.8/inc/libofx.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="structOfxSecurityData.html">OfxSecurityData</a>      </li>
      <li class="footer">Generated on Wed Apr 17 2013 22:12:00 for LibOFX by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
    </ul>
  </div>

</body>
</html>