| 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 | <title>mixpp: bdm::ParticularUI< T > Class Template Reference</title> |
|---|
| 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 --> |
|---|
| 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_1ParticularUI.html">ParticularUI</a> |
|---|
| 70 | </div> |
|---|
| 71 | </div> |
|---|
| 72 | <div class="contents"> |
|---|
| 73 | <h1>bdm::ParticularUI< T > Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><hr/><a name="_details"></a><h2>Detailed Description</h2> |
|---|
| 74 | <h3>template<typename T><br/> |
|---|
| 75 | class bdm::ParticularUI< T ></h3> |
|---|
| 76 | |
|---|
| 77 | <p>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.html">User Infos and their use</a> </p> |
|---|
| 78 | |
|---|
| 79 | <p><code>#include <<a class="el" href="user__info_8h_source.html">user_info.h</a>></code></p> |
|---|
| 80 | |
|---|
| 81 | <p><a href="classbdm_1_1ParticularUI-members.html">List of all members.</a></p> |
|---|
| 82 | <table border="0" cellpadding="0" cellspacing="0"> |
|---|
| 83 | <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
|---|
| 84 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a75820d3cad5d2034f25b2252ce6be7"></a><!-- doxytag: member="bdm::ParticularUI::ParticularUI" ref="a3a75820d3cad5d2034f25b2252ce6be7" args="(const string &class_name)" --> |
|---|
| 85 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#a3a75820d3cad5d2034f25b2252ce6be7">ParticularUI</a> (const string &class_name)</td></tr> |
|---|
| 86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor used by the UIREGISTER macro. <br/></td></tr> |
|---|
| 87 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa14fea8c7372a3d0a736e4ed0b617702"></a><!-- doxytag: member="bdm::ParticularUI::new_instance" ref="aa14fea8c7372a3d0a736e4ed0b617702" args="() const " --> |
|---|
| 88 | <a class="el" href="classbdm_1_1root.html">root</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#aa14fea8c7372a3d0a736e4ed0b617702">new_instance</a> () const </td></tr> |
|---|
| 89 | <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> |
|---|
| 90 | <tr><td colspan="2"><h2>Private Types</h2></td></tr> |
|---|
| 91 | <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>, |
|---|
| 92 | <b>compulsory</b> |
|---|
| 93 | }</td></tr> |
|---|
| 94 | <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> |
|---|
| 95 | <br/></td></tr> |
|---|
| 96 | <tr><td colspan="2"><h2>Static Private Member Functions</h2></td></tr> |
|---|
| 97 | <tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> |
|---|
| 98 | <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> |
|---|
| 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 <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> |
|---|
| 102 | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
|---|
| 103 | <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> |
|---|
| 104 | <tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> |
|---|
| 105 | <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> |
|---|
| 106 | <br/><br/></div></td></tr> |
|---|
| 107 | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
|---|
| 108 | <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> |
|---|
| 109 | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
|---|
| 110 | <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> |
|---|
| 111 | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="a7d2ea138c7285565507fa61fbd9b038f" args="(T &instance, const Setting &element)" --> |
|---|
| 112 | template<class T > </td></tr> |
|---|
| 113 | <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> |
|---|
| 114 | <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> |
|---|
| 115 | <tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array<T></div></td></tr> |
|---|
| 116 | <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> |
|---|
| 117 | <br/><br/></div></td></tr> |
|---|
| 118 | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
|---|
| 119 | <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> |
|---|
| 120 | <tr><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
|---|
| 121 | <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> |
|---|
| 122 | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="ac9fad8376d2f0857e719511f92f93998" args="(Array< T > &array_to_load, const Setting &element)" --> |
|---|
| 123 | template<class T > </td></tr> |
|---|
| 124 | <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> |
|---|
| 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"><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> |
|---|
| 128 | <br/><br/></div></td></tr> |
|---|
| 129 | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="ac83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &element, const string &name="")" --> |
|---|
| 130 | template<class T > </td></tr> |
|---|
| 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#ac83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &element, const string &name="")</td></tr> |
|---|
| 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" colspan="2"><a class="anchor" id="a7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7a307cd313e516b6d5629046dd321039" args="(const shared_ptr< T > &instance, Setting &element, const string &name="")" --> |
|---|
| 134 | template<class T > </td></tr> |
|---|
| 135 | <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> |
|---|
| 136 | <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a4514f93573a9d9126c506d176fbd3163" args="(const Array< T > &array_to_save, Setting &element, const string &name="")" --> |
|---|
| 137 | template<class T > </td></tr> |
|---|
| 138 | <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> |
|---|
| 139 | <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> |
|---|
| 140 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a42e908a4f1b09d701be69c8784a02df7" args="(const mat &matrix, Setting &element, const string &name="")" --> |
|---|
| 141 | 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> |
|---|
| 142 | <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> |
|---|
| 143 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="acc2afb61a772d8571f7bb19065da4695" args="(const ivec &vec, Setting &element, const string &name="")" --> |
|---|
| 144 | 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> |
|---|
| 145 | <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> |
|---|
| 146 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &vector, Setting &element, const string &name="")" --> |
|---|
| 147 | 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> |
|---|
| 148 | <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> |
|---|
| 149 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7c822efd5f8550480d0756352d430c05" args="(const string &str, Setting &element, const string &name="")" --> |
|---|
| 150 | 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> |
|---|
| 151 | <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> |
|---|
| 152 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a8cd58216bcd732856846d18503c92d48" args="(const int &integer, Setting &element, const string &name="")" --> |
|---|
| 153 | 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> |
|---|
| 154 | <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> |
|---|
| 155 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &real, Setting &element, const string &name="")" --> |
|---|
| 156 | 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> |
|---|
| 157 | <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> |
|---|
| 158 | </table> |
|---|
| 159 | <hr/>The documentation for this class was generated from the following file:<ul> |
|---|
| 160 | <li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> |
|---|
| 161 | </ul> |
|---|
| 162 | </div> |
|---|
| 163 | <hr size="1"/><address style="text-align: right;"><small>Generated on Thu Oct 15 00:07:49 2009 for mixpp by |
|---|
| 164 | <a href="http://www.doxygen.org/index.html"> |
|---|
| 165 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
|---|
| 166 | </body> |
|---|
| 167 | </html> |
|---|
