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

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

doc

File size: 27.7 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_semaphore.html" title="Class defining a semaphore. " alt="flair::core::Semaphore" shape="rect" coords="197,336,384,360"/>
137<area href="classflair_1_1core_1_1_serial_port.html" title="Base class for serial port. " alt="flair::core::SerialPort" shape="rect" coords="197,392,384,416"/>
138<area href="classflair_1_1core_1_1_shared_mem.html" title="Class defining a shared memory. " alt="flair::core::SharedMem" 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_1core_1_1_udp_socket.html" title="Class encapsulating a UDP socket. It assumes packets are coming from only one distant host on a given..." alt="flair::core::UdpSocket" shape="rect" coords="197,560,384,584"/>
141<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,616,384,640"/>
142<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,672,384,696"/>
143<area href="classflair_1_1meta_1_1_uav.html" title="Base class to construct sensors/actuators depending on uav type. The Object is created with the Frame..." alt="flair::meta::Uav" shape="rect" coords="197,728,384,752"/>
144<area href="classflair_1_1simulator_1_1_gui.html" alt="flair::simulator::Gui" shape="rect" coords="197,784,384,808"/>
145</map>
146 </div></div>
147<table class="memberdecls">
148<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
149Public Types</h2></td></tr>
150<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,
151<b>Red</b> = 31,
152<b>Green</b> = 32,
153<b>Orange</b> = 33
154 }</td></tr>
155<tr class="separator:aed5fccda511f97487040fed29f4efc97"><td class="memSeparator" colspan="2">&#160;</td></tr>
156</table><table class="memberdecls">
157<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
158Public Member Functions</h2></td></tr>
159<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>
160<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
161<tr class="separator:aec92383fd5bf68d9df10414862b7e95c"><td class="memSeparator" colspan="2">&#160;</td></tr>
162<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>
163<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
164<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09"><td class="memSeparator" colspan="2">&#160;</td></tr>
165<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>
166<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name. <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
167<tr class="separator:a9b0344dff7e1c05424d9152c8274523a"><td class="memSeparator" colspan="2">&#160;</td></tr>
168<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>
169<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type. <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
170<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<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>
172<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent. <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
173<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<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>
175<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>
176<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<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>
178<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs. <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
179<tr class="separator:a344f81cd35805a9501098bf727ac1a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
180<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>
181<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information. <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
182<tr class="separator:af001feba14fc053aa778e61080a0b4cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
183<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>
184<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning. <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
185<tr class="separator:a168b18451b2ee6126e1e81d452005ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
186<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>
187<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error. <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
188<tr class="separator:a3ca9694d29ec2b0491739879685df5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
189<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>
190<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured? <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
191<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85"><td class="memSeparator" colspan="2">&#160;</td></tr>
192</table>
193<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
194<div class="textblock"><p>Base class for all Framework's classes. </p>
195<p>This is the base class for all other classes. <br />
196It handles parent/child links and thus allow auto destruction of childs. </p>
197</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
198<a class="anchor" id="aec92383fd5bf68d9df10414862b7e95c"></a>
199<div class="memitem">
200<div class="memproto">
201 <table class="memname">
202 <tr>
203 <td class="memname">flair::core::Object::Object </td>
204 <td>(</td>
205 <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
206 <td class="paramname"><em>parent</em> = <code>NULL</code>, </td>
207 </tr>
208 <tr>
209 <td class="paramkey"></td>
210 <td></td>
211 <td class="paramtype">std::string&#160;</td>
212 <td class="paramname"><em>name</em> = <code>&quot;&quot;</code>, </td>
213 </tr>
214 <tr>
215 <td class="paramkey"></td>
216 <td></td>
217 <td class="paramtype">std::string&#160;</td>
218 <td class="paramname"><em>type</em> = <code>&quot;&quot;</code>&#160;</td>
219 </tr>
220 <tr>
221 <td></td>
222 <td>)</td>
223 <td></td><td></td>
224 </tr>
225 </table>
226</div><div class="memdoc">
227
228<p>Constructor. </p>
229<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>
230<dl class="params"><dt>Parameters</dt><dd>
231 <table class="params">
232 <tr><td class="paramname">parent</td><td>parent </td></tr>
233 <tr><td class="paramname">name</td><td>name </td></tr>
234 <tr><td class="paramname">type</td><td>type </td></tr>
235 </table>
236 </dd>
237</dl>
238
239</div>
240</div>
241<a class="anchor" id="aa2bde0e6677bbef705c96c93cb06ad09"></a>
242<div class="memitem">
243<div class="memproto">
244<table class="mlabels">
245 <tr>
246 <td class="mlabels-left">
247 <table class="memname">
248 <tr>
249 <td class="memname">virtual flair::core::Object::~Object </td>
250 <td>(</td>
251 <td class="paramname"></td><td>)</td>
252 <td></td>
253 </tr>
254 </table>
255 </td>
256 <td class="mlabels-right">
257<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
258 </tr>
259</table>
260</div><div class="memdoc">
261
262<p>Destructor. </p>
263<p>Calling it will automatically destruct all childs. </p>
264
265</div>
266</div>
267<h2 class="groupheader">Member Function Documentation</h2>
268<a class="anchor" id="a9b0344dff7e1c05424d9152c8274523a"></a>
269<div class="memitem">
270<div class="memproto">
271 <table class="memname">
272 <tr>
273 <td class="memname">std::string flair::core::Object::ObjectName </td>
274 <td>(</td>
275 <td class="paramtype">void&#160;</td>
276 <td class="paramname"></td><td>)</td>
277 <td> const</td>
278 </tr>
279 </table>
280</div><div class="memdoc">
281
282<p>Name. </p>
283<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>
284
285</div>
286</div>
287<a class="anchor" id="a609a250ec037fbcaf8957c8f1dcbfc53"></a>
288<div class="memitem">
289<div class="memproto">
290 <table class="memname">
291 <tr>
292 <td class="memname">std::string flair::core::Object::ObjectType </td>
293 <td>(</td>
294 <td class="paramtype">void&#160;</td>
295 <td class="paramname"></td><td>)</td>
296 <td> const</td>
297 </tr>
298 </table>
299</div><div class="memdoc">
300
301<p>Type. </p>
302<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>
303
304</div>
305</div>
306<a class="anchor" id="a360c112cc3017a5152ebf6e84d2efa70"></a>
307<div class="memitem">
308<div class="memproto">
309 <table class="memname">
310 <tr>
311 <td class="memname">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a>* flair::core::Object::Parent </td>
312 <td>(</td>
313 <td class="paramtype">void&#160;</td>
314 <td class="paramname"></td><td>)</td>
315 <td> const</td>
316 </tr>
317 </table>
318</div><div class="memdoc">
319
320<p>Parent. </p>
321<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>
322
323</div>
324</div>
325<a class="anchor" id="ae22db4d723ec2d50b3ba48f26a6a770c"></a>
326<div class="memitem">
327<div class="memproto">
328 <table class="memname">
329 <tr>
330 <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>
331 <td>(</td>
332 <td class="paramtype">void&#160;</td>
333 <td class="paramname"></td><td>)</td>
334 <td> const</td>
335 </tr>
336 </table>
337</div><div class="memdoc">
338
339<p>Childs of the same type. </p>
340<dl class="section return"><dt>Returns</dt><dd>a vector of all childs of the same type </dd></dl>
341
342</div>
343</div>
344<a class="anchor" id="a344f81cd35805a9501098bf727ac1a10"></a>
345<div class="memitem">
346<div class="memproto">
347 <table class="memname">
348 <tr>
349 <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>
350 <td>(</td>
351 <td class="paramtype">void&#160;</td>
352 <td class="paramname"></td><td>)</td>
353 <td> const</td>
354 </tr>
355 </table>
356</div><div class="memdoc">
357
358<p>Childs. </p>
359<dl class="section return"><dt>Returns</dt><dd>a vector of all childs </dd></dl>
360
361</div>
362</div>
363<a class="anchor" id="af001feba14fc053aa778e61080a0b4cf"></a>
364<div class="memitem">
365<div class="memproto">
366 <table class="memname">
367 <tr>
368 <td class="memname">void flair::core::Object::Information </td>
369 <td>(</td>
370 <td class="paramtype">const char *&#160;</td>
371 <td class="paramname"><em>function</em>, </td>
372 </tr>
373 <tr>
374 <td class="paramkey"></td>
375 <td></td>
376 <td class="paramtype">int&#160;</td>
377 <td class="paramname"><em>line</em>, </td>
378 </tr>
379 <tr>
380 <td class="paramkey"></td>
381 <td></td>
382 <td class="paramtype">const char *&#160;</td>
383 <td class="paramname"><em>format</em>, </td>
384 </tr>
385 <tr>
386 <td class="paramkey"></td>
387 <td></td>
388 <td class="paramtype">&#160;</td>
389 <td class="paramname"><em>...</em>&#160;</td>
390 </tr>
391 <tr>
392 <td></td>
393 <td>)</td>
394 <td></td><td> const</td>
395 </tr>
396 </table>
397</div><div class="memdoc">
398
399<p>Formatted information. </p>
400<p>Green colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
401Note that it is better to call Info macro, which automatically fills calling function parameter.</p>
402<dl class="params"><dt>Parameters</dt><dd>
403 <table class="params">
404 <tr><td class="paramname">function</td><td>name of calling function </td></tr>
405 <tr><td class="paramname">line</td><td>line number in calling function </td></tr>
406 <tr><td class="paramname">format</td><td>text string to display </td></tr>
407 </table>
408 </dd>
409</dl>
410
411</div>
412</div>
413<a class="anchor" id="a168b18451b2ee6126e1e81d452005ff6"></a>
414<div class="memitem">
415<div class="memproto">
416 <table class="memname">
417 <tr>
418 <td class="memname">void flair::core::Object::Warning </td>
419 <td>(</td>
420 <td class="paramtype">const char *&#160;</td>
421 <td class="paramname"><em>function</em>, </td>
422 </tr>
423 <tr>
424 <td class="paramkey"></td>
425 <td></td>
426 <td class="paramtype">const char *&#160;</td>
427 <td class="paramname"><em>format</em>, </td>
428 </tr>
429 <tr>
430 <td class="paramkey"></td>
431 <td></td>
432 <td class="paramtype">&#160;</td>
433 <td class="paramname"><em>...</em>&#160;</td>
434 </tr>
435 <tr>
436 <td></td>
437 <td>)</td>
438 <td></td><td> const</td>
439 </tr>
440 </table>
441</div><div class="memdoc">
442
443<p>Formatted warning. </p>
444<p>Orange colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
445Note that it is better to call Warn macro, which automatically fills calling function parameter.</p>
446<dl class="params"><dt>Parameters</dt><dd>
447 <table class="params">
448 <tr><td class="paramname">function</td><td>name of calling function </td></tr>
449 <tr><td class="paramname">format</td><td>text string to display </td></tr>
450 </table>
451 </dd>
452</dl>
453
454</div>
455</div>
456<a class="anchor" id="a3ca9694d29ec2b0491739879685df5ca"></a>
457<div class="memitem">
458<div class="memproto">
459 <table class="memname">
460 <tr>
461 <td class="memname">void flair::core::Object::Error </td>
462 <td>(</td>
463 <td class="paramtype">const char *&#160;</td>
464 <td class="paramname"><em>function</em>, </td>
465 </tr>
466 <tr>
467 <td class="paramkey"></td>
468 <td></td>
469 <td class="paramtype">const char *&#160;</td>
470 <td class="paramname"><em>format</em>, </td>
471 </tr>
472 <tr>
473 <td class="paramkey"></td>
474 <td></td>
475 <td class="paramtype">&#160;</td>
476 <td class="paramname"><em>...</em>&#160;</td>
477 </tr>
478 <tr>
479 <td></td>
480 <td>)</td>
481 <td></td><td> const</td>
482 </tr>
483 </table>
484</div><div class="memdoc">
485
486<p>Formatted error. </p>
487<p>Red colored <a class="el" href="namespaceflair_1_1core.html#aa7fe0d3548e4e65719702a7fb29775b1" title="Formatted print. ">Printf()</a>. <br />
488Note that it is better to call Err macro, which automatically fills function calling parameter. <br />
489After 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>
490<dl class="params"><dt>Parameters</dt><dd>
491 <table class="params">
492 <tr><td class="paramname">function</td><td>name of calling function </td></tr>
493 <tr><td class="paramname">format</td><td>text string to display </td></tr>
494 </table>
495 </dd>
496</dl>
497
498</div>
499</div>
500<a class="anchor" id="a36cdd7f556e78b1bddd1d1fe4264bb85"></a>
501<div class="memitem">
502<div class="memproto">
503 <table class="memname">
504 <tr>
505 <td class="memname">bool flair::core::Object::ErrorOccured </td>
506 <td>(</td>
507 <td class="paramtype">bool&#160;</td>
508 <td class="paramname"><em>recursive</em> = <code>true</code></td><td>)</td>
509 <td> const</td>
510 </tr>
511 </table>
512</div><div class="memdoc">
513
514<p>Has an errror occured? </p>
515<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 />
516Once <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>
517<dl class="params"><dt>Parameters</dt><dd>
518 <table class="params">
519 <tr><td class="paramname">recursive</td><td>if true, recursively check among childs </td></tr>
520 </table>
521 </dd>
522</dl>
523<dl class="section return"><dt>Returns</dt><dd>true if an error occured </dd></dl>
524
525</div>
526</div>
527</div><!-- contents -->
528</div><!-- doc-content -->
529<!-- start footer part -->
530<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
531 <ul>
532 <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>
533 <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
534 <a href="http://www.doxygen.org/index.html">
535 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
536 </ul>
537</div>
538</body>
539</html>
Note: See TracBrowser for help on using the repository browser.