source: flair-dev/tags/0.0.1/doc/Flair/classflair_1_1core_1_1_object.html

Last change on this file was 16, checked in by Sanahuja Guillaume, 8 years ago

complementary filter

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