Context Navigation

classbdm_1_1UI.html @ 591

Revision 591, 31.1 kB (checked in by smidl, 15 years ago)
doc

Rev	Line
[591]	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"/>
[353]	5	<title>mixpp: bdm::UI Class Reference</title>
[591]	6	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	7	<link href="doxygen.css" rel="stylesheet" type="text/css"/>
	8	</head>
	9	<body>
	10	<!-- Generated by Doxygen 1.6.1 -->
[353]	11	<script type="text/javascript">
	12	<!--
	13	function changeDisplayState (e){
	14	var num=this.id.replace(/[^[0-9]/g,'');
	15	var button=this.firstChild;
	16	var sectionDiv=document.getElementById('dynsection'+num);
	17	if (sectionDiv.style.display=='none'\|\|sectionDiv.style.display==''){
	18	sectionDiv.style.display='block';
	19	button.src='open.gif';
	20	}else{
	21	sectionDiv.style.display='none';
	22	button.src='closed.gif';
	23	}
	24	}
	25	function initDynSections(){
	26	var divs=document.getElementsByTagName('div');
	27	var sectionCounter=1;
	28	for(var i=0;i<divs.length-1;i++){
	29	if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
	30	var header=divs[i];
	31	var section=divs[i+1];
	32	var button=header.firstChild;
	33	if (button!='IMG'){
	34	divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
	35	button=document.createElement('img');
	36	divs[i].insertBefore(button,divs[i].firstChild);
	37	}
	38	header.style.cursor='pointer';
	39	header.onclick=changeDisplayState;
	40	header.id='dynheader'+sectionCounter;
	41	button.src='closed.gif';
	42	section.id='dynsection'+sectionCounter;
	43	section.style.display='none';
	44	section.style.marginLeft='14px';
	45	sectionCounter++;
	46	}
	47	}
	48	}
	49	window.onload = initDynSections;
	50	-->
	51	</script>
	52	<div class="navigation" id="top">
	53	<div class="tabs">
	54	<ul>
	55	<li><a href="main.html"><span>Main Page</span></a></li>
	56	<li><a href="pages.html"><span>Related Pages</span></a></li>
	57	<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
	58	<li><a href="files.html"><span>Files</span></a></li>
	59	</ul>
	60	</div>
	61	<div class="tabs">
	62	<ul>
	63	<li><a href="annotated.html"><span>Class List</span></a></li>
	64	<li><a href="classes.html"><span>Class Index</span></a></li>
	65	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
	66	<li><a href="functions.html"><span>Class Members</span></a></li>
	67	</ul>
	68	</div>
	69	<div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1UI.html">UI</a>
	70	</div>
	71	</div>
	72	<div class="contents">
[591]	73	<h1>bdm::UI Class Reference</h1><!-- doxytag: class="bdm::UI" -->
	74	<p><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos.
	75	<a href="#_details">More...</a></p>
[353]	76
[591]	77	<p><code>#include <<a class="el" href="user__info_8h_source.html">user_info.h</a>></code></p>
[354]	78
[591]	79	<p><a href="classbdm_1_1UI-members.html">List of all members.</a></p>
	80	<table border="0" cellpadding="0" cellspacing="0">
	81	<tr><td colspan="2"><h2>Classes</h2></td></tr>
	82	<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><b>MappedUI</b></td></tr>
	83	<tr><td colspan="2"><h2>Public Types</h2></td></tr>
	84	<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>,
[472]	85	<b>compulsory</b>
	86	}</td></tr>
[591]	87	<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Enum type used to determine whether the data for concrete Settingis is compulsory or optional. </p>
	88	<br/></td></tr>
	89	<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
[396]	90	<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr>
[591]	91	<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp3a55e6a2ce460fc0ef4560883d62c9a8"></a> The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">bdm::root</a> descendant class </p>
	92	<br/><br/></div></td></tr>
	93	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	94	<tr><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
	95	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	96	<tr><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#af02851b299aedeb891e30c4807903081">build</a> (const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
[396]	97	<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr>
[591]	98	<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp2f6254f904d5aa502f9248135b8a1928"></a> The type T has to be int, double, string, vec, ivec or mat. </p>
	99	<br/><br/></div></td></tr>
	100	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	101	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &instance, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
	102	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	103	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &instance, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
	104	<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::UI::get" ref="a7d2ea138c7285565507fa61fbd9b038f" args="(T &instance, const Setting &element)" -->
[396]	105	template<class T > </td></tr>
[591]	106	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7d2ea138c7285565507fa61fbd9b038f">get</a> (T &instance, const Setting &element)</td></tr>
	107	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br/></td></tr>
[396]	108	<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array<T></div></td></tr>
[591]	109	<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpdc7b7e904f3afe234da7899219782a1e"></a> The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. </p>
	110	<br/><br/></div></td></tr>
	111	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	112	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a81ce18ed0bb9993a634db2b99612ad66">get</a> (Array< T > &array_to_load, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
	113	<tr><td class="memTemplParams" colspan="2">template<class T > </td></tr>
	114	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a29e450ed5560f81ef2f845e7b1021b71">get</a> (Array< T > &array_to_load, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
	115	<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::UI::get" ref="ac9fad8376d2f0857e719511f92f93998" args="(Array< T > &array_to_load, const Setting &element)" -->
[396]	116	template<class T > </td></tr>
[591]	117	<tr><td class="memTemplItemLeft" align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ac9fad8376d2f0857e719511f92f93998">get</a> (Array< T > &array_to_load, const Setting &element)</td></tr>
	118	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br/></td></tr>
[396]	119	<tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr>
[591]	120	<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpbcd9e02fd9946d6ed8c1fbff1006b520"></a> The new child Setting can be accessed either by its name - if some name is passed as a parameter - or by its integer index. In that case, the new element is added at the very end of the current list of child Settings. </p>
	121	<br/><br/></div></td></tr>
	122	<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::UI::save" ref="ac83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &element, const string &name="")" -->
[354]	123	template<class T > </td></tr>
[591]	124	<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ac83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &element, const string &name="")</td></tr>
	125	<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant instance is stored in the new child Setting appended to the passed element. <br/></td></tr>
	126	<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::UI::save" ref="a7a307cd313e516b6d5629046dd321039" args="(const shared_ptr< T > &instance, Setting &element, const string &name="")" -->
[538]	127	template<class T > </td></tr>
[591]	128	<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><b>save</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>< T > &instance, Setting &element, const string &name="")</td></tr>
	129	<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::UI::save" ref="a4514f93573a9d9126c506d176fbd3163" args="(const Array< T > &array_to_save, Setting &element, const string &name="")" -->
[354]	130	template<class T > </td></tr>
[591]	131	<tr><td class="memTemplItemLeft" align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4514f93573a9d9126c506d176fbd3163">save</a> (const Array< T > &array_to_save, Setting &element, const string &name="")</td></tr>
	132	<tr><td class="mdescLeft"> </td><td class="mdescRight">An Array<T> instance is stored in the new child Setting appended to the passed element. <br/></td></tr>
	133	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::UI::save" ref="a42e908a4f1b09d701be69c8784a02df7" args="(const mat &matrix, Setting &element, const string &name="")" -->
	134	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &matrix, Setting &element, const string &name="")</td></tr>
	135	<tr><td class="mdescLeft"> </td><td class="mdescRight">A matrix(of type mat) is stored in the new child Setting appended to the passed element. <br/></td></tr>
	136	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::UI::save" ref="acc2afb61a772d8571f7bb19065da4695" args="(const ivec &vec, Setting &element, const string &name="")" -->
	137	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &vec, Setting &element, const string &name="")</td></tr>
	138	<tr><td class="mdescLeft"> </td><td class="mdescRight">An integer vector (of type ivec) is stored in the new child Setting appended to the passed element. <br/></td></tr>
	139	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::UI::save" ref="a7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &vector, Setting &element, const string &name="")" -->
	140	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &vector, Setting &element, const string &name="")</td></tr>
	141	<tr><td class="mdescLeft"> </td><td class="mdescRight">A double vector (of type vec) is stored in the new child Setting appended to the passed element. <br/></td></tr>
	142	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::UI::save" ref="a7c822efd5f8550480d0756352d430c05" args="(const string &str, Setting &element, const string &name="")" -->
	143	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c822efd5f8550480d0756352d430c05">save</a> (const string &<a class="el" href="classbdm_1_1str.html">str</a>, Setting &element, const string &name="")</td></tr>
	144	<tr><td class="mdescLeft"> </td><td class="mdescRight">A string is stored in the new child Setting appended to the passed element. <br/></td></tr>
	145	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::UI::save" ref="a8cd58216bcd732856846d18503c92d48" args="(const int &integer, Setting &element, const string &name="")" -->
	146	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a8cd58216bcd732856846d18503c92d48">save</a> (const int &integer, Setting &element, const string &name="")</td></tr>
	147	<tr><td class="mdescLeft"> </td><td class="mdescRight">An integer is stored in the new child Setting appended to the passed element. <br/></td></tr>
	148	<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::UI::save" ref="a4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &real, Setting &element, const string &name="")" -->
	149	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &real, Setting &element, const string &name="")</td></tr>
	150	<tr><td class="mdescLeft"> </td><td class="mdescRight">A double is stored in the new child Setting appended to the passed element. <br/></td></tr>
	151	<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
	152	<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ad60234c0673f345424329894b9b0cef8">UI</a> (const string &class_name, const type_info *const class_type_info)</td></tr>
	153	<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for internal use only, see. <a href="#ad60234c0673f345424329894b9b0cef8"></a><br/></td></tr>
[353]	154	</table>
[591]	155	<hr/><a name="_details"></a><h2>Detailed Description</h2>
	156	<p><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos. </p>
	157	<p>See static methods 'build', 'get' and 'save'. Writing user-infos with these methods is rather simple. The rest of this class is intended for internal purposes only. Its meaning is to allow pointers to its templated descendant ParticularUI<T>.</p>
	158	<p><a class="el" href="ui_page.html">User Infos and their use</a> </p>
	159	<hr/><h2>Constructor & Destructor Documentation</h2>
	160	<a class="anchor" id="ad60234c0673f345424329894b9b0cef8"></a><!-- doxytag: member="bdm::UI::UI" ref="ad60234c0673f345424329894b9b0cef8" args="(const string &class_name, const type_info *const class_type_info)" -->
[353]	161	<div class="memitem">
	162	<div class="memproto">
	163	<table class="memname">
	164	<tr>
[591]	165	<td class="memname">bdm::UI::UI </td>
[353]	166	<td>(</td>
[396]	167	<td class="paramtype">const string & </td>
	168	<td class="paramname"> <em>class_name</em>, </td>
[368]	169	</tr>
	170	<tr>
	171	<td class="paramkey"></td>
	172	<td></td>
[396]	173	<td class="paramtype">const type_info *const  </td>
	174	<td class="paramname"> <em>class_type_info</em></td><td> </td>
[353]	175	</tr>
	176	<tr>
	177	<td></td>
	178	<td>)</td>
[396]	179	<td></td><td></td><td><code> [inline, protected]</code></td>
[353]	180	</tr>
	181	</table>
	182	</div>
	183	<div class="memdoc">
	184
[591]	185	<p>Constructor for internal use only, see. </p>
	186	<dl class="see"><dt><b>See also:</b></dt><dd>ParticularUI<T> </dd></dl>
[396]	187
[353]	188	</div>
[591]	189	</div>
	190	<hr/><h2>Member Function Documentation</h2>
	191	<a class="anchor" id="af02851b299aedeb891e30c4807903081"></a><!-- doxytag: member="bdm::UI::build" ref="af02851b299aedeb891e30c4807903081" args="(const Setting &element, const int index, SettingPresence settingPresence=optional)" -->
[472]	192	<div class="memitem">
	193	<div class="memproto">
	194	<div class="memtemplate">
	195	template<class T > </div>
	196	<table class="memname">
	197	<tr>
[591]	198	<td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a><T> bdm::UI::build </td>
[472]	199	<td>(</td>
	200	<td class="paramtype">const Setting & </td>
	201	<td class="paramname"> <em>element</em>, </td>
	202	</tr>
	203	<tr>
	204	<td class="paramkey"></td>
	205	<td></td>
	206	<td class="paramtype">const int </td>
	207	<td class="paramname"> <em>index</em>, </td>
	208	</tr>
	209	<tr>
	210	<td class="paramkey"></td>
	211	<td></td>
[591]	212	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	213	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	214	</tr>
	215	<tr>
	216	<td></td>
	217	<td>)</td>
	218	<td></td><td></td><td><code> [inline, static]</code></td>
	219	</tr>
	220	</table>
	221	</div>
	222	<div class="memdoc">
[591]	223	<p>The new instance of type T* is constructed and initialized with values stored in the Setting element[index]</p>
	224	<p>If there is not any sub-element indexed by index, and settingPresence is optional, an empty shared_ptr<T> is returned. When settingPresence is compulsory, the returned shared_ptr<T> is never empty (an exception is thrown when the object isn't found). </p>
[472]	225
	226	</div>
[591]	227	</div>
	228	<a class="anchor" id="a1f3d45184f803e1256cfc896b43ed2f8"></a><!-- doxytag: member="bdm::UI::build" ref="a1f3d45184f803e1256cfc896b43ed2f8" args="(const Setting &element, const string &name, SettingPresence settingPresence=optional)" -->
[472]	229	<div class="memitem">
	230	<div class="memproto">
	231	<div class="memtemplate">
	232	template<class T > </div>
	233	<table class="memname">
	234	<tr>
[591]	235	<td class="memname">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a><T> bdm::UI::build </td>
[472]	236	<td>(</td>
	237	<td class="paramtype">const Setting & </td>
	238	<td class="paramname"> <em>element</em>, </td>
	239	</tr>
	240	<tr>
	241	<td class="paramkey"></td>
	242	<td></td>
	243	<td class="paramtype">const string & </td>
	244	<td class="paramname"> <em>name</em>, </td>
	245	</tr>
	246	<tr>
	247	<td class="paramkey"></td>
	248	<td></td>
[591]	249	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	250	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	251	</tr>
	252	<tr>
	253	<td></td>
	254	<td>)</td>
	255	<td></td><td></td><td><code> [inline, static]</code></td>
	256	</tr>
	257	</table>
	258	</div>
	259	<div class="memdoc">
[591]	260	<p>The new instance of type T* is constructed and initialized with values stored in the Setting element[name]</p>
	261	<p>If there is not any sub-element named name and settingPresence is optional, an empty shared_ptr<T> is returned. When settingPresence is compulsory, the returned shared_ptr<T> is never empty (an exception is thrown when the object isn't found). </p>
[472]	262
	263	</div>
[591]	264	</div>
	265	<a class="anchor" id="a29e450ed5560f81ef2f845e7b1021b71"></a><!-- doxytag: member="bdm::UI::get" ref="a29e450ed5560f81ef2f845e7b1021b71" args="(Array< T > &array_to_load, const Setting &element, const int index, SettingPresence settingPresence=optional)" -->
[472]	266	<div class="memitem">
	267	<div class="memproto">
	268	<div class="memtemplate">
	269	template<class T > </div>
	270	<table class="memname">
	271	<tr>
[591]	272	<td class="memname">static bool bdm::UI::get </td>
[472]	273	<td>(</td>
	274	<td class="paramtype">Array< T > & </td>
	275	<td class="paramname"> <em>array_to_load</em>, </td>
	276	</tr>
	277	<tr>
	278	<td class="paramkey"></td>
	279	<td></td>
	280	<td class="paramtype">const Setting & </td>
	281	<td class="paramname"> <em>element</em>, </td>
	282	</tr>
	283	<tr>
	284	<td class="paramkey"></td>
	285	<td></td>
	286	<td class="paramtype">const int </td>
	287	<td class="paramname"> <em>index</em>, </td>
	288	</tr>
	289	<tr>
	290	<td class="paramkey"></td>
	291	<td></td>
[591]	292	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	293	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	294	</tr>
	295	<tr>
	296	<td></td>
	297	<td>)</td>
	298	<td></td><td></td><td><code> [inline, static]</code></td>
	299	</tr>
	300	</table>
	301	</div>
	302	<div class="memdoc">
[591]	303	<p>The existing array of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. </p>
[472]	304
	305	</div>
[591]	306	</div>
	307	<a class="anchor" id="a81ce18ed0bb9993a634db2b99612ad66"></a><!-- doxytag: member="bdm::UI::get" ref="a81ce18ed0bb9993a634db2b99612ad66" args="(Array< T > &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence=optional)" -->
[472]	308	<div class="memitem">
	309	<div class="memproto">
	310	<div class="memtemplate">
	311	template<class T > </div>
	312	<table class="memname">
	313	<tr>
[591]	314	<td class="memname">static bool bdm::UI::get </td>
[472]	315	<td>(</td>
	316	<td class="paramtype">Array< T > & </td>
	317	<td class="paramname"> <em>array_to_load</em>, </td>
	318	</tr>
	319	<tr>
	320	<td class="paramkey"></td>
	321	<td></td>
	322	<td class="paramtype">const Setting & </td>
	323	<td class="paramname"> <em>element</em>, </td>
	324	</tr>
	325	<tr>
	326	<td class="paramkey"></td>
	327	<td></td>
	328	<td class="paramtype">const string & </td>
	329	<td class="paramname"> <em>name</em>, </td>
	330	</tr>
	331	<tr>
	332	<td class="paramkey"></td>
	333	<td></td>
[591]	334	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	335	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	336	</tr>
	337	<tr>
	338	<td></td>
	339	<td>)</td>
	340	<td></td><td></td><td><code> [inline, static]</code></td>
	341	</tr>
	342	</table>
	343	</div>
	344	<div class="memdoc">
[591]	345	<p>The existing array of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. </p>
[472]	346
	347	</div>
[591]	348	</div>
	349	<a class="anchor" id="a6fb95ccb13515a3f23080a397dacaa0e"></a><!-- doxytag: member="bdm::UI::get" ref="a6fb95ccb13515a3f23080a397dacaa0e" args="(T &instance, const Setting &element, const int index, SettingPresence settingPresence=optional)" -->
[472]	350	<div class="memitem">
	351	<div class="memproto">
	352	<div class="memtemplate">
	353	template<class T > </div>
	354	<table class="memname">
	355	<tr>
[591]	356	<td class="memname">static bool bdm::UI::get </td>
[472]	357	<td>(</td>
	358	<td class="paramtype">T & </td>
	359	<td class="paramname"> <em>instance</em>, </td>
	360	</tr>
	361	<tr>
	362	<td class="paramkey"></td>
	363	<td></td>
	364	<td class="paramtype">const Setting & </td>
	365	<td class="paramname"> <em>element</em>, </td>
	366	</tr>
	367	<tr>
	368	<td class="paramkey"></td>
	369	<td></td>
	370	<td class="paramtype">const int </td>
	371	<td class="paramname"> <em>index</em>, </td>
	372	</tr>
	373	<tr>
	374	<td class="paramkey"></td>
	375	<td></td>
[591]	376	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	377	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	378	</tr>
	379	<tr>
	380	<td></td>
	381	<td>)</td>
	382	<td></td><td></td><td><code> [inline, static]</code></td>
	383	</tr>
	384	</table>
	385	</div>
	386	<div class="memdoc">
[591]	387	<p>The existing instance of type T is initialized with values stored in the Setting element[index] If there is not any sub-element indexed by index, this method returns false. </p>
[472]	388
	389	</div>
[591]	390	</div>
	391	<a class="anchor" id="acd1667e6fec99ec64dabcb3ca2ff922d"></a><!-- doxytag: member="bdm::UI::get" ref="acd1667e6fec99ec64dabcb3ca2ff922d" args="(T &instance, const Setting &element, const string &name, SettingPresence settingPresence=optional)" -->
[472]	392	<div class="memitem">
	393	<div class="memproto">
	394	<div class="memtemplate">
	395	template<class T > </div>
	396	<table class="memname">
	397	<tr>
[591]	398	<td class="memname">static bool bdm::UI::get </td>
[472]	399	<td>(</td>
	400	<td class="paramtype">T & </td>
	401	<td class="paramname"> <em>instance</em>, </td>
	402	</tr>
	403	<tr>
	404	<td class="paramkey"></td>
	405	<td></td>
	406	<td class="paramtype">const Setting & </td>
	407	<td class="paramname"> <em>element</em>, </td>
	408	</tr>
	409	<tr>
	410	<td class="paramkey"></td>
	411	<td></td>
	412	<td class="paramtype">const string & </td>
	413	<td class="paramname"> <em>name</em>, </td>
	414	</tr>
	415	<tr>
	416	<td class="paramkey"></td>
	417	<td></td>
[591]	418	<td class="paramtype"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> </td>
[472]	419	<td class="paramname"> <em>settingPresence</em> = <code>optional</code></td><td> </td>
	420	</tr>
	421	<tr>
	422	<td></td>
	423	<td>)</td>
	424	<td></td><td></td><td><code> [inline, static]</code></td>
	425	</tr>
	426	</table>
	427	</div>
	428	<div class="memdoc">
[591]	429	<p>The existing instance of type T is initialized with values stored in the Setting element[name] If there is not any sub-element named name, this method returns false. </p>
[472]	430
[591]	431	<p>Referenced by <a class="el" href="merger_8h_source.html#l00262">bdm::merger_base::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00124">bdm::Kalman< fsqmat >::from_setting()</a>, <a class="el" href="kalman_8h_source.html#l00059">bdm::StateSpace< fsqmat >::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00276">bdm::MultiModel::from_setting()</a>, <a class="el" href="kalman_8cpp_source.html#l00240">bdm::EKFCh::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l01219">bdm::enorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00741">bdm::mgamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00641">bdm::mgnorm< sq_T >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00581">bdm::mlnorm< chmat >::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00522">bdm::euni::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00411">bdm::egamma::from_setting()</a>, <a class="el" href="exp__family_8h_source.html#l00249">bdm::egiw::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00334">bdm::mlognorm::from_setting()</a>, <a class="el" href="exp__family_8cpp_source.html#l00328">bdm::migamma_ref::from_setting()</a>, <a class="el" href="emix_8h_source.html#l00361">bdm::mprod::from_setting()</a>, <a class="el" href="discrete_8h_source.html#l00174">bdm::discrete_support::from_setting()</a>, <a class="el" href="discrete_8h_source.html#l00140">bdm::rectangular_support::from_setting()</a>, <a class="el" href="datasources_8cpp_source.html#l00058">bdm::ArxDS::from_setting()</a>, <a class="el" href="ctrlbase_8h_source.html#l00132">bdm::Controller::from_setting()</a>, <a class="el" href="bdmbase_8h_source.html#l00992">bdm::BM::from_setting()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00323">bdm::RV::from_setting()</a>, <a class="el" href="arx_8cpp_source.html#l00204">bdm::ARX::from_setting()</a>, and <a class="el" href="arx__ctrl_8h_source.html#l00055">bdm::LQG_ARX::from_settings()</a>.</p>
[472]	432
	433	</div>
[353]	434	</div>
[591]	435	<hr/>The documentation for this class was generated from the following files:<ul>
	436	<li><a class="el" href="user__info_8h_source.html">user_info.h</a></li>
	437	<li>user_info.cpp</li>
	438	</ul>
	439	</div>
	440	<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by
[353]	441	<a href="http://www.doxygen.org/index.html">
[591]	442	<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
[353]	443	</body>
	444	</html>

Note: See TracBrowser for help on using the browser.

Context Navigation

root/library/doc/html/classbdm_1_1UI.html @ 591

Download in other formats: