source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_object.html @ 35

Last change on this file since 35 was 35, checked in by Sanahuja Guillaume, 4 years ago

m

File size: 27.4 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: flair::core::Object Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16  $(document).ready(initResizable);
17  $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23  $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34  <td style="padding-left: 0.5em;">
35   <div id="projectname">Flair
36   </div>
37   <div id="projectbrief">Framework Libre Air</div>
38  </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48  <div id="navrow1" class="tabs">
49    <ul class="tablist">
50      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53      <li><a href="files.html"><span>Files</span></a></li>
54      <li>
55        <div id="MSearchBox" class="MSearchBoxInactive">
56        <span class="left">
57          <img id="MSearchSelect" src="search/mag_sel.png"
58               onmouseover="return searchBox.OnSearchSelectShow()"
59               onmouseout="return searchBox.OnSearchSelectHide()"
60               alt=""/>
61          <input type="text" id="MSearchField" value="Search" accesskey="S"
62               onfocus="searchBox.OnSearchFieldFocus(true)" 
63               onblur="searchBox.OnSearchFieldFocus(false)" 
64               onkeyup="searchBox.OnSearchFieldChange(event)"/>
65          </span><span class="right">
66            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67          </span>
68        </div>
69      </li>
70    </ul>
71  </div>
72  <div id="navrow2" class="tabs2">
73    <ul class="tablist">
74      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78    </ul>
79  </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82  <div id="nav-tree">
83    <div id="nav-tree-contents">
84      <div id="nav-sync" class="sync"></div>
85    </div>
86  </div>
87  <div id="splitbar" style="-moz-user-select:none;" 
88       class="ui-resizable-handle">
89  </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1core_1_1_object.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97     onmouseover="return searchBox.OnSearchSelectShow()"
98     onmouseout="return searchBox.OnSearchSelectHide()"
99     onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0" 
105        name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110  <div class="summary">
111<a href="#pub-types">Public Types</a> &#124;
112<a href="#pub-methods">Public Member Functions</a> &#124;
113<a href="classflair_1_1core_1_1_object-members.html">List of all members</a>  </div>
114  <div class="headertitle">
115<div class="title">flair::core::Object Class Reference</div>  </div>
116</div><!--header-->
117<div class="contents">
118
119<p>Base class for all Framework's classes. 
120 <a href="classflair_1_1core_1_1_object.html#details">More...</a></p>
121
122<p><code>#include &lt;<a class="el" href="_object_8h_source.html">Object.h</a>&gt;</code></p>
123<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
124  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::Object:</div>
125<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
126</div>
127<div id="dynsection-0-content" class="dyncontent" style="display:none;">
128 <div class="center">
129  <img src="classflair_1_1core_1_1_object.png" usemap="#flair::core::Object_map" alt=""/>
130  <map id="flair::core::Object_map" name="flair::core::Object_map">
131<area href="classflair_1_1core_1_1_connected_socket.html" title="Interface class encapsulating a connected socket. Preserves packets order and guaranty delivery..." alt="flair::core::ConnectedSocket" shape="rect" coords="197,56,384,80"/>
132<area href="classflair_1_1core_1_1_framework_manager.html" title="Main class of the Framework library. " alt="flair::core::FrameworkManager" shape="rect" coords="197,112,384,136"/>
133<area href="classflair_1_1core_1_1_i_o_data_element.html" title="Abstract class for accessing an element of an io_data. " alt="flair::core::IODataElement" shape="rect" coords="197,168,384,192"/>
134<area href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. " alt="flair::core::IODevice" shape="rect" coords="197,224,384,248"/>
135<area href="classflair_1_1core_1_1_mutex.html" title="Class defining a mutex. " alt="flair::core::Mutex" shape="rect" coords="197,280,384,304"/>
136<area href="classflair_1_1core_1_1_serial_port.html" title="Base class for serial port. " alt="flair::core::SerialPort" shape="rect" coords="197,336,384,360"/>
137<area href="classflair_1_1core_1_1_shared_mem.html" title="Class defining a shared memory. " alt="flair::core::SharedMem" shape="rect" coords="197,392,384,416"/>
138<area href="classflair_1_1core_1_1_socket.html" title="Class encapsulating a UDP socket. It assumes packets are coming from only one distant host on a given..." alt="flair::core::Socket" shape="rect" coords="197,448,384,472"/>
139<area href="classflair_1_1core_1_1_thread.html" title="Abstract class for a thread. " alt="flair::core::Thread" shape="rect" coords="197,504,384,528"/>
140<area href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. " alt="flair::gui::Widget" shape="rect" coords="197,560,384,584"/>
141<area href="classflair_1_1meta_1_1_meta_us_range_finder.html" title="Classe haut niveau pour capteur à ultra son. " alt="flair::meta::MetaUsRangeFinder" shape="rect" coords="197,616,384,640"/>
142<area href="classflair_1_1meta_1_1_uav.html" title="Base class to construct sensors/actuators depending on uav type. " alt="flair::meta::Uav" shape="rect" coords="197,672,384,696"/>
143<area href="classflair_1_1simulator_1_1_gui.html" alt="flair::simulator::Gui" shape="rect" coords="197,728,384,752"/>
144</map>
145 </div></div>
146<table class="memberdecls">
147<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
148Public Types</h2></td></tr>
149<tr class="memitem:aed5fccda511f97487040fed29f4efc97"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
150<b>Red</b> = 31,
151<b>Green</b> = 32,
152<b>Orange</b> = 33
153 }</td></tr>
154<tr class="separator:aed5fccda511f97487040fed29f4efc97"><td class="memSeparator" colspan="2">&#160;</td></tr>
155</table><table class="memberdecls">
156<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
157Public Member Functions</h2></td></tr>
158<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
159<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
160<tr class="separator:aec92383fd5bf68d9df10414862b7e95c"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
162<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
163<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
165<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
166<tr class="separator:a9b0344dff7e1c05424d9152c8274523a"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
168<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
169<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
171<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
172<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
174<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
175<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a344f81cd35805a9501098bf727ac1a10"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
177<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
178<tr class="separator:a344f81cd35805a9501098bf727ac1a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:af001feba14fc053aa778e61080a0b4cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
180<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
181<tr class="separator:af001feba14fc053aa778e61080a0b4cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
183<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
184<tr class="separator:a168b18451b2ee6126e1e81d452005ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
186<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
187<tr class="separator:a3ca9694d29ec2b0491739879685df5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
189<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
190<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85"><td class="memSeparator" colspan="2">&#160;</td></tr>
191</table>
192<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
193<div class="textblock"><p>Base class for all Framework's classes. </p>
194<p>This is the base class for all other classes. <br />
195It handles parent/child links and thus allow auto destruction of childs. </p>
196</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
197<a class="anchor" id="aec92383fd5bf68d9df10414862b7e95c"></a>
198<div class="memitem">
199<div class="memproto">
200      <table class="memname">
201        <tr>
202          <td class="memname">flair::core::Object::Object </td>
203          <td>(</td>
204          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
205          <td class="paramname"><em>parent</em> = <code>NULL</code>, </td>
206        </tr>
207        <tr>
208          <td class="paramkey"></td>
209          <td></td>
210          <td class="paramtype">std::string&#160;</td>
211          <td class="paramname"><em>name</em> = <code>&quot;&quot;</code>, </td>
212        </tr>
213        <tr>
214          <td class="paramkey"></td>
215          <td></td>
216          <td class="paramtype">std::string&#160;</td>
217          <td class="paramname"><em>type</em> = <code>&quot;&quot;</code>&#160;</td>
218        </tr>
219        <tr>
220          <td></td>
221          <td>)</td>
222          <td></td><td></td>
223        </tr>
224      </table>
225</div><div class="memdoc">
226
227<p>Constructor. </p>
228<p>Construct an <a class="el" href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. ">Object</a>, which is child of its parent.</p>
229<dl class="params"><dt>Parameters</dt><dd>
230  <table class="params">
231    <tr><td class="paramname">parent</td><td>parent </td></tr>
232    <tr><td class="paramname">name</td><td>name </td></tr>
233    <tr><td class="paramname">type</td><td>type </td></tr>
234  </table>
235  </dd>
236</dl>
237
238</div>
239</div>
240<a class="anchor" id="aa2bde0e6677bbef705c96c93cb06ad09"></a>
241<div class="memitem">
242<div class="memproto">
243<table class="mlabels">
244  <tr>
245  <td class="mlabels-left">
246      <table class="memname">
247        <tr>
248          <td class="memname">virtual flair::core::Object::~Object </td>
249          <td>(</td>
250          <td class="paramname"></td><td>)</td>
251          <td></td>
252        </tr>
253      </table>
254  </td>
255  <td class="mlabels-right">
256<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
257  </tr>
258</table>
259</div><div class="memdoc">
260
261<p>Destructor. </p>
262<p>Calling it will automatically destruct all childs. </p>
263
264</div>
265</div>
266<h2 class="groupheader">Member Function Documentation</h2>
267<a class="anchor" id="a9b0344dff7e1c05424d9152c8274523a"></a>
268<div class="memitem">
269<div class="memproto">
270      <table class="memname">
271        <tr>
272          <td class="memname">std::string flair::core::Object::ObjectName </td>
273          <td>(</td>
274          <td class="paramtype">void&#160;</td>
275          <td class="paramname"></td><td>)</td>
276          <td> const</td>
277        </tr>
278      </table>
279</div><div class="memdoc">
280
281<p>Name. </p>
282<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. ">Object</a>'s name </dd></dl>
283
284</div>
285</div>
286<a class="anchor" id="a609a250ec037fbcaf8957c8f1dcbfc53"></a>
287<div class="memitem">
288<div class="memproto">
289      <table class="memname">
290        <tr>
291          <td class="memname">std::string flair::core::Object::ObjectType </td>
292          <td>(</td>
293          <td class="paramtype">void&#160;</td>
294          <td class="paramname"></td><td>)</td>
295          <td> const</td>
296        </tr>
297      </table>
298</div><div class="memdoc">
299
300<p>Type. </p>
301<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. ">Object</a>'s type </dd></dl>
302
303</div>
304</div>
305<a class="anchor" id="a360c112cc3017a5152ebf6e84d2efa70"></a>
306<div class="memitem">
307<div class="memproto">
308      <table class="memname">
309        <tr>
310          <td class="memname">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a>* flair::core::Object::Parent </td>
311          <td>(</td>
312          <td class="paramtype">void&#160;</td>
313          <td class="paramname"></td><td>)</td>
314          <td> const</td>
315        </tr>
316      </table>
317</div><div class="memdoc">
318
319<p>Parent. </p>
320<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. ">Object</a>'s parent </dd></dl>
321
322</div>
323</div>
324<a class="anchor" id="ae22db4d723ec2d50b3ba48f26a6a770c"></a>
325<div class="memitem">
326<div class="memproto">
327      <table class="memname">
328        <tr>
329          <td class="memname">std::vector&lt;const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&gt;* flair::core::Object::TypeChilds </td>
330          <td>(</td>
331          <td class="paramtype">void&#160;</td>
332          <td class="paramname"></td><td>)</td>
333          <td> const</td>
334        </tr>
335      </table>
336</div><div class="memdoc">
337
338<p>Childs of the same type. </p>
339<dl class="section return"><dt>Returns</dt><dd>a vector of all childs of the same type </dd></dl>
340
341</div>
342</div>
343<a class="anchor" id="a344f81cd35805a9501098bf727ac1a10"></a>
344<div class="memitem">
345<div class="memproto">
346      <table class="memname">
347        <tr>
348          <td class="memname">std::vector&lt;const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&gt;* flair::core::Object::Childs </td>
349          <td>(</td>
350          <td class="paramtype">void&#160;</td>
351          <td class="paramname"></td><td>)</td>
352          <td> const</td>
353        </tr>
354      </table>
355</div><div class="memdoc">
356
357<p>Childs. </p>
358<dl class="section return"><dt>Returns</dt><dd>a vector of all childs </dd></dl>
359
360</div>
361</div>
362<a class="anchor" id="af001feba14fc053aa778e61080a0b4cf"></a>
363<div class="memitem">
364<div class="memproto">
365      <table class="memname">
366        <tr>
367          <td class="memname">void flair::core::Object::Information </td>
368          <td>(</td>
369          <td class="paramtype">const char *&#160;</td>
370          <td class="paramname"><em>function</em>, </td>
371        </tr>
372        <tr>
373          <td class="paramkey"></td>
374          <td></td>
375          <td class="paramtype">int&#160;</td>
376          <td class="paramname"><em>line</em>, </td>
377        </tr>
378        <tr>
379          <td class="paramkey"></td>
380          <td></td>
381          <td class="paramtype">const char *&#160;</td>
382          <td class="paramname"><em>format</em>, </td>
383        </tr>
384        <tr>
385          <td class="paramkey"></td>
386          <td></td>
387          <td class="paramtype">&#160;</td>
388          <td class="paramname"><em>...</em>&#160;</td>
389        </tr>
390        <tr>
391          <td></td>
392          <td>)</td>
393          <td></td><td> const</td>
394        </tr>
395      </table>
396</div><div class="memdoc">
397
398<p>Formatted information. </p>
399<p>Green colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
400 Note that it is better to call Info macro, which automatically fills function parameter.</p>
401<dl class="params"><dt>Parameters</dt><dd>
402  <table class="params">
403    <tr><td class="paramname">function</td><td>name of calling function </td></tr>
404    <tr><td class="paramname">line</td><td>line number in calling function </td></tr>
405    <tr><td class="paramname">format</td><td>text string to display </td></tr>
406  </table>
407  </dd>
408</dl>
409
410</div>
411</div>
412<a class="anchor" id="a168b18451b2ee6126e1e81d452005ff6"></a>
413<div class="memitem">
414<div class="memproto">
415      <table class="memname">
416        <tr>
417          <td class="memname">void flair::core::Object::Warning </td>
418          <td>(</td>
419          <td class="paramtype">const char *&#160;</td>
420          <td class="paramname"><em>function</em>, </td>
421        </tr>
422        <tr>
423          <td class="paramkey"></td>
424          <td></td>
425          <td class="paramtype">const char *&#160;</td>
426          <td class="paramname"><em>format</em>, </td>
427        </tr>
428        <tr>
429          <td class="paramkey"></td>
430          <td></td>
431          <td class="paramtype">&#160;</td>
432          <td class="paramname"><em>...</em>&#160;</td>
433        </tr>
434        <tr>
435          <td></td>
436          <td>)</td>
437          <td></td><td> const</td>
438        </tr>
439      </table>
440</div><div class="memdoc">
441
442<p>Formatted warning. </p>
443<p>Orange colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
444 Note that it is better to call Warn macro, which automatically fills function parameter.</p>
445<dl class="params"><dt>Parameters</dt><dd>
446  <table class="params">
447    <tr><td class="paramname">function</td><td>name of calling function </td></tr>
448    <tr><td class="paramname">format</td><td>text string to display </td></tr>
449  </table>
450  </dd>
451</dl>
452
453</div>
454</div>
455<a class="anchor" id="a3ca9694d29ec2b0491739879685df5ca"></a>
456<div class="memitem">
457<div class="memproto">
458      <table class="memname">
459        <tr>
460          <td class="memname">void flair::core::Object::Error </td>
461          <td>(</td>
462          <td class="paramtype">const char *&#160;</td>
463          <td class="paramname"><em>function</em>, </td>
464        </tr>
465        <tr>
466          <td class="paramkey"></td>
467          <td></td>
468          <td class="paramtype">const char *&#160;</td>
469          <td class="paramname"><em>format</em>, </td>
470        </tr>
471        <tr>
472          <td class="paramkey"></td>
473          <td></td>
474          <td class="paramtype">&#160;</td>
475          <td class="paramname"><em>...</em>&#160;</td>
476        </tr>
477        <tr>
478          <td></td>
479          <td>)</td>
480          <td></td><td> const</td>
481        </tr>
482      </table>
483</div><div class="memdoc">
484
485<p>Formatted error. </p>
486<p>Red colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
487 Note that it is better to call Err macro, which automatically fills function parameter. <br />
488 After calling this method, <a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85" title="Has an errror occured? ">ErrorOccured()</a> will always return true.</p>
489<dl class="params"><dt>Parameters</dt><dd>
490  <table class="params">
491    <tr><td class="paramname">function</td><td>name of calling function </td></tr>
492    <tr><td class="paramname">format</td><td>text string to display </td></tr>
493  </table>
494  </dd>
495</dl>
496
497</div>
498</div>
499<a class="anchor" id="a36cdd7f556e78b1bddd1d1fe4264bb85"></a>
500<div class="memitem">
501<div class="memproto">
502      <table class="memname">
503        <tr>
504          <td class="memname">bool flair::core::Object::ErrorOccured </td>
505          <td>(</td>
506          <td class="paramtype">bool&#160;</td>
507          <td class="paramname"><em>recursive</em> = <code>true</code></td><td>)</td>
508          <td> const</td>
509        </tr>
510      </table>
511</div><div class="memdoc">
512
513<p>Has an errror occured? </p>
514<p>Check if an error occured, in fact if <a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca" title="Formatted error. ">Error()</a> was called at least once. <br />
515Once <a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca" title="Formatted error. ">Error()</a> was called, this method will never return back false.</p>
516<dl class="params"><dt>Parameters</dt><dd>
517  <table class="params">
518    <tr><td class="paramname">recursive</td><td>if true, recursively check among childs </td></tr>
519  </table>
520  </dd>
521</dl>
522<dl class="section return"><dt>Returns</dt><dd>true if an error occured </dd></dl>
523
524</div>
525</div>
526</div><!-- contents -->
527</div><!-- doc-content -->
528<!-- start footer part -->
529<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
530  <ul>
531    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_object.html">Object</a></li>
532    <li class="footer">Generated on Wed Sep 28 2016 07:01:52 for Flair by
533    <a href="http://www.doxygen.org/index.html">
534    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
535  </ul>
536</div>
537</body>
538</html>
Note: See TracBrowser for help on using the repository browser.