aboutsummaryrefslogtreecommitdiffstats
path: root/doc/html/operation_8h_source.html
blob: d5aa3ec3667447d0397cace33e54e4aeafe271cb (plain) (blame)
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
<!-- HTML header for doxygen 1.8.3.1-->
<!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.6"/>
<title>Templates -- Meow: /home/cathook/Projects/template_meow/meowpp/utility/operation.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="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="stylesheet.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">Templates -- Meow
   &#160;<span id="projectnumber">2.0.-1</span>
   </div>
   <div id="projectbrief">A C++ template contains kinds of interesting classes and functions</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
</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('operation_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">operation.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="operation_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;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef __MEOWPP_UTILITY_OPERATION_H__</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MEOWPP_UTILITY_OPERATION_H__</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;../debug/assert.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="object_8h.html">object.h</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="pointer_8h.html">pointer.h</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="state_8h.html">state.h</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">namespace </span>meow {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classmeow_1_1Operation.html">   22</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmeow_1_1Operation.html">Operation</a> : <span class="keyword">public</span> <a class="code" href="classmeow_1_1Object.html">Object</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;  <span class="keywordtype">int</span> inputs_size_;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;  <span class="keywordtype">int</span> outputs_size_;</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; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classmeow_1_1Operation.html#a08590b8ca7c9c7b566cb757949573648">   35</a></span>&#160;  <a class="code" href="classmeow_1_1Operation.html#a08590b8ca7c9c7b566cb757949573648">Operation</a>(<span class="keywordtype">int</span> arg_inputs_size, <span class="keywordtype">int</span> arg_outputs_size) :</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;      inputs_size_(arg_inputs_size), outputs_size_(arg_outputs_size) {}</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classmeow_1_1Operation.html#a1d8b43477b96e6e645874cb90cfe3a80">   43</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classmeow_1_1Operation.html#a1d8b43477b96e6e645874cb90cfe3a80">~Operation</a>() {}</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classmeow_1_1State.html">State</a> <a class="code" href="classmeow_1_1Operation.html#a81bca71581576d842b4c46df0bfafbb8">Operate</a>(<a class="code" href="classmeow_1_1Pointer.html">Pointer&lt;Object const&gt;</a> <span class="keyword">const</span> * inputs_ptr,</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;                        <a class="code" href="classmeow_1_1Pointer.html">Pointer&lt;Object&gt;</a> <span class="keyword">const</span> * outputs_ptr) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmeow_1_1Operation.html#aebe8cd0c6e157119e2601bd2afef6e16">   60</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classmeow_1_1Operation.html#aebe8cd0c6e157119e2601bd2afef6e16">inputs_size</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordflow">return</span> inputs_size_;</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;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmeow_1_1Operation.html#a0c608010ecb2f37f3cce547a898be549">   68</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="classmeow_1_1Operation.html#a0c608010ecb2f37f3cce547a898be549">outputs_size</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordflow">return</span> outputs_size_;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  }</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="preprocessor">#ifdef MEOWPP_UTILITY_OPERATION_TESTING</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="preprocessor"></span>  <span class="keyword">friend</span> <span class="keyword">class </span>OperationTest;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif // MEOWPP_UTILITY_OPERATION_TESTING</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;};</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;}  <span class="comment">// meow</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="preprocessor">#endif  // __MEOWPP_UTILITY_OPERATION_H__</span></div>
<div class="ttc" id="classmeow_1_1Pointer_html"><div class="ttname"><a href="classmeow_1_1Pointer.html">meow::Pointer</a></div><div class="ttdoc">A pointer points to the template Type. </div><div class="ttdef"><b>Definition:</b> <a href="pointer_8h_source.html#l00033">pointer.h:33</a></div></div>
<div class="ttc" id="classmeow_1_1Operation_html_a08590b8ca7c9c7b566cb757949573648"><div class="ttname"><a href="classmeow_1_1Operation.html#a08590b8ca7c9c7b566cb757949573648">meow::Operation::Operation</a></div><div class="ttdeci">Operation(int arg_inputs_size, int arg_outputs_size)</div><div class="ttdoc">A protected constructor to prevent developers create an instance of Operation directly. </div><div class="ttdef"><b>Definition:</b> <a href="operation_8h_source.html#l00035">operation.h:35</a></div></div>
<div class="ttc" id="classmeow_1_1Operation_html_a1d8b43477b96e6e645874cb90cfe3a80"><div class="ttname"><a href="classmeow_1_1Operation.html#a1d8b43477b96e6e645874cb90cfe3a80">meow::Operation::~Operation</a></div><div class="ttdeci">virtual ~Operation()</div><div class="ttdoc">Virtual destructor. </div><div class="ttdef"><b>Definition:</b> <a href="operation_8h_source.html#l00043">operation.h:43</a></div></div>
<div class="ttc" id="classmeow_1_1Operation_html"><div class="ttname"><a href="classmeow_1_1Operation.html">meow::Operation</a></div><div class="ttdoc">Base class for operations. </div><div class="ttdef"><b>Definition:</b> <a href="operation_8h_source.html#l00022">operation.h:22</a></div></div>
<div class="ttc" id="classmeow_1_1Object_html"><div class="ttname"><a href="classmeow_1_1Object.html">meow::Object</a></div><div class="ttdoc">The base class. </div><div class="ttdef"><b>Definition:</b> <a href="object_8h_source.html#l00020">object.h:20</a></div></div>
<div class="ttc" id="object_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div><div class="ttdoc">Contains a base class for most of all the classes in meowpp. </div></div>
<div class="ttc" id="state_8h_html"><div class="ttname"><a href="state_8h.html">state.h</a></div><div class="ttdoc">Contains a base class for a state (in meowpp, most of all the return value of a function (or to say...</div></div>
<div class="ttc" id="classmeow_1_1Operation_html_a81bca71581576d842b4c46df0bfafbb8"><div class="ttname"><a href="classmeow_1_1Operation.html#a81bca71581576d842b4c46df0bfafbb8">meow::Operation::Operate</a></div><div class="ttdeci">virtual State Operate(Pointer&lt; Object const  &gt; const *inputs_ptr, Pointer&lt; Object &gt; const *outputs_ptr) const =0</div><div class="ttdoc">Pure virtual method for running the operation. </div></div>
<div class="ttc" id="pointer_8h_html"><div class="ttname"><a href="pointer_8h.html">pointer.h</a></div><div class="ttdoc">Contains a pointer class which has a counter-mechanism to prevent memory leak. </div></div>
<div class="ttc" id="classmeow_1_1State_html"><div class="ttname"><a href="classmeow_1_1State.html">meow::State</a></div><div class="ttdoc">The base class for state. </div><div class="ttdef"><b>Definition:</b> <a href="state_8h_source.html#l00051">state.h:51</a></div></div>
<div class="ttc" id="classmeow_1_1Operation_html_aebe8cd0c6e157119e2601bd2afef6e16"><div class="ttname"><a href="classmeow_1_1Operation.html#aebe8cd0c6e157119e2601bd2afef6e16">meow::Operation::inputs_size</a></div><div class="ttdeci">int inputs_size() const </div><div class="ttdoc">Gets the number of inputs for the operation. </div><div class="ttdef"><b>Definition:</b> <a href="operation_8h_source.html#l00060">operation.h:60</a></div></div>
<div class="ttc" id="classmeow_1_1Operation_html_a0c608010ecb2f37f3cce547a898be549"><div class="ttname"><a href="classmeow_1_1Operation.html#a0c608010ecb2f37f3cce547a898be549">meow::Operation::outputs_size</a></div><div class="ttdeci">int outputs_size() const </div><div class="ttdoc">Gets the number of outputs for the operation. </div><div class="ttdef"><b>Definition:</b> <a href="operation_8h_source.html#l00068">operation.h:68</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_92fecd8d02dd5e7a67429447fdf0f60f.html">meowpp</a></li><li class="navelem"><a class="el" href="dir_310883ca86d42971a9d74da2c3f04777.html">utility</a></li><li class="navelem"><a class="el" href="operation_8h.html">operation.h</a></li>
    <li class="footer">Generated on Mon Sep 29 2014 16:55:35 for Templates -- Meow by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>