Context Navigation

classbdm_1_1ParticularUI.html @ 651

Revision 651, 17.9 kB (checked in by mido, 15 years ago)
\doc directory cleaned a bit

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2	<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3	<title>mixpp: bdm::ParticularUI< T > Class Template Reference</title>
4	<link href="tabs.css" rel="stylesheet" type="text/css">
5	<link href="doxygen.css" rel="stylesheet" type="text/css">
6	</head><body>
7	<!-- Generated by Doxygen 1.5.9 -->
8	<script type="text/javascript">
9	<!--
10	function changeDisplayState (e){
11	var num=this.id.replace(/[^[0-9]/g,'');
12	var button=this.firstChild;
13	var sectionDiv=document.getElementById('dynsection'+num);
14	if (sectionDiv.style.display=='none'\|\|sectionDiv.style.display==''){
15	sectionDiv.style.display='block';
16	button.src='open.gif';
17	}else{
18	sectionDiv.style.display='none';
19	button.src='closed.gif';
20	}
21	}
22	function initDynSections(){
23	var divs=document.getElementsByTagName('div');
24	var sectionCounter=1;
25	for(var i=0;i<divs.length-1;i++){
26	if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27	var header=divs[i];
28	var section=divs[i+1];
29	var button=header.firstChild;
30	if (button!='IMG'){
31	divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32	button=document.createElement('img');
33	divs[i].insertBefore(button,divs[i].firstChild);
34	}
35	header.style.cursor='pointer';
36	header.onclick=changeDisplayState;
37	header.id='dynheader'+sectionCounter;
38	button.src='closed.gif';
39	section.id='dynsection'+sectionCounter;
40	section.style.display='none';
41	section.style.marginLeft='14px';
42	sectionCounter++;
43	}
44	}
45	}
46	window.onload = initDynSections;
47	-->
48	</script>
49	<div class="navigation" id="top">
50	<div class="tabs">
51	<ul>
52	<li><a href="main.html"><span>Main Page</span></a></li>
53	<li><a href="pages.html"><span>Related Pages</span></a></li>
54	<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55	<li><a href="files.html"><span>Files</span></a></li>
56	</ul>
57	</div>
58	<div class="tabs">
59	<ul>
60	<li><a href="annotated.html"><span>Class List</span></a></li>
61	<li><a href="classes.html"><span>Class Index</span></a></li>
62	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
63	<li><a href="functions.html"><span>Class Members</span></a></li>
64	</ul>
65	</div>
66	<div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>
67	</div>
68	</div>
69	<div class="contents">
70	<h1>bdm::ParticularUI< T > Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><code>#include <<a class="el" href="user__info_8h_source.html">user_info.h</a>></code>
71	<p>
72
73	<p>
74	<a href="classbdm_1_1ParticularUI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
75	<tr><td></td></tr>
76	<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
77	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a75820d3cad5d2034f25b2252ce6be7"></a><!-- doxytag: member="bdm::ParticularUI::ParticularUI" ref="3a75820d3cad5d2034f25b2252ce6be7" args="(const string &class_name)" -->
78	</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#3a75820d3cad5d2034f25b2252ce6be7">ParticularUI</a> (const string &class_name)</td></tr>
79
80	<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor used by the UIREGISTER macro. <br></td></tr>
81	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14fea8c7372a3d0a736e4ed0b617702"></a><!-- doxytag: member="bdm::ParticularUI::new_instance" ref="a14fea8c7372a3d0a736e4ed0b617702" args="() const " -->
82	<a class="el" href="classbdm_1_1root.html">root</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#a14fea8c7372a3d0a736e4ed0b617702">new_instance</a> () const </td></tr>
83
84	<tr><td class="mdescLeft"> </td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless constructor in class T. <br></td></tr>
85	<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
86	<tr><td class="memItemLeft" nowrap align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>,
87	<b>compulsory</b>
88	}</td></tr>
89
90	<tr><td class="mdescLeft"> </td><td class="mdescRight">Enum type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr>
91	<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr>
92	<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr>
93	<tr><td colspan="2"><div class="groupText">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 <br><br></div></td></tr>
94	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
95	<tr><td class="memTemplItemLeft" nowrap 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#1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
96
97	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
98	<tr><td class="memTemplItemLeft" nowrap 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#f02851b299aedeb891e30c4807903081">build</a> (const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
99
100	<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr>
101	<tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat. <br><br></div></td></tr>
102	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
103	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &instance, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
104
105	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
106	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &instance, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
107
108	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="7d2ea138c7285565507fa61fbd9b038f" args="(T &instance, const Setting &element)" -->
109	template<class T > </td></tr>
110	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7d2ea138c7285565507fa61fbd9b038f">get</a> (T &instance, const Setting &element)</td></tr>
111
112	<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>
113	<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array<T></div></td></tr>
114	<tr><td colspan="2"><div class="groupText">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. <br><br></div></td></tr>
115	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
116	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#81ce18ed0bb9993a634db2b99612ad66">get</a> (Array< T > &array_to_load, const Setting &element, const string &name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
117
118	<tr><td class="memTemplParams" nowrap colspan="2">template<class T > </td></tr>
119	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#29e450ed5560f81ef2f845e7b1021b71">get</a> (Array< T > &array_to_load, const Setting &element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr>
120
121	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="c9fad8376d2f0857e719511f92f93998" args="(Array< T > &array_to_load, const Setting &element)" -->
122	template<class T > </td></tr>
123	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#c9fad8376d2f0857e719511f92f93998">get</a> (Array< T > &array_to_load, const Setting &element)</td></tr>
124
125	<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>
126	<tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr>
127	<tr><td colspan="2"><div class="groupText">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. <br><br></div></td></tr>
128	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="c83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &element, const string &name="")" -->
129	template<class T > </td></tr>
130	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#c83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &element, const string &name="")</td></tr>
131
132	<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>
133	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7a307cd313e516b6d5629046dd321039" args="(const shared_ptr< T > &instance, Setting &element, const string &name="")" -->
134	template<class T > </td></tr>
135	<tr><td class="memTemplItemLeft" nowrap 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>
136
137	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="4514f93573a9d9126c506d176fbd3163" args="(const Array< T > &array_to_save, Setting &element, const string &name="")" -->
138	template<class T > </td></tr>
139	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4514f93573a9d9126c506d176fbd3163">save</a> (const Array< T > &array_to_save, Setting &element, const string &name="")</td></tr>
140
141	<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>
142	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="42e908a4f1b09d701be69c8784a02df7" args="(const mat &matrix, Setting &element, const string &name="")" -->
143	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &matrix, Setting &element, const string &name="")</td></tr>
144
145	<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>
146	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &vec, Setting &element, const string &name="")" -->
147	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &vec, Setting &element, const string &name="")</td></tr>
148
149	<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>
150	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &vector, Setting &element, const string &name="")" -->
151	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &vector, Setting &element, const string &name="")</td></tr>
152
153	<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>
154	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7c822efd5f8550480d0756352d430c05" args="(const string &str, Setting &element, const string &name="")" -->
155	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c822efd5f8550480d0756352d430c05">save</a> (const string &<a class="el" href="classbdm_1_1str.html">str</a>, Setting &element, const string &name="")</td></tr>
156
157	<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>
158	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="8cd58216bcd732856846d18503c92d48" args="(const int &integer, Setting &element, const string &name="")" -->
159	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#8cd58216bcd732856846d18503c92d48">save</a> (const int &integer, Setting &element, const string &name="")</td></tr>
160
161	<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>
162	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &real, Setting &element, const string &name="")" -->
163	static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &real, Setting &element, const string &name="")</td></tr>
164
165	<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>
166	</table>
167	<hr><a name="_details"></a><h2>Detailed Description</h2>
168	<h3>template<typename T><br>
169	class bdm::ParticularUI< T ></h3>
170
171	The only <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> descendant class which is not intended for direct use. It should be accessed within the UIREGISTER macro only. <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following file:<ul>
172	<li><a class="el" href="user__info_8h_source.html">user_info.h</a></ul>
173	</div>
174	<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by
175	<a href="http://www.doxygen.org/index.html">
176	<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
177	</body>
178	</html>

Note: See TracBrowser for help on using the browser.

Context Navigation

root/library/doc/html/classbdm_1_1ParticularUI.html @ 651

Download in other formats: