root/doc/html/classRootElement.html @ 187

Revision 181, 7.8 kB (checked in by smidl, 16 years ago)

Regenerated 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: RootElement Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>RootElement Class Reference</h1><!-- doxytag: class="RootElement" -->This class serves to load and/or save DOMElements into/from files stored on a hard-disk. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="userinfo_8h-source.html">userinfo.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Collaboration diagram for RootElement:</div>
33<div class="dynsection">
34<p><center><img src="classRootElement__coll__graph.png" border="0" usemap="#RootElement__coll__map" alt="Collaboration graph"></center>
35<map name="RootElement__coll__map">
36<area shape="rect" href="classAssertXercesIsAlive.html" title="Class initializing Xerces library." alt="" coords="5,7,149,33"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38
39<p>
40<a href="classRootElement-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
41<tr><td></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6238814d4d806101cf54c6d803aac46c"></a><!-- doxytag: member="RootElement::RootElement" ref="6238814d4d806101cf54c6d803aac46c" args="(const char *fileName)" -->
44&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#6238814d4d806101cf54c6d803aac46c">RootElement</a> (const char *fileName)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">attach new <a class="el" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> instance to a file (typically with an XML extension) <br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#888749537060fd60a939486cd2e73b9b">Load</a> (void)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this method loads root element and all its subnodes from the attached file  <a href="#888749537060fd60a939486cd2e73b9b"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#5ce717e64c3b7be09f695e6ede6294db">Save</a> (void)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this method saves all the previsoulsy attached DOMElements into the file  <a href="#5ce717e64c3b7be09f695e6ede6294db"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ad2ae1c73d73b06bc98afa0f32d9ad3"></a><!-- doxytag: member="RootElement::operator DOMElement &amp;" ref="9ad2ae1c73d73b06bc98afa0f32d9ad3" args="()" -->
54&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#9ad2ae1c73d73b06bc98afa0f32d9ad3">operator DOMElement &amp;</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this operator allows to use a <a class="el" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> instance whenever a DOMElement variable is accepted <br></td></tr>
57</table>
58<hr><a name="_details"></a><h2>Detailed Description</h2>
59This class serves to load and/or save DOMElements into/from files stored on a hard-disk.
60<p>
61Firstly, you associate new <a class="el" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> instance with some filename during a time of its construtcion. Then, you disassembly some object into the new <a class="el" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> instance, and save it into the file this way: <div class="fragment"><pre class="fragment">        CAudi audi;
62        <a class="code" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> root(<span class="stringliteral">"cars.xml"</span>);
63        <a class="code" href="classUserInfo.html#1d402661b82feccb5265a70f65c242e1">UserInfo::Disassembly</a>( audi, root, <span class="stringliteral">"TT"</span>);
64        root.Save();
65</pre></div><p>
66In the other way round, when loading object from a XML file, the appropriate code looks like this: <div class="fragment"><pre class="fragment">        <a class="code" href="classRootElement.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</a> root(<span class="stringliteral">"cars.xml"</span>);
67        root.Load();
68        UserInfo::Assembly&lt;T&gt;(root,<span class="stringliteral">"TT"</span>);
69</pre></div> <hr><h2>Member Function Documentation</h2>
70<a class="anchor" name="888749537060fd60a939486cd2e73b9b"></a><!-- doxytag: member="RootElement::Load" ref="888749537060fd60a939486cd2e73b9b" args="(void)" -->
71<div class="memitem">
72<div class="memproto">
73      <table class="memname">
74        <tr>
75          <td class="memname">bool RootElement::Load           </td>
76          <td>(</td>
77          <td class="paramtype">void&nbsp;</td>
78          <td class="paramname">          </td>
79          <td>&nbsp;)&nbsp;</td>
80          <td></td>
81        </tr>
82      </table>
83</div>
84<div class="memdoc">
85
86<p>
87this method loads root element and all its subnodes from the attached file
88<p>
89loads root element from a file
90<p>
91This DOMWriter is used to import external data from xml files
92</div>
93</div><p>
94<a class="anchor" name="5ce717e64c3b7be09f695e6ede6294db"></a><!-- doxytag: member="RootElement::Save" ref="5ce717e64c3b7be09f695e6ede6294db" args="(void)" -->
95<div class="memitem">
96<div class="memproto">
97      <table class="memname">
98        <tr>
99          <td class="memname">void RootElement::Save           </td>
100          <td>(</td>
101          <td class="paramtype">void&nbsp;</td>
102          <td class="paramname">          </td>
103          <td>&nbsp;)&nbsp;</td>
104          <td></td>
105        </tr>
106      </table>
107</div>
108<div class="memdoc">
109
110<p>
111this method saves all the previsoulsy attached DOMElements into the file
112<p>
113Save <a class="el" href="classUserInfo.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UserInfo</a> to the file (typically with an XML extension).
114</div>
115</div><p>
116<hr>The documentation for this class was generated from the following files:<ul>
117<li>work/git/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a><li>work/git/mixpp/bdm/userinfo.cpp</ul>
118</div>
119<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:16 2008 for mixpp by&nbsp;
120<a href="http://www.doxygen.org/index.html">
121<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
122</body>
123</html>
Note: See TracBrowser for help on using the browser.