1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>LibOFX: OfxSecurityData Struct 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.3 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<h1>OfxSecurityData Struct Reference</h1><!-- doxytag: class="OfxSecurityData" --><hr><a name="_details"></a><h2>Detailed Description</h2>
An abstraction of a security, such as a stock, mutual fund, etc.
<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>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00318">318</a> of file <a class="el" href="inc_2libofx_8h-source.html">inc/libofx.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>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">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. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#1ad6b3667ca3ee7e3b3685e63c8bd1c6">unique_id</a> [OFX_UNIQUE_ID_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7ecd355d7f19287032fe54395a28a62"></a><!-- doxytag: member="OfxSecurityData::unique_id_valid" ref="a7ecd355d7f19287032fe54395a28a62" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#a7ecd355d7f19287032fe54395a28a62">unique_id_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#fddec0de534d0ab20cfd3ac562258615">unique_id_type</a> [OFX_UNIQUE_ID_TYPE_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4dd2110777af7a80bdedc2775afa4415"></a><!-- doxytag: member="OfxSecurityData::unique_id_type_valid" ref="4dd2110777af7a80bdedc2775afa4415" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#4dd2110777af7a80bdedc2775afa4415">unique_id_type_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#24096ad3cb35be8e6adb626b23f45a83">secname</a> [OFX_SECNAME_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52b1cc129ff42506f38d361a91aa6b3b"></a><!-- doxytag: member="OfxSecurityData::secname_valid" ref="52b1cc129ff42506f38d361a91aa6b3b" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#52b1cc129ff42506f38d361a91aa6b3b">secname_valid</a></td></tr>
<tr><td colspan="2"><div class="groupHeader">OFX optional elements</div></td></tr>
<tr><td colspan="2"><div class="groupText">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. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#7d1091abe3015294844107a6c3d27da2">ticker</a> [OFX_TICKER_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70920a7c4c7db99ab3fdff9a69be1dcc"></a><!-- doxytag: member="OfxSecurityData::ticker_valid" ref="70920a7c4c7db99ab3fdff9a69be1dcc" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#70920a7c4c7db99ab3fdff9a69be1dcc">ticker_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#b7e970b0d2efb4afd77e5140f6377eea">unitprice</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0393e16cd2a2e36ab3c08274eb3d2e4b"></a><!-- doxytag: member="OfxSecurityData::unitprice_valid" ref="0393e16cd2a2e36ab3c08274eb3d2e4b" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#0393e16cd2a2e36ab3c08274eb3d2e4b">unitprice_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#39f70a97d1390f293a9726a014ed5736">date_unitprice</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4cd155f29e20ebc3e85de05f6178510"></a><!-- doxytag: member="OfxSecurityData::date_unitprice_valid" ref="d4cd155f29e20ebc3e85de05f6178510" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#d4cd155f29e20ebc3e85de05f6178510">date_unitprice_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#02b3d96724074884948651a394897c95">currency</a> [OFX_CURRENCY_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2d16df55fa63534c4d4d7a5c804e9fb6"></a><!-- doxytag: member="OfxSecurityData::currency_valid" ref="2d16df55fa63534c4d4d7a5c804e9fb6" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#2d16df55fa63534c4d4d7a5c804e9fb6">currency_valid</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#097572b1667a4e859fd34578aee8cdd8">memo</a> [OFX_MEMO2_LENGTH]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b21ccb14b1e6cd0c23d5587e7ce51c1"></a><!-- doxytag: member="OfxSecurityData::memo_valid" ref="3b21ccb14b1e6cd0c23d5587e7ce51c1" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOfxSecurityData.html#3b21ccb14b1e6cd0c23d5587e7ce51c1">memo_valid</a></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="1ad6b3667ca3ee7e3b3685e63c8bd1c6"></a><!-- doxytag: member="OfxSecurityData::unique_id" ref="1ad6b3667ca3ee7e3b3685e63c8bd1c6" 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#1ad6b3667ca3ee7e3b3685e63c8bd1c6">OfxSecurityData::unique_id</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The id of the security being traded.
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00324">324</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="fddec0de534d0ab20cfd3ac562258615"></a><!-- doxytag: member="OfxSecurityData::unique_id_type" ref="fddec0de534d0ab20cfd3ac562258615" 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#fddec0de534d0ab20cfd3ac562258615">OfxSecurityData::unique_id_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Usially "CUSIP" for FIs in north america
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00326">326</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="24096ad3cb35be8e6adb626b23f45a83"></a><!-- doxytag: member="OfxSecurityData::secname" ref="24096ad3cb35be8e6adb626b23f45a83" args="[OFX_SECNAME_LENGTH]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="structOfxSecurityData.html#24096ad3cb35be8e6adb626b23f45a83">OfxSecurityData::secname</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The full name of the security
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00329">329</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7d1091abe3015294844107a6c3d27da2"></a><!-- doxytag: member="OfxSecurityData::ticker" ref="7d1091abe3015294844107a6c3d27da2" args="[OFX_TICKER_LENGTH]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="structOfxSecurityData.html#7d1091abe3015294844107a6c3d27da2">OfxSecurityData::ticker</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The ticker symbol of the security
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00337">337</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b7e970b0d2efb4afd77e5140f6377eea"></a><!-- doxytag: member="OfxSecurityData::unitprice" ref="b7e970b0d2efb4afd77e5140f6377eea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="structOfxSecurityData.html#b7e970b0d2efb4afd77e5140f6377eea">OfxSecurityData::unitprice</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The price of each unit of the security, as of date_unitprice
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00340">340</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="39f70a97d1390f293a9726a014ed5736"></a><!-- doxytag: member="OfxSecurityData::date_unitprice" ref="39f70a97d1390f293a9726a014ed5736" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t <a class="el" href="structOfxSecurityData.html#39f70a97d1390f293a9726a014ed5736">OfxSecurityData::date_unitprice</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The date as of which the unit price was valid.
<p>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00344">344</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="02b3d96724074884948651a394897c95"></a><!-- doxytag: member="OfxSecurityData::currency" ref="02b3d96724074884948651a394897c95" args="[OFX_CURRENCY_LENGTH]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="structOfxSecurityData.html#02b3d96724074884948651a394897c95">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>Definition at line <a class="el" href="inc_2libofx_8h-source.html#l00347">347</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>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<a class="anchor" name="097572b1667a4e859fd34578aee8cdd8"></a><!-- doxytag: member="OfxSecurityData::memo" ref="097572b1667a4e859fd34578aee8cdd8" args="[OFX_MEMO2_LENGTH]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="structOfxSecurityData.html#097572b1667a4e859fd34578aee8cdd8">OfxSecurityData::memo</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extra information not included in name
<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>
<p>Referenced by <a class="el" href="ofx__container__security_8cpp-source.html#l00045">OfxSecurityContainer::add_attribute()</a>, and <a class="el" href="ofxdump_8cpp-source.html#l00043">ofx_proc_security_cb()</a>.</p>
</div>
</div><p>
<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><a class="el" href="libofx-0_88_82_2inc_2libofx_8h-source.html">libofx-0.8.2/inc/libofx.h</a><li><a class="el" href="libofx-0_89_80_2inc_2libofx_8h-source.html">libofx-0.9.0/inc/libofx.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Nov 19 20:28:00 2007 for LibOFX by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
|
