aboutsummaryrefslogtreecommitdiffstats
path: root/doc/html/classmeow_1_1Object.html
blob: a1a194bfed040bf332c20516bb6f13e843b1f7d5 (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
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<!-- 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: meow::Object Class Reference</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('classmeow_1_1Object.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classmeow_1_1Object-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">meow::Object Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The base class.  
 <a href="classmeow_1_1Object.html#details">More...</a></p>

<p><code>#include &quot;<a class="el" href="object_8h_source.html">object.h</a>&quot;</code></p>
<div class="dynheader">
Inheritance diagram for meow::Object:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmeow_1_1Object.png" usemap="#meow::Object_map" alt=""/>
  <map id="meow::Object_map" name="meow::Object_map">
<area href="classmeow_1_1BaseFloatingType.html" title="A class for floating-point base object. " alt="meow::BaseFloatingType&lt; DataType &gt;" shape="rect" coords="341,56,672,80"/>
<area href="classmeow_1_1BaseNumberType.html" title="A class for number base object. " alt="meow::BaseNumberType&lt; DataType &gt;" shape="rect" coords="341,112,672,136"/>
<area href="classmeow_1_1Factory.html" title="A class which contains input elements, output elements and an operation. " alt="meow::Factory" shape="rect" coords="341,168,672,192"/>
<area href="classmeow_1_1Operation.html" title="Base class for operations. " alt="meow::Operation" shape="rect" coords="341,224,672,248"/>
<area href="classmeow_1_1Pointer.html" title="A pointer points to the template Type. " alt="meow::Pointer&lt; Type &gt;" shape="rect" coords="341,280,672,304"/>
<area href="classmeow_1_1State.html" title="The base class for state. " alt="meow::State" shape="rect" coords="341,336,672,360"/>
<area href="classmeow_1_1Pointer.html" alt="meow::Pointer&lt; factory_types::Base &gt;" shape="rect" coords="341,392,672,416"/>
<area href="classmeow_1_1Pointer.html" alt="meow::Pointer&lt; meow::Operation const  &gt;" shape="rect" coords="341,448,672,472"/>
<area href="classmeow_1_1Pointer.html" alt="meow::Pointer&lt; meow::Pointer&lt; meow::Object &gt; &gt;" shape="rect" coords="341,504,672,528"/>
<area href="classmeow_1_1Pointer.html" alt="meow::Pointer&lt; meow::Pointer&lt; meow::Object const  &gt; &gt;" shape="rect" coords="341,560,672,584"/>
</map>
 </div></div>
<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:a5e41ab604d3e387c4293863eace18a75"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a5e41ab604d3e387c4293863eace18a75">~Object</a> ()</td></tr>
<tr class="memdesc:a5e41ab604d3e387c4293863eace18a75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#a5e41ab604d3e387c4293863eace18a75">More...</a><br/></td></tr>
<tr class="separator:a5e41ab604d3e387c4293863eace18a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875c9a989fc858fd49dd00a0d059142c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a875c9a989fc858fd49dd00a0d059142c">Copy</a> () const </td></tr>
<tr class="memdesc:a875c9a989fc858fd49dd00a0d059142c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a copy of itself and return the pointer to it.  <a href="#a875c9a989fc858fd49dd00a0d059142c">More...</a><br/></td></tr>
<tr class="separator:a875c9a989fc858fd49dd00a0d059142c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b30b1200154d5f71f99694d835b9a49"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9b30b1200154d5f71f99694d835b9a49">CopyFrom</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr)</td></tr>
<tr class="memdesc:a9b30b1200154d5f71f99694d835b9a49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies data from another object.  <a href="#a9b30b1200154d5f71f99694d835b9a49">More...</a><br/></td></tr>
<tr class="separator:a9b30b1200154d5f71f99694d835b9a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59485e5cace45c0711fe86b6b693c10f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a59485e5cace45c0711fe86b6b693c10f">Equals</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr) const </td></tr>
<tr class="memdesc:a59485e5cace45c0711fe86b6b693c10f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether it equals to another object or not.  <a href="#a59485e5cace45c0711fe86b6b693c10f">More...</a><br/></td></tr>
<tr class="separator:a59485e5cace45c0711fe86b6b693c10f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmeow_1_1Object.html">Object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9d22bc97e9a5f11acaade41a1f07bc3b">operator=</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &amp;b)</td></tr>
<tr class="memdesc:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the copy operator.  <a href="#a9d22bc97e9a5f11acaade41a1f07bc3b">More...</a><br/></td></tr>
<tr class="separator:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a8f2e9eec4d103846693a9d0c2b215d23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a8f2e9eec4d103846693a9d0c2b215d23">Object</a> ()</td></tr>
<tr class="memdesc:a8f2e9eec4d103846693a9d0c2b215d23"><td class="mdescLeft">&#160;</td><td class="mdescRight">A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Object.html" title="The base class. ">Object</a> directly.  <a href="#a8f2e9eec4d103846693a9d0c2b215d23">More...</a><br/></td></tr>
<tr class="separator:a8f2e9eec4d103846693a9d0c2b215d23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02b219848bde794cd138aa644c9e6147"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a02b219848bde794cd138aa644c9e6147">Object</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &amp;b)</td></tr>
<tr class="memdesc:a02b219848bde794cd138aa644c9e6147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the copy operation.  <a href="#a02b219848bde794cd138aa644c9e6147">More...</a><br/></td></tr>
<tr class="separator:a02b219848bde794cd138aa644c9e6147"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class. </p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00020">20</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8f2e9eec4d103846693a9d0c2b215d23"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">meow::Object::Object </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Object.html" title="The base class. ">Object</a> directly. </p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00027">27</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>

</div>
</div>
<a class="anchor" id="a02b219848bde794cd138aa644c9e6147"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">meow::Object::Object </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const &amp;&#160;</td>
          <td class="paramname"><em>b</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Disable the copy operation. </p>

</div>
</div>
<a class="anchor" id="a5e41ab604d3e387c4293863eace18a75"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual meow::Object::~Object </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual destructor. </p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00039">39</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a875c9a989fc858fd49dd00a0d059142c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1Object.html">Object</a>* meow::Object::Copy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a copy of itself and return the pointer to it. </p>

<p>Reimplemented in <a class="el" href="classmeow_1_1Factory.html#aea5b7738bd866c48329dda7b37bec8ca">meow::Factory</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer&lt; Type &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer&lt; meow::Pointer&lt; meow::Object &gt; &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer&lt; factory_types::Base &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer&lt; meow::Operation const  &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer&lt; meow::Pointer&lt; meow::Object const  &gt; &gt;</a>, <a class="el" href="classmeow_1_1BaseFloatingType.html#ae744b5726bd87c70ef981af93c927d0d">meow::BaseFloatingType&lt; DataType &gt;</a>, <a class="el" href="classmeow_1_1State.html#ac31d0101da886027a43968ecca272747">meow::State</a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#a836908847bd64427c8b60b1c266ea749">meow::BaseNumberType&lt; DataType &gt;</a>.</p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00044">44</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9b30b1200154d5f71f99694d835b9a49"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1Object.html">Object</a>* meow::Object::CopyFrom </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const *&#160;</td>
          <td class="paramname"><em>ptr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Copies data from another object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Points to another object. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="classmeow_1_1Factory.html#a7ad8614449b10fa2ae52289352210a06">meow::Factory</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer&lt; Type &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer&lt; meow::Pointer&lt; meow::Object &gt; &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer&lt; factory_types::Base &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer&lt; meow::Operation const  &gt;</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer&lt; meow::Pointer&lt; meow::Object const  &gt; &gt;</a>, <a class="el" href="classmeow_1_1BaseFloatingType.html#a2ce80015f5644d924c0f4eb291fd04ca">meow::BaseFloatingType&lt; DataType &gt;</a>, <a class="el" href="classmeow_1_1State.html#a76f3ca5e2f687b17af9b9adcb0311747">meow::State</a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#ae67c3b0fa23e76a85d7800095d98469b">meow::BaseNumberType&lt; DataType &gt;</a>.</p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00052">52</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>

</div>
</div>
<a class="anchor" id="a59485e5cace45c0711fe86b6b693c10f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool meow::Object::Equals </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const *&#160;</td>
          <td class="paramname"><em>ptr</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns whether it equals to another object or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Points to another object. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="classmeow_1_1BaseFloatingType.html#ada33b40693aea5403954a45549e6717c">meow::BaseFloatingType&lt; DataType &gt;</a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#a2938f9af8ab0681498c168de94f26951">meow::BaseNumberType&lt; DataType &gt;</a>.</p>

<p>Definition at line <a class="el" href="object_8h_source.html#l00060">60</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9d22bc97e9a5f11acaade41a1f07bc3b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmeow_1_1Object.html">Object</a>&amp; meow::Object::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const &amp;&#160;</td>
          <td class="paramname"><em>b</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable the copy operator. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/cathook/Projects/template_meow/meowpp/utility/<a class="el" href="object_8h_source.html">object.h</a></li>
</ul>
</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="namespacemeow.html">meow</a></li><li class="navelem"><a class="el" href="classmeow_1_1Object.html">Object</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>