Files
externals/linux/doc/Onixs.CME.4.8.0/html/BookAttributes_8h_source.html

99 lines
20 KiB
HTML

<!-- HTML header for doxygen 1.8.11-->
<!DOCTYPE html>
<html>
<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.11"/>
<title>OnixS C++ CME Market Data Handler: /work/include/OnixS/CME/MDH/BookAttributes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="onixs-doxygen.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
$(window).scroll(function() {
if ($(this).scrollTop() > 1)
{
$('header').addClass("sticky");
}
else
{
$('header').removeClass("sticky");
}
});
</script>
</head>
<body>
<header>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a href="http://www.onixs.biz"><img alt="Logo" src="onixs.svg"/></a></td>
<td style="padding-left: 0.5em;">
<div id="projectname">OnixS C++ CME Market Data Handler
&#160;<span id="projectnumber">4.8.0.10</span>
</div>
<div id="projectbrief">API documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
</header>
<div id="wrapper">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Home</span></a></li>
<li><a href="modules.html"><span>Contents</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0ca895cb0e1f67e888f23a37e8368674.html">OnixS</a></li><li class="navelem"><a class="el" href="dir_407536e69141e5a45cff8ef1855c3ddf.html">CME</a></li><li class="navelem"><a class="el" href="dir_b9844c953d2031889076814b1973f749.html">MDH</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">BookAttributes.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="BookAttributes_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright Onix Solutions Limited [OnixS]. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// This software owned by Onix Solutions Limited [OnixS] and is </span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// protected by copyright law and international copyright treaties.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Access to and use of the software is governed by the terms of the applicable </span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// OnixS Software Services Agreement (the Agreement) and Customer end user license </span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// agreements granting a non-assignable, non-transferable and non-exclusive license </span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// to use the software for it&#39;s own data processing purposes under the terms defined </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// in the Agreement.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// Except as otherwise granted within the terms of the Agreement, copying or </span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// reproduction of any part of this source code or associated reference material </span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// to any other location for further reproduction or redistribution, and any </span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// amendments to this copyright notice, are expressly prohibited.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// Any reproduction or redistribution for sale or hiring of the Software not in </span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// accordance with the terms of the Agreement is a violation of copyright law.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="Integral_8h.html">OnixS/CME/MDH/Integral.h</a>&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<a class="code" href="Bootstrap_8h.html#a23f0981ad850fd6342e21582cdc58215">ONIXS_CMEMDH_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">/// State of order book.</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html"> 30</a></span>&#160;<span class="comment"></span><a class="code" href="Bootstrap_8h.html#afce2d395ffa7defa16fe4139e379375d">ONIXS_CMEMDH_LTWT_STRUCT</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html">BookState</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{<span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> /// Integral type used as </span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> /// basement for constants. </span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#ac8ef8abca27b50fea2d0ad93aeeca4f8"> 35</a></span>&#160;<span class="comment"></span> <span class="keyword">typedef</span> <a class="code" href="namespaceOnixS_1_1CME_1_1MDH.html#aa4534e887beff98c601e5b7ea89c15dd">UInt32</a> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#ac8ef8abca27b50fea2d0ad93aeeca4f8">Base</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091"> 37</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091">Enum</a> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {<span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> /// Book is just constructed.</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091abe7fb73d3767d008b154d912a9e2aeb7"> 40</a></span>&#160;<span class="comment"></span> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091abe7fb73d3767d008b154d912a9e2aeb7">Constructed</a>,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> /// Book is naturally refreshed.</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091add6b3c4acb4c349c03e6b3009d351534"> 43</a></span>&#160;<span class="comment"></span> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091add6b3c4acb4c349c03e6b3009d351534">NaturallyRefreshed</a>,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> /// Book is up-to-date.</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091a532eb6bab15ea0a0b56ea6801d2636d7"> 46</a></span>&#160;<span class="comment"></span> Latest</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; };</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">/// Serializes book state value into a string. </span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span>ONIXS_CMEMDH_EXPORTED</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<a class="code" href="namespaceOnixS_1_1CME_1_1MDH.html#ab3173d7baf2b83a4b5a47ad7f1dce5bd">toStr</a>(</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::string&amp;,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091">BookState::Enum</a>);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment">/// Serializes book state value into a string. </span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"></span><span class="keyword">inline</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;std::string</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="namespaceOnixS_1_1CME_1_1MDH.html#ab3173d7baf2b83a4b5a47ad7f1dce5bd"> 60</a></span>&#160;<a class="code" href="namespaceOnixS_1_1CME_1_1MDH.html#ab3173d7baf2b83a4b5a47ad7f1dce5bd">toStr</a>(</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091">BookState::Enum</a> bookState)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;{</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; std::string str;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="namespaceOnixS_1_1CME_1_1MDH.html#ab3173d7baf2b83a4b5a47ad7f1dce5bd">toStr</a>(str, bookState);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> str;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">/// Tag class for accessing bids in templates. </span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1Bids.html"> 71</a></span>&#160;<span class="comment"></span><a class="code" href="Bootstrap_8h.html#afce2d395ffa7defa16fe4139e379375d">ONIXS_CMEMDH_LTWT_STRUCT</a> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1Bids.html">Bids</a> {};</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment">/// Tag class for accessing offers in templates. </span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structOnixS_1_1CME_1_1MDH_1_1Offers.html"> 74</a></span>&#160;<span class="comment"></span><a class="code" href="Bootstrap_8h.html#afce2d395ffa7defa16fe4139e379375d">ONIXS_CMEMDH_LTWT_STRUCT</a> <a class="code" href="structOnixS_1_1CME_1_1MDH_1_1Offers.html">Offers</a> {};</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<a class="code" href="Bootstrap_8h.html#aa37ba444a7a766fe8e59fcf4b848899b">ONIXS_CMEMDH_NAMESPACE_END</a></div><div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1Bids_html"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1Bids.html">OnixS::CME::MDH::Bids</a></div><div class="ttdoc">Tag class for accessing bids in templates. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00071">BookAttributes.h:71</a></div></div>
<div class="ttc" id="namespaceOnixS_1_1CME_1_1MDH_html_aa4534e887beff98c601e5b7ea89c15dd"><div class="ttname"><a href="namespaceOnixS_1_1CME_1_1MDH.html#aa4534e887beff98c601e5b7ea89c15dd">OnixS::CME::MDH::UInt32</a></div><div class="ttdeci">UInt32 UInt32</div><div class="ttdoc">uInt32. </div><div class="ttdef"><b>Definition:</b> <a href="Fields_8h_source.html#l00189">Fields.h:189</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1BookState_html_a8150b7776c2a1749101acf22e868d091"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091">OnixS::CME::MDH::BookState::Enum</a></div><div class="ttdeci">Enum</div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00037">BookAttributes.h:37</a></div></div>
<div class="ttc" id="Bootstrap_8h_html_afce2d395ffa7defa16fe4139e379375d"><div class="ttname"><a href="Bootstrap_8h.html#afce2d395ffa7defa16fe4139e379375d">ONIXS_CMEMDH_LTWT_STRUCT</a></div><div class="ttdeci">#define ONIXS_CMEMDH_LTWT_STRUCT</div><div class="ttdef"><b>Definition:</b> <a href="Bootstrap_8h_source.html#l00114">Bootstrap.h:114</a></div></div>
<div class="ttc" id="Integral_8h_html"><div class="ttname"><a href="Integral_8h.html">Integral.h</a></div></div>
<div class="ttc" id="Bootstrap_8h_html_a23f0981ad850fd6342e21582cdc58215"><div class="ttname"><a href="Bootstrap_8h.html#a23f0981ad850fd6342e21582cdc58215">ONIXS_CMEMDH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define ONIXS_CMEMDH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition:</b> <a href="Bootstrap_8h_source.html#l00168">Bootstrap.h:168</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1BookState_html_a8150b7776c2a1749101acf22e868d091add6b3c4acb4c349c03e6b3009d351534"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091add6b3c4acb4c349c03e6b3009d351534">OnixS::CME::MDH::BookState::NaturallyRefreshed</a></div><div class="ttdoc">Book is naturally refreshed. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00043">BookAttributes.h:43</a></div></div>
<div class="ttc" id="namespaceOnixS_1_1CME_1_1MDH_html_ab3173d7baf2b83a4b5a47ad7f1dce5bd"><div class="ttname"><a href="namespaceOnixS_1_1CME_1_1MDH.html#ab3173d7baf2b83a4b5a47ad7f1dce5bd">OnixS::CME::MDH::toStr</a></div><div class="ttdeci">std::string toStr(BookState::Enum bookState)</div><div class="ttdoc">Serializes book state value into a string. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00060">BookAttributes.h:60</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1BookState_html"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1BookState.html">OnixS::CME::MDH::BookState</a></div><div class="ttdoc">State of order book. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00030">BookAttributes.h:30</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1BookState_html_a8150b7776c2a1749101acf22e868d091abe7fb73d3767d008b154d912a9e2aeb7"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#a8150b7776c2a1749101acf22e868d091abe7fb73d3767d008b154d912a9e2aeb7">OnixS::CME::MDH::BookState::Constructed</a></div><div class="ttdoc">Book is just constructed. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00040">BookAttributes.h:40</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1Offers_html"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1Offers.html">OnixS::CME::MDH::Offers</a></div><div class="ttdoc">Tag class for accessing offers in templates. </div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00074">BookAttributes.h:74</a></div></div>
<div class="ttc" id="structOnixS_1_1CME_1_1MDH_1_1BookState_html_ac8ef8abca27b50fea2d0ad93aeeca4f8"><div class="ttname"><a href="structOnixS_1_1CME_1_1MDH_1_1BookState.html#ac8ef8abca27b50fea2d0ad93aeeca4f8">OnixS::CME::MDH::BookState::Base</a></div><div class="ttdeci">UInt32 Base</div><div class="ttdef"><b>Definition:</b> <a href="BookAttributes_8h_source.html#l00035">BookAttributes.h:35</a></div></div>
<div class="ttc" id="Bootstrap_8h_html_aa37ba444a7a766fe8e59fcf4b848899b"><div class="ttname"><a href="Bootstrap_8h.html#aa37ba444a7a766fe8e59fcf4b848899b">ONIXS_CMEMDH_NAMESPACE_END</a></div><div class="ttdeci">#define ONIXS_CMEMDH_NAMESPACE_END</div><div class="ttdef"><b>Definition:</b> <a href="Bootstrap_8h_source.html#l00172">Bootstrap.h:172</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.11-->
<!-- start footer part -->
<footer>
<hr class="footer"/>
<address class="footer">
<small>&copy; <a href="http://www.onixs.biz">Onix Solutions [On<span class="corporate-orange">i</span>x<span class="corporate-orange">S</span>]</a>. All rights reserved.</small>
</address>
</footer>
</div> <!-- wrapper -->
</body>
</html>