root/doc/latex/classRootElement.tex @ 172

\hypertarget{classRootElement}{
\section{RootElement Class Reference}
\label{classRootElement}\index{RootElement@{RootElement}}
}
This class serves to load and/or save DOMElements into/from files stored on a hard-disk.  


{\tt \#include $<$userinfo.h$>$}

Collaboration diagram for RootElement:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=76pt]{classRootElement__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classRootElement_6238814d4d806101cf54c6d803aac46c}{
\hyperlink{classRootElement_6238814d4d806101cf54c6d803aac46c}{RootElement} (const char $\ast$fileName)}
\label{classRootElement_6238814d4d806101cf54c6d803aac46c}

\begin{CompactList}\small\item\em attach new \hyperlink{classRootElement}{RootElement} instance to a file (typically with an XML extension) \item\end{CompactList}\item 
bool \hyperlink{classRootElement_888749537060fd60a939486cd2e73b9b}{Load} (void)
\begin{CompactList}\small\item\em this method loads root element and all its subnodes from the attached file \item\end{CompactList}\item 
void \hyperlink{classRootElement_5ce717e64c3b7be09f695e6ede6294db}{Save} (void)
\begin{CompactList}\small\item\em this method saves all the previsoulsy attached DOMElements into the file \item\end{CompactList}\item 
\hypertarget{classRootElement_9ad2ae1c73d73b06bc98afa0f32d9ad3}{
\hyperlink{classRootElement_9ad2ae1c73d73b06bc98afa0f32d9ad3}{operator DOMElement \&} ()}
\label{classRootElement_9ad2ae1c73d73b06bc98afa0f32d9ad3}

\begin{CompactList}\small\item\em this operator allows to use a \hyperlink{classRootElement}{RootElement} instance whenever a DOMElement variable is accepted \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
This class serves to load and/or save DOMElements into/from files stored on a hard-disk. 

Firstly, you associate new \hyperlink{classRootElement}{RootElement} instance with some filename during a time of its construtcion. Then, you disassembly some object into the new \hyperlink{classRootElement}{RootElement} instance, and save it into the file this way: 

\begin{Code}\begin{verbatim}        CAudi audi;
        RootElement root("cars.xml");
        UserInfo::Disassembly( audi, root, "TT");
        root.Save();
\end{verbatim}
\end{Code}



In the other way round, when loading object from a XML file, the appropriate code looks like this: 

\begin{Code}\begin{verbatim}        RootElement root("cars.xml");
        root.Load();
        UserInfo::Assembly<T>(root,"TT");
\end{verbatim}
\end{Code}

 

\subsection{Member Function Documentation}
\hypertarget{classRootElement_888749537060fd60a939486cd2e73b9b}{
\index{RootElement@{RootElement}!Load@{Load}}
\index{Load@{Load}!RootElement@{RootElement}}
\subsubsection[Load]{\setlength{\rightskip}{0pt plus 5cm}bool RootElement::Load (void)}}
\label{classRootElement_888749537060fd60a939486cd2e73b9b}


this method loads root element and all its subnodes from the attached file 

loads root element from a file 

This DOMWriter is used to import external data from xml files \hypertarget{classRootElement_5ce717e64c3b7be09f695e6ede6294db}{
\index{RootElement@{RootElement}!Save@{Save}}
\index{Save@{Save}!RootElement@{RootElement}}
\subsubsection[Save]{\setlength{\rightskip}{0pt plus 5cm}void RootElement::Save (void)}}
\label{classRootElement_5ce717e64c3b7be09f695e6ede6294db}


this method saves all the previsoulsy attached DOMElements into the file 

Save \hyperlink{classUserInfo}{UserInfo} to the file (typically with an XML extension). 

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
work/git/mixpp/bdm/userinfo.h\item 
work/git/mixpp/bdm/userinfo.cpp\end{CompactItemize}