Changeset 36 in flair-dev for trunk/doc/Flair/_i_o_device_8h_source.html
- Timestamp:
- Nov 3, 2016, 11:14:54 AM (8 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/Flair/_i_o_device_8h_source.html
r35 r36 113 113 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// CECILL-C License, Version 1.0.</span></div> 114 114 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// %flair:license}</span></div> 115 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span><span class="preprocessor">#ifndef IO_DEVICE_H</span></div> 116 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define IO_DEVICE_H</span></div> 117 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> 118 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="_object_8h.html">Object.h</a>></span></div> 119 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> 120 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">class </span>IODevice_impl;</div> 121 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>Thread_impl;</div> 122 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>FrameworkManager_impl;</div> 123 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> 124 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div> 125 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>core {</div> 126 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> 127 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>io_data;</div> 128 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>DataType;</div> 129 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> 130 <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i_o_device.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div> 131 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">friend</span> class ::IODevice_impl;</div> 132 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">friend</span> class ::Thread_impl;</div> 133 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">friend</span> class ::FrameworkManager_impl;</div> 134 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> 135 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div> 136 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name);</div> 137 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> 138 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">~IODevice</a>();</div> 139 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> 140 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">AddDeviceToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device);</div> 141 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> 142 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">AddDataToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data);</div> 143 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> 144 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">OutputToShMem</a>(<span class="keywordtype">bool</span> enabled);</div> 145 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> 146 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// TODO: these 2 method should be pure virtual</span></div> 147 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &GetInputDataType() <span class="keyword">const</span>;</div> 148 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &GetOutputDataType() <span class="keyword">const</span>;</div> 149 <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> 150 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> lastUpdate;</div> 151 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">protected</span>:</div> 152 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">ProcessUpdate</a>(<a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a>* data);</div> 153 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div> 154 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keyword">private</span>:</div> 155 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> UpdateFrom(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data) = 0;</div> 156 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> 157 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">class </span>IODevice_impl *pimpl_;</div> 158 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> };</div> 159 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div> 160 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> } <span class="comment">// end namespace core</span></div> 161 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> } <span class="comment">// end namespace flair</span></div> 162 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div> 163 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif // IO_DEVICE_H</span></div> 115 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// ---</span></div> 116 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span><span class="preprocessor">#ifndef IO_DEVICE_H</span></div> 117 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define IO_DEVICE_H</span></div> 118 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> 119 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="_object_8h.html">Object.h</a>></span></div> 120 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> 121 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>IODevice_impl;</div> 122 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>Thread_impl;</div> 123 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>FrameworkManager_impl;</div> 124 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> 125 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div> 126 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>core {</div> 127 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> 128 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>io_data;</div> 129 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>DataType;</div> 130 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> 131 <div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i_o_device.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div> 132 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">friend</span> class ::IODevice_impl;</div> 133 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">friend</span> class ::Thread_impl;</div> 134 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">friend</span> class ::FrameworkManager_impl;</div> 135 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> 136 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div> 137 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name);</div> 138 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> 139 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">~IODevice</a>();</div> 140 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> 141 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">AddDeviceToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device);</div> 142 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> 143 <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">AddDataToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data);</div> 144 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> 145 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">OutputToShMem</a>(<span class="keywordtype">bool</span> enabled);</div> 146 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> 147 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// TODO: these 2 method should be pure virtual</span></div> 148 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &GetInputDataType() <span class="keyword">const</span>;</div> 149 <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &GetOutputDataType() <span class="keyword">const</span>;</div> 150 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> 151 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> lastUpdate;</div> 152 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">protected</span>:</div> 153 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">ProcessUpdate</a>(<a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a>* data);</div> 154 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div> 155 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">private</span>:</div> 156 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> UpdateFrom(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data) = 0;</div> 157 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div> 158 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keyword">class </span>IODevice_impl *pimpl_;</div> 159 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> };</div> 160 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> 161 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> } <span class="comment">// end namespace core</span></div> 162 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> } <span class="comment">// end namespace flair</span></div> 163 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div> 164 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="preprocessor">#endif // IO_DEVICE_H</span></div> 164 165 <div class="ttc" id="classflair_1_1core_1_1io__data_html"><div class="ttname"><a href="classflair_1_1core_1_1io__data.html">flair::core::io_data</a></div><div class="ttdoc">Abstract class for data types. </div><div class="ttdef"><b>Definition:</b> io_data.h:94</div></div> 165 166 <div class="ttc" id="classflair_1_1core_1_1_data_type_html"><div class="ttname"><a href="classflair_1_1core_1_1_data_type.html">flair::core::DataType</a></div><div class="ttdef"><b>Definition:</b> io_data.h:26</div></div> 166 167 <div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework's classes. </div><div class="ttdef"><b>Definition:</b> Object.h:77</div></div> 167 <div class="ttc" id="classflair_1_1core_1_1_i_o_device_html"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></div><div class="ttdoc">Abstract class for input/ouput system. </div><div class="ttdef"><b>Definition:</b> IODevice.h:4 4</div></div>168 <div class="ttc" id="classflair_1_1core_1_1_i_o_device_html"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></div><div class="ttdoc">Abstract class for input/ouput system. </div><div class="ttdef"><b>Definition:</b> IODevice.h:45</div></div> 168 169 <div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div> 169 170 <div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:49</div></div> … … 181 182 <ul> 182 183 <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_i_o_device_8h.html">IODevice.h</a></li> 183 <li class="footer">Generated on Wed Sep 28 2016 07:01:52 for Flair by184 <li class="footer">Generated on Thu Nov 3 2016 10:06:12 for Flair by 184 185 <a href="http://www.doxygen.org/index.html"> 185 186 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note:
See TracChangeset
for help on using the changeset viewer.