Changeset 50 in flair-dev for trunk/doc/Flair/_shared_mem_8h_source.html


Ignore:
Timestamp:
05/31/17 15:54:26 (7 years ago)
Author:
Sanahuja Guillaume
Message:

doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/Flair/_shared_mem_8h_source.html

    r47 r50  
    126126<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_shared_mem.html">   32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_shared_mem.html">SharedMem</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div>
    127127<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">public</span>:</div>
    128 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#aebdd64cb4a190b25d710a3d069fee033">SharedMem</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, <span class="keywordtype">size_t</span> size);</div>
    129 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
    130 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">~SharedMem</a>();</div>
    131 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
    132 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a7609d68ab9155055bea84cafaf741392">Write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size);</div>
    133 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
    134 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a9b3efaf91b3a62a58d4466bcaa03b590">Read</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div>
    135 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
    136 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">private</span>:</div>
    137 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  SharedMem_impl *pimpl_;</div>
    138 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;};</div>
    139 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
    140 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;} <span class="comment">// end namespace core</span></div>
    141 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;} <span class="comment">// end namespace flair</span></div>
    142 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
    143 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif // SHAREDMEM_H</span></div>
     128<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  <span class="keyword">enum class</span> Type { mutex, producerConsumer };</div>
     129<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a003b9e48b88ac57bb7255b80f7768d9f">SharedMem</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, <span class="keywordtype">size_t</span> size, Type type=Type::mutex);</div>
     130<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
     131<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">~SharedMem</a>();</div>
     132<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
     133<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a7609d68ab9155055bea84cafaf741392">Write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size);</div>
     134<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div>
     135<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a9b3efaf91b3a62a58d4466bcaa03b590">Read</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size) <span class="keyword">const</span>;</div>
     136<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
     137<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
     138<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;   <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#aead806d7b3e48aecefcbb3dcd724ef49">ReaderReady</a>();</div>
     139<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="keyword">private</span>:</div>
     140<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  SharedMem_impl *pimpl_;</div>
     141<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  Type type;</div>
     142<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;};</div>
     143<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div>
     144<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;} <span class="comment">// end namespace core</span></div>
     145<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;} <span class="comment">// end namespace flair</span></div>
     146<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
     147<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="preprocessor">#endif // SHAREDMEM_H</span></div>
    144148<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&#39;s classes. </div><div class="ttdef"><b>Definition:</b> Object.h:77</div></div>
    145149<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>
     150<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_aead806d7b3e48aecefcbb3dcd724ef49"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#aead806d7b3e48aecefcbb3dcd724ef49">flair::core::SharedMem::ReaderReady</a></div><div class="ttdeci">void ReaderReady()</div><div class="ttdoc">This function should be called when reader starts (in case of a SharedMem of type producerConsumer) ...</div></div>
     151<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a003b9e48b88ac57bb7255b80f7768d9f"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a003b9e48b88ac57bb7255b80f7768d9f">flair::core::SharedMem::SharedMem</a></div><div class="ttdeci">SharedMem(const Object *parent, std::string name, size_t size, Type type=Type::mutex)</div><div class="ttdoc">Constructor. </div></div>
    146152<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a9b3efaf91b3a62a58d4466bcaa03b590"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a9b3efaf91b3a62a58d4466bcaa03b590">flair::core::SharedMem::Read</a></div><div class="ttdeci">void Read(char *buf, size_t size) const </div><div class="ttdoc">Read. </div></div>
    147153<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html">flair::core::SharedMem</a></div><div class="ttdoc">Class defining a shared memory. </div><div class="ttdef"><b>Definition:</b> SharedMem.h:32</div></div>
    … …  
    149155<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_af3f51c01e679a8dd1f6f7c64cee55ed7"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">flair::core::SharedMem::~SharedMem</a></div><div class="ttdeci">~SharedMem()</div><div class="ttdoc">Destructor. </div></div>
    150156<div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a7609d68ab9155055bea84cafaf741392"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a7609d68ab9155055bea84cafaf741392">flair::core::SharedMem::Write</a></div><div class="ttdeci">void Write(const char *buf, size_t size)</div><div class="ttdoc">Write. </div></div>
    151 <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_aebdd64cb4a190b25d710a3d069fee033"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#aebdd64cb4a190b25d710a3d069fee033">flair::core::SharedMem::SharedMem</a></div><div class="ttdeci">SharedMem(const Object *parent, std::string name, size_t size)</div><div class="ttdoc">Constructor. </div></div>
    152157</div><!-- fragment --></div><!-- contents -->
    153158</div><!-- doc-content -->
    … …  
    156161  <ul>
    157162    <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="_shared_mem_8h.html">SharedMem.h</a></li>
    158     <li class="footer">Generated on Tue Jan 17 2017 09:52:30 for Flair by
     163    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    159164    <a href="http://www.doxygen.org/index.html">
    160165    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.