root/doc/html/classRootElement.html @ 261

Revision 261, 8.0 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: 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><a href="modules.html"><span>Modules</span></a></li>
14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
27</div>
28<div class="contents">
29<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. 
30<a href="#_details">More...</a>
31<p>
32<code>#include &lt;<a class="el" href="userinfo_8h-source.html">userinfo.h</a>&gt;</code>
33<p>
34<div class="dynheader">
35Collaboration diagram for RootElement:</div>
36<div class="dynsection">
37<p><center><img src="classRootElement__coll__graph.png" border="0" usemap="#RootElement__coll__map" alt="Collaboration graph"></center>
38<map name="RootElement__coll__map">
39<area shape="rect" href="classAssertXercesIsAlive.html" title="Class initializing Xerces library." alt="" coords="5,7,149,33"></map>
40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41
42<p>
43<a href="classRootElement-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
44<tr><td></td></tr>
45<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
46<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)" -->
47&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#6238814d4d806101cf54c6d803aac46c">RootElement</a> (const char *fileName)</td></tr>
48
49<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>
50<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>
51
52<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>
53<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>
54
55<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>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ad2ae1c73d73b06bc98afa0f32d9ad3"></a><!-- doxytag: member="RootElement::operator DOMElement &amp;" ref="9ad2ae1c73d73b06bc98afa0f32d9ad3" args="()" -->
57&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRootElement.html#9ad2ae1c73d73b06bc98afa0f32d9ad3">operator DOMElement &amp;</a> ()</td></tr>
58
59<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>
60</table>
61<hr><a name="_details"></a><h2>Detailed Description</h2>
62This class serves to load and/or save DOMElements into/from files stored on a hard-disk.
63<p>
64Firstly, 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;
65        <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>);
66        <a class="code" href="classUserInfo.html#1d402661b82feccb5265a70f65c242e1">UserInfo::Disassembly</a>( audi, root, <span class="stringliteral">"TT"</span>);
67        root.Save();
68</pre></div><p>
69In 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>);
70        root.Load();
71        UserInfo::Assembly&lt;T&gt;(root,<span class="stringliteral">"TT"</span>);
72</pre></div> <hr><h2>Member Function Documentation</h2>
73<a class="anchor" name="888749537060fd60a939486cd2e73b9b"></a><!-- doxytag: member="RootElement::Load" ref="888749537060fd60a939486cd2e73b9b" args="(void)" -->
74<div class="memitem">
75<div class="memproto">
76      <table class="memname">
77        <tr>
78          <td class="memname">bool RootElement::Load           </td>
79          <td>(</td>
80          <td class="paramtype">void&nbsp;</td>
81          <td class="paramname">          </td>
82          <td>&nbsp;)&nbsp;</td>
83          <td></td>
84        </tr>
85      </table>
86</div>
87<div class="memdoc">
88
89<p>
90this method loads root element and all its subnodes from the attached file
91<p>
92loads root element from a file
93<p>
94This DOMWriter is used to import external data from xml files
95</div>
96</div><p>
97<a class="anchor" name="5ce717e64c3b7be09f695e6ede6294db"></a><!-- doxytag: member="RootElement::Save" ref="5ce717e64c3b7be09f695e6ede6294db" args="(void)" -->
98<div class="memitem">
99<div class="memproto">
100      <table class="memname">
101        <tr>
102          <td class="memname">void RootElement::Save           </td>
103          <td>(</td>
104          <td class="paramtype">void&nbsp;</td>
105          <td class="paramname">          </td>
106          <td>&nbsp;)&nbsp;</td>
107          <td></td>
108        </tr>
109      </table>
110</div>
111<div class="memdoc">
112
113<p>
114this method saves all the previsoulsy attached DOMElements into the file
115<p>
116Save <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).
117</div>
118</div><p>
119<hr>The documentation for this class was generated from the following files:<ul>
120<li><a class="el" href="userinfo_8h-source.html">userinfo.h</a><li>userinfo.cpp</ul>
121</div>
122<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 15:29:49 2009 for mixpp by&nbsp;
123<a href="http://www.doxygen.org/index.html">
124<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
125</body>
126</html>
Note: See TracBrowser for help on using the browser.