root/doc/xml/classRootElement.xml @ 235

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
  <compounddef id="classRootElement" kind="class" prot="public">
    <compoundname>RootElement</compoundname>
    <includes refid="userinfo_8h" local="no">userinfo.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classRootElement_19ad71509b6a6fc1c5a6269f20d6f0d7a" prot="private" static="no" mutable="no">
        <type>const <ref refid="classAssertXercesIsAlive" kindref="compound">AssertXercesIsAlive</ref></type>
        <definition>const AssertXercesIsAlive RootElement::dummy</definition>
        <argsstring></argsstring>
        <name>dummy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>This private attribute has to be declared as the first attribute in the class. Only this way we can be sure it&apos;s constructor is called as the first and thus Xerces is initialized properly and right on time </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="582" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="582" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classRootElement_19402605c1fc9d343e6b042c397df3f4c" prot="private" static="no" mutable="no">
        <type>DOMDocument *</type>
        <definition>DOMDocument* RootElement::pDoc</definition>
        <argsstring></argsstring>
        <name>pDoc</name>
        <briefdescription>
<para>DOMDocument containing the root element this instance is associated to. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="585" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="585" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classRootElement_14829b8c8b5c3485033e6bc02dbd8775d" prot="private" static="no" mutable="no">
        <type>const XMLCh *const</type>
        <definition>const XMLCh* const RootElement::transcodedFileName</definition>
        <argsstring></argsstring>
        <name>transcodedFileName</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="587" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="587" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classRootElement_1ba44e86a811d86f51b7da8d3d995faf4" prot="private" static="no" mutable="no">
        <type>DOMImplementation *</type>
        <definition>DOMImplementation* RootElement::pImplementation</definition>
        <argsstring></argsstring>
        <name>pImplementation</name>
        <briefdescription>
<para>DOMImplementation is a base class for the all DOM oparations. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="590" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="590" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classRootElement_138d5457ac80a4c7337a72cae16547609" prot="private" static="no" mutable="no">
        <type>DOMWriter *</type>
        <definition>DOMWriter* RootElement::pSerializer</definition>
        <argsstring></argsstring>
        <name>pSerializer</name>
        <briefdescription>
<para>This DOMWriter is used to export internal data into xml file. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="593" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="593" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classRootElement_143ee507bba02fd893126062a9dff0683" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void RootElement::Clean</definition>
        <argsstring>()</argsstring>
        <name>Clean</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="595" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="106" bodyend="112"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classRootElement_125cd0a3019e91c5bbe8bc09cdf6e61aa" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>RootElement::RootElement</definition>
        <argsstring>(char *fileName)</argsstring>
        <name>RootElement</name>
        <param>
          <type>char *</type>
          <declname>fileName</declname>
        </param>
        <briefdescription>
<para>attach new <ref refid="classRootElement" kindref="compound">RootElement</ref> instance to a file (typically with an XML extension) </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="599" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="79" bodyend="95"/>
      </memberdef>
      <memberdef kind="function" id="classRootElement_12ca3893547fd56ceb30536210ceecf29" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>RootElement::~RootElement</definition>
        <argsstring>()</argsstring>
        <name>~RootElement</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="601" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="97" bodyend="104"/>
      </memberdef>
      <memberdef kind="function" id="classRootElement_1888749537060fd60a939486cd2e73b9b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>bool</type>
        <definition>bool RootElement::Load</definition>
        <argsstring>(void)</argsstring>
        <name>Load</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>this method loads root element and all its subnodes from the attached file </para>        </briefdescription>
        <detaileddescription>
<para>loads root element from a file </para>        </detaileddescription>
        <inbodydescription>
<para>This DOMWriter is used to import external data from xml files </para>        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="604" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="115" bodyend="139"/>
      </memberdef>
      <memberdef kind="function" id="classRootElement_15ce717e64c3b7be09f695e6ede6294db" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void RootElement::Save</definition>
        <argsstring>(void)</argsstring>
        <name>Save</name>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
<para>this method saves all the previsoulsy attached DOMElements into the file </para>        </briefdescription>
        <detaileddescription>
<para>Save <ref refid="classUserInfo" kindref="compound">UserInfo</ref> to the file (typically with an XML extension). </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="607" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="143" bodyend="147"/>
      </memberdef>
      <memberdef kind="function" id="classRootElement_19ad2ae1c73d73b06bc98afa0f32d9ad3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>RootElement::operator DOMElement &amp;</definition>
        <argsstring>()</argsstring>
        <name>operator DOMElement &amp;</name>
        <briefdescription>
<para>this operator allows to use a <ref refid="classRootElement" kindref="compound">RootElement</ref> instance whenever a DOMElement variable is accepted </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="610" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="149" bodyend="152"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>This class serves to load and/or save DOMElements into/from files stored on a hard-disk. </para>    </briefdescription>
    <detaileddescription>
<para>Firstly, you associate new <ref refid="classRootElement" kindref="compound">RootElement</ref> instance with some filename during a time of its construtcion. Then, you disassembly some object into the new <ref refid="classRootElement" kindref="compound">RootElement</ref> instance, and save it into the file this way: <programlisting><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>CAudi<sp/>audi;</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classRootElement" kindref="compound" tooltip="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</ref><sp/>root(</highlight><highlight class="stringliteral">&quot;cars.xml&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classUserInfo_11d402661b82feccb5265a70f65c242e1" kindref="member">UserInfo::Disassembly</ref>(<sp/>audi,<sp/>root,<sp/></highlight><highlight class="stringliteral">&quot;TT&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>root.Save();</highlight></codeline>
</programlisting></para><para>In the other way round, when loading object from a XML file, the appropriate code looks like this: <programlisting><codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classRootElement" kindref="compound" tooltip="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">RootElement</ref><sp/>root(</highlight><highlight class="stringliteral">&quot;cars.xml&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>root.Load();</highlight></codeline>
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>UserInfo::Assembly&lt;T&gt;(root,</highlight><highlight class="stringliteral">&quot;TT&quot;</highlight><highlight class="normal">);</highlight></codeline>
</programlisting> </para>    </detaileddescription>
    <collaborationgraph>
      <node id="1287">
        <label>AssertXercesIsAlive</label>
        <link refid="classAssertXercesIsAlive"/>
      </node>
      <node id="1286">
        <label>RootElement</label>
        <link refid="classRootElement"/>
        <childnode refid="1287" relation="usage">
          <edgelabel>dummy</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="577" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="576" bodyend="611"/>
    <listofallmembers>
      <member refid="classRootElement_143ee507bba02fd893126062a9dff0683" prot="private" virt="non-virtual"><scope>RootElement</scope><name>Clean</name></member>
      <member refid="classRootElement_19ad71509b6a6fc1c5a6269f20d6f0d7a" prot="private" virt="non-virtual"><scope>RootElement</scope><name>dummy</name></member>
      <member refid="classRootElement_1888749537060fd60a939486cd2e73b9b" prot="public" virt="non-virtual"><scope>RootElement</scope><name>Load</name></member>
      <member refid="classRootElement_19ad2ae1c73d73b06bc98afa0f32d9ad3" prot="public" virt="non-virtual"><scope>RootElement</scope><name>operator DOMElement &amp;</name></member>
      <member refid="classRootElement_19402605c1fc9d343e6b042c397df3f4c" prot="private" virt="non-virtual"><scope>RootElement</scope><name>pDoc</name></member>
      <member refid="classRootElement_1ba44e86a811d86f51b7da8d3d995faf4" prot="private" virt="non-virtual"><scope>RootElement</scope><name>pImplementation</name></member>
      <member refid="classRootElement_138d5457ac80a4c7337a72cae16547609" prot="private" virt="non-virtual"><scope>RootElement</scope><name>pSerializer</name></member>
      <member refid="classRootElement_125cd0a3019e91c5bbe8bc09cdf6e61aa" prot="public" virt="non-virtual"><scope>RootElement</scope><name>RootElement</name></member>
      <member refid="classRootElement_15ce717e64c3b7be09f695e6ede6294db" prot="public" virt="non-virtual"><scope>RootElement</scope><name>Save</name></member>
      <member refid="classRootElement_14829b8c8b5c3485033e6bc02dbd8775d" prot="private" virt="non-virtual"><scope>RootElement</scope><name>transcodedFileName</name></member>
      <member refid="classRootElement_12ca3893547fd56ceb30536210ceecf29" prot="public" virt="non-virtual"><scope>RootElement</scope><name>~RootElement</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>