root/doc/latex/classUserInfo.tex @ 162

Revision 162, 6.0 kB (checked in by smidl, 16 years ago)

opravy a dokumentace

Line 
1\section{UserInfo Class Reference}
2\label{classUserInfo}\index{UserInfo@{UserInfo}}
3\doxyref{UserInfo}{p.}{classUserInfo} is an abstract is for internal purposes only. Use CompoundUserInfo$<$T$>$ or ValuedUserInfo$<$T$>$ instead. The raison d'etre of this class is to allow pointers to its templated descendants. 
4
5
6{\tt \#include $<$userinfo.h$>$}
7
8Inheritance diagram for UserInfo:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=400pt]{classUserInfo__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for UserInfo:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=137pt]{classUserInfo__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Static Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\footnotesize template$<$class T$>$ }\\static T $\ast$ {\bf Assembly} (DOMElement \&element, const string tagName)
26\item 
27{\footnotesize template$<$class T$>$ }\\static bool {\bf Disassembly} (T \&instance, DOMElement \&element, const string tagName, const string help)
28\item 
29{\footnotesize template$<$class T$>$ }\\static bool {\bf Disassembly} (T \&instance, DOMElement \&element, const string tagName)
30\end{CompactItemize}
31\subsection*{Protected Member Functions}
32\begin{CompactItemize}
33\item 
34{\bf UserInfo} (const string \&userFriendlyTypeName, const string \&typeNameByRTTI)\label{classUserInfo_0bccb19c6b819cf9f763e985c573ae8f}
35
36\begin{CompactList}\small\item\em default constructor \item\end{CompactList}\item 
37string {\bf XMLCh2str} (const XMLCh $\ast$const XMLCh\_\-str)\label{classBindingFrame_2244bd5181c3d1e70f3a6be2b72e9424}
38
39\begin{CompactList}\small\item\em function which transcodes Xerces' XMLCh-based strings into C++ strings \item\end{CompactList}\item 
40string \textbf{removeSpaces} (const string \&{\bf str})\label{classBindingFrame_820e4df85c0dc545e3079e407fcdbbaa}
41
42\item 
43virtual void {\bf AssemblyComponentsFromXML} (DOMElement \&element)=0\label{classBindingFrame_c6d068c261d4fc3a0a4d1305ade1483d}
44
45\begin{CompactList}\small\item\em This method parse DOMElement, finds proper DOMNode and fills binded data accordingly. \item\end{CompactList}\item 
46virtual void {\bf ReleaseMemory} ()\label{classBindingFrame_8d4dc5902ee71a473983d6a8fa3c8b7a}
47
48\begin{CompactList}\small\item\em A method for releasing memory allocated within the 'AssemblyComponentsFromXML()' method. \item\end{CompactList}\item 
49virtual bool {\bf DisassemblyComponentsToXML} (DOMElement \&element)=0
50\end{CompactItemize}
51\subsection*{Classes}
52\begin{CompactItemize}
53\item 
54class \textbf{StringToUIMap}
55\end{CompactItemize}
56
57
58\subsection{Detailed Description}
59\doxyref{UserInfo}{p.}{classUserInfo} is an abstract is for internal purposes only. Use CompoundUserInfo$<$T$>$ or ValuedUserInfo$<$T$>$ instead. The raison d'etre of this class is to allow pointers to its templated descendants.
60
61Also, the main functions of the whole \doxyref{UserInfo}{p.}{classUserInfo} library are included within this class, see static methods 'Assembly' and 'Disassembly'.
62
63\subsection{Member Function Documentation}
64\index{UserInfo@{UserInfo}!Assembly@{Assembly}}
65\index{Assembly@{Assembly}!UserInfo@{UserInfo}}
66\subsubsection[Assembly]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ static T$\ast$ UserInfo::Assembly (DOMElement \& {\em element}, \/  const string {\em tagName})\hspace{0.3cm}{\tt  [inline, static]}}\label{classUserInfo_0f090c6525a3e8fb11634a553f467ede}
67
68
69This methods tries to assembly a new instance of type T (or some of its descendant types) according to a data stored in a DOMNode named tagName within a child nodes of the passed element. If an error occurs, it returns a NULL pointer.
70
71References Attribute::Get(), and Attribute::type.\index{UserInfo@{UserInfo}!Disassembly@{Disassembly}}
72\index{Disassembly@{Disassembly}!UserInfo@{UserInfo}}
73\subsubsection[Disassembly]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ static bool UserInfo::Disassembly (T \& {\em instance}, \/  DOMElement \& {\em element}, \/  const string {\em tagName}, \/  const string {\em help})\hspace{0.3cm}{\tt  [inline, static]}}\label{classUserInfo_1d402661b82feccb5265a70f65c242e1}
74
75
76This methods tries to disassembly an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according tagName and connecti it to the passed DOMElement as a new child node (with a help attribute filled).
77
78References Attribute::help, Attribute::Set(), and Attribute::type.
79
80Referenced by Disassembly(), and CompoundUserInfo$<$ T $>$::BindedElement$<$ U $>$::DisassemblyComponentsToXML().\index{UserInfo@{UserInfo}!Disassembly@{Disassembly}}
81\index{Disassembly@{Disassembly}!UserInfo@{UserInfo}}
82\subsubsection[Disassembly]{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ static bool UserInfo::Disassembly (T \& {\em instance}, \/  DOMElement \& {\em element}, \/  const string {\em tagName})\hspace{0.3cm}{\tt  [inline, static]}}\label{classUserInfo_917b2257abc31b94c89ef3cd270e4a42}
83
84
85This methods tries to disassembly an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according tagName and connecti it to the passed DOMElement as a new child node.
86
87References Disassembly().\index{UserInfo@{UserInfo}!DisassemblyComponentsToXML@{DisassemblyComponentsToXML}}
88\index{DisassemblyComponentsToXML@{DisassemblyComponentsToXML}!UserInfo@{UserInfo}}
89\subsubsection[DisassemblyComponentsToXML]{\setlength{\rightskip}{0pt plus 5cm}virtual bool BindingFrame::DisassemblyComponentsToXML (DOMElement \& {\em element})\hspace{0.3cm}{\tt  [pure virtual, inherited]}}\label{classBindingFrame_0c207ed6e5a4c975ed5bc9a758a063ca}
90
91
92This method reads binded data, fill them into a new DOMNode, which then appends to the passed DOMElement
93
94Implemented in {\bf CompoundUserInfo$<$ T $>$::BindedElement$<$ U $>$} \doxyref{}{p.}{classCompoundUserInfo_1_1BindedElement_6ef55cedb98f5d2dbcf92730f2fed939}.
95
96The documentation for this class was generated from the following file:\begin{CompactItemize}
97\item 
98work/git/mixpp/bdm/userinfo.h\end{CompactItemize}
Note: See TracBrowser for help on using the browser.