Context Navigation

classbdm_1_1ParticularUI.html @ 460

Revision 401, 19.8 kB (checked in by smidl, 16 years ago)
doc

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.8 -->
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><a href="modules.html"><span>Modules</span></a></li>
55	<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56	<li><a href="files.html"><span>Files</span></a></li>
57	</ul>
58	</div>
59	<div class="tabs">
60	<ul>
61	<li><a href="annotated.html"><span>Class List</span></a></li>
62	<li><a href="classes.html"><span>Class Index</span></a></li>
63	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
64	<li><a href="functions.html"><span>Class Members</span></a></li>
65	</ul>
66	</div>
67	<div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>
68	</div>
69	</div>
70	<div class="contents">
71	<h1>bdm::ParticularUI< T > Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" -->The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a> macro only.
72	<a href="#_details">More...</a>
73	<p>
74	<code>#include <<a class="el" href="user__info_8h-source.html">user_info.h</a>></code>
75	<p>
76
77	<p>
78	<a href="classbdm_1_1ParticularUI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79	<tr><td></td></tr>
80	<tr><td colspan="2"><br><h2>Public Member Functions</h2></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 construcotor in class T. <br></td></tr>
85	<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
86	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18a208b7549160ae6aeb884dc2bcd90f"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="18a208b7549160ae6aeb884dc2bcd90f" args="" -->
87	static const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#18a208b7549160ae6aeb884dc2bcd90f">factory</a></td></tr>
88
89	<tr><td class="mdescLeft"> </td><td class="mdescRight">The only instance of this class (each type T has its own instance) which is used as a factory for processing related <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a>. <br></td></tr>
90	<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr>
91	<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr>
92	<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.">root</a> descendant class <br><br></div></td></tr>
93	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="dda27449f8bd19d54db9ccfb2644e908"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="dda27449f8bd19d54db9ccfb2644e908" args="(const Setting &element, const string &name)" -->
94	template<class T > </td></tr>
95	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#dda27449f8bd19d54db9ccfb2644e908">build</a> (const Setting &element, const string &name)</td></tr>
96
97	<tr><td class="mdescLeft"> </td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[name]. <br></td></tr>
98	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &element, const int index)" -->
99	template<class T > </td></tr>
100	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f0eccc7bbe4b680f3e1cb84b455a1125">build</a> (const Setting &element, const int index)</td></tr>
101
102	<tr><td class="mdescLeft"> </td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[index]. <br></td></tr>
103	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6e2da6a142fecf5f21e0bb86a7211cb4"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="6e2da6a142fecf5f21e0bb86a7211cb4" args="(const Setting &element)" -->
104	template<class T > </td></tr>
105	<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6e2da6a142fecf5f21e0bb86a7211cb4">build</a> (const Setting &element)</td></tr>
106
107	<tr><td class="mdescLeft"> </td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element. <br></td></tr>
108	<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr>
109	<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>
110	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="652bfd23f5052e4f1cb317057d74a3e2"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="652bfd23f5052e4f1cb317057d74a3e2" args="(T &instance, const Setting &element, const string &name)" -->
111	template<class T > </td></tr>
112	<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#652bfd23f5052e4f1cb317057d74a3e2">get</a> (T &instance, const Setting &element, const string &name)</td></tr>
113
114	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[name]. <br></td></tr>
115	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3d04bb3d7dbcf0da0b4d5d3d5b7df51a"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="3d04bb3d7dbcf0da0b4d5d3d5b7df51a" args="(T &instance, const Setting &element, const int index)" -->
116	template<class T > </td></tr>
117	<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#3d04bb3d7dbcf0da0b4d5d3d5b7df51a">get</a> (T &instance, const Setting &element, const int index)</td></tr>
118
119	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[index]. <br></td></tr>
120	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="25747ac6d0232aa7102dbb316f65ddce"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="25747ac6d0232aa7102dbb316f65ddce" args="(T &instance, const Setting &element)" -->
121	template<class T > </td></tr>
122	<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#25747ac6d0232aa7102dbb316f65ddce">get</a> (T &instance, const Setting &element)</td></tr>
123
124	<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>
125	<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array<T></div></td></tr>
126	<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>
127	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00bb5f2a328d272b0a3ffbda1a902d54"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="00bb5f2a328d272b0a3ffbda1a902d54" args="(Array< T > &array_to_load, const Setting &element, const string &name)" -->
128	template<class T > </td></tr>
129	<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#00bb5f2a328d272b0a3ffbda1a902d54">get</a> (Array< T > &array_to_load, const Setting &element, const string &name)</td></tr>
130
131	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[name]. <br></td></tr>
132	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b6a224b6aea027e167d3d565b39144e0"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="b6a224b6aea027e167d3d565b39144e0" args="(Array< T > &array_to_load, const Setting &element, const int index)" -->
133	template<class T > </td></tr>
134	<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#b6a224b6aea027e167d3d565b39144e0">get</a> (Array< T > &array_to_load, const Setting &element, const int index)</td></tr>
135
136	<tr><td class="mdescLeft"> </td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[index]. <br></td></tr>
137	<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4fc5efdc58e4e184218b6d5beeb5ceab"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="4fc5efdc58e4e184218b6d5beeb5ceab" args="(Array< T > &array_to_load, const Setting &element)" -->
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#4fc5efdc58e4e184218b6d5beeb5ceab">get</a> (Array< T > &array_to_load, const Setting &element)</td></tr>
140
141	<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>
142	<tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr>
143	<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>
144	<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="")" -->
145	template<class T > </td></tr>
146	<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>
147
148	<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>
149	<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="")" -->
150	template<class T > </td></tr>
151	<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>
152
153	<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>
154	<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="")" -->
155	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>
156
157	<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>
158	<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="")" -->
159	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>
160
161	<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>
162	<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="")" -->
163	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>
164
165	<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>
166	<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="")" -->
167	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>
168
169	<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>
170	<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="")" -->
171	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>
172
173	<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>
174	<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="")" -->
175	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>
176
177	<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>
178	</table>
179	<hr><a name="_details"></a><h2>Detailed Description</h2>
180	<h3>template<typename T><br>
181	class bdm::ParticularUI< T ></h3>
182
183	The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a> macro only. <hr>The documentation for this class was generated from the following file:<ul>
184	<li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul>
185	</div>
186	<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by
187	<a href="http://www.doxygen.org/index.html">
188	<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
189	</body>
190	</html>

Note: See TracBrowser for help on using the browser.

Context Navigation

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

Download in other formats: