-
Notifications
You must be signed in to change notification settings - Fork 4
/
classIBApi_1_1OrderState.html
203 lines (198 loc) · 13.6 KB
/
classIBApi_1_1OrderState.html
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
<!-- HTML header for doxygen 1.8.4-->
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>TWS API: OrderState Class Reference</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script>
$(document).ready(function(){
$("ul#tabs li").click(function(e){
if (!$(this).hasClass("active")) {
var tabNum = $(this).index();
var nthChild = tabNum+1;
$("ul#tabs li.active").removeClass("active");
$(this).addClass("active");
$("ul#tab li.active").removeClass("active");
$("ul#tab li:nth-child("+nthChild+")").addClass("active");
}
});
});
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="ib_theme.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="background-color:black;">
<table cellspacing="0" cellpadding="0" >
<tbody>
<tr>
<td id="projectlogo"><img alt="Logo" src="nav_iblogo.png"/></td>
<td style="padding: 0 0 0 1em;">
<ul id="tabs"><li class="active">C#</li><li>Java</li><li>VB</li><li>C++</li></ul>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classIBApi_1_1OrderState.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#properties">Properties</a> |
<a href="classIBApi_1_1OrderState-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OrderState Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides an active order's current state.
<a href="classIBApi_1_1OrderState.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8e26c1eb78cc9240af98c54da5f15f00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e26c1eb78cc9240af98c54da5f15f00"></a>
 </td><td class="memItemRight" valign="bottom"><b>OrderState</b> (string status, string initMargin, string maintMargin, string equityWithLoan, double commission, double minCommission, double maxCommission, string commissionCurrency, string warningText)</td></tr>
<tr class="separator:a8e26c1eb78cc9240af98c54da5f15f00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1360cb86f7544045a8be41200976d456"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1360cb86f7544045a8be41200976d456"></a>
override bool </td><td class="memItemRight" valign="bottom"><b>Equals</b> (Object other)</td></tr>
<tr class="separator:a1360cb86f7544045a8be41200976d456"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:afdaa27edb811d806bc72f1d53c7334cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdaa27edb811d806bc72f1d53c7334cc"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#afdaa27edb811d806bc72f1d53c7334cc">Status</a><code> [get, set]</code></td></tr>
<tr class="memdesc:afdaa27edb811d806bc72f1d53c7334cc"><td class="mdescLeft"> </td><td class="mdescRight">The order's current status. <br/></td></tr>
<tr class="separator:afdaa27edb811d806bc72f1d53c7334cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d8863de4476165c245cd719c9c7a361"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d8863de4476165c245cd719c9c7a361"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#a9d8863de4476165c245cd719c9c7a361">InitMargin</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a9d8863de4476165c245cd719c9c7a361"><td class="mdescLeft"> </td><td class="mdescRight">The order's impact on the account's initial margin. <br/></td></tr>
<tr class="separator:a9d8863de4476165c245cd719c9c7a361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96ad50fb5e01f71811b473fc1734c398"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96ad50fb5e01f71811b473fc1734c398"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#a96ad50fb5e01f71811b473fc1734c398">MaintMargin</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a96ad50fb5e01f71811b473fc1734c398"><td class="mdescLeft"> </td><td class="mdescRight">The order's impact on the account's maintenance margin. <br/></td></tr>
<tr class="separator:a96ad50fb5e01f71811b473fc1734c398"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad51928765a54cdf5847aa31ec8bbe173"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad51928765a54cdf5847aa31ec8bbe173"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#ad51928765a54cdf5847aa31ec8bbe173">EquityWithLoan</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad51928765a54cdf5847aa31ec8bbe173"><td class="mdescLeft"> </td><td class="mdescRight">Shows the impact the order would have on the account's equity with loan. <br/></td></tr>
<tr class="separator:ad51928765a54cdf5847aa31ec8bbe173"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a878c7e8cc4a576b42762f0144f80fb0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a878c7e8cc4a576b42762f0144f80fb0f"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#a878c7e8cc4a576b42762f0144f80fb0f">Commission</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a878c7e8cc4a576b42762f0144f80fb0f"><td class="mdescLeft"> </td><td class="mdescRight">The order's generated commission. <br/></td></tr>
<tr class="separator:a878c7e8cc4a576b42762f0144f80fb0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a341c0094fd5e12ca6acab97efdd4088a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a341c0094fd5e12ca6acab97efdd4088a"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#a341c0094fd5e12ca6acab97efdd4088a">MinCommission</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a341c0094fd5e12ca6acab97efdd4088a"><td class="mdescLeft"> </td><td class="mdescRight">The execution's minimum commission. <br/></td></tr>
<tr class="separator:a341c0094fd5e12ca6acab97efdd4088a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9a845c5d3a244f6a17569766088ce01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9a845c5d3a244f6a17569766088ce01"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#ad9a845c5d3a244f6a17569766088ce01">MaxCommission</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad9a845c5d3a244f6a17569766088ce01"><td class="mdescLeft"> </td><td class="mdescRight">The executions maximum commission. <br/></td></tr>
<tr class="separator:ad9a845c5d3a244f6a17569766088ce01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16aa2ffd16541ef778be7314865b361f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#a16aa2ffd16541ef778be7314865b361f">CommissionCurrency</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a16aa2ffd16541ef778be7314865b361f"><td class="mdescLeft"> </td><td class="mdescRight">The generated commission currency. <a href="#a16aa2ffd16541ef778be7314865b361f">More...</a><br/></td></tr>
<tr class="separator:a16aa2ffd16541ef778be7314865b361f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af07f6e04d586d39231ef3b920d35d6a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af07f6e04d586d39231ef3b920d35d6a4"></a>
string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIBApi_1_1OrderState.html#af07f6e04d586d39231ef3b920d35d6a4">WarningText</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af07f6e04d586d39231ef3b920d35d6a4"><td class="mdescLeft"> </td><td class="mdescRight">If the order is warranted, a descriptive message will be provided. <br/></td></tr>
<tr class="separator:af07f6e04d586d39231ef3b920d35d6a4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides an active order's current state. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classIBApi_1_1Order.html" title="The order's description. ">Order</a> </dd></dl>
</div><h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a16aa2ffd16541ef778be7314865b361f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string CommissionCurrency</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The generated commission currency. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classIBApi_1_1CommissionReport.html" title="class representing the commissions generated by an execution. ">CommissionReport</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Dev/IBAPI_Github/documentation/tws-api/source/csharpclient/client/OrderState.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.4-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceIBApi.html">IBApi</a></li><li class="navelem"><a class="el" href="classIBApi_1_1OrderState.html">OrderState</a></li>
<li class="footer">Copyright IB 2015 </li>
</ul>
</div>
</body>
</html>