diff options
| author | Silvio <silvio@devlet.com.br> | 2011-02-22 10:37:10 -0300 |
|---|---|---|
| committer | Silvio Rhatto <silvio@devlet.com.br> | 2011-02-22 10:37:10 -0300 |
| commit | f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 (patch) | |
| tree | b6a4d1d70cdb9cdfca0ec5984a458be1431313f7 /doc/latex | |
| parent | 8b55b69339146f0b03b01dd1c12501754cbd9de0 (diff) | |
| download | cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.gz cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.bz2 | |
Documentation update
Diffstat (limited to 'doc/latex')
41 files changed, 1193 insertions, 328 deletions
diff --git a/doc/latex/classBiblioIsisDb.eps b/doc/latex/classBiblioIsisDb.eps index ad82ed9..601f8a6 100644 --- a/doc/latex/classBiblioIsisDb.eps +++ b/doc/latex/classBiblioIsisDb.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 470.588 +%%BoundingBox: 0 0 500 470.588235 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 1.0625 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 1.062500 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -186,12 +186,12 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (BiblioIsisDb) 0 0 box - (IsisDb) 0 1 box + (BiblioIsisDb) 0.000000 0.000000 box + (IsisDb) 0.000000 1.000000 box % ----- relations ----- solid -0 0 0 out +0 0.000000 0.000000 out solid -1 0 1 in +1 0.000000 1.000000 in diff --git a/doc/latex/classBiblioIsisDb.pdf b/doc/latex/classBiblioIsisDb.pdf Binary files differindex 246967a..18d6100 100644 --- a/doc/latex/classBiblioIsisDb.pdf +++ b/doc/latex/classBiblioIsisDb.pdf diff --git a/doc/latex/classBiblioIsisDb.tex b/doc/latex/classBiblioIsisDb.tex index 4e933f9..6f85b40 100644 --- a/doc/latex/classBiblioIsisDb.tex +++ b/doc/latex/classBiblioIsisDb.tex @@ -5,7 +5,7 @@ Inheritance diagram for BiblioIsisDb:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=2cm]{classBiblioIsisDb} +\includegraphics[height=2.000000cm]{classBiblioIsisDb} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -66,7 +66,11 @@ Biblio::Isis implementation of \hyperlink{interfaceIsisDb}{IsisDb}. \hypertarget{classBiblioIsisDb_ab2c5ec782b324847e104d8ad35a230af}{ \index{BiblioIsisDb@{BiblioIsisDb}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::\_\-\_\-construct (\$ {\em schema})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_ab2c5ec782b324847e104d8ad35a230af} Constructor. @@ -83,7 +87,12 @@ Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb} \hypertarget{classBiblioIsisDb_ad5704f5c9454ac053e66a489797ba221}{ \index{BiblioIsisDb@{BiblioIsisDb}!backend@{backend}} \index{backend@{backend}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{backend}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::backend (\$ {\em method} = {\ttfamily 'count'}, \/ \$ {\em args} = {\ttfamily NULL})}} +\subsubsection[{backend}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::backend ( +\begin{DoxyParamCaption} +\item[{\$}]{ method = {\ttfamily 'count'}, } +\item[{\$}]{ args = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_ad5704f5c9454ac053e66a489797ba221} Send requests to the perl backend. @@ -96,7 +105,11 @@ Backend return value. \hypertarget{classBiblioIsisDb_a2b6fd7b7316f63ac5649ebf3947c4fae}{ \index{BiblioIsisDb@{BiblioIsisDb}!charset@{charset}} \index{charset@{charset}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::charset (\&\$ {\em data})}} +\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::charset ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ data} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a2b6fd7b7316f63ac5649ebf3947c4fae} Charset conversion. @@ -111,7 +124,12 @@ String converted to UTF-\/8. \hypertarget{classBiblioIsisDb_a929467f1907d3aeaeebe493f0c188c5b}{ \index{BiblioIsisDb@{BiblioIsisDb}!check@{check}} \index{check@{check}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static BiblioIsisDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static BiblioIsisDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classBiblioIsisDb_a929467f1907d3aeaeebe493f0c188c5b} Check configuration. @@ -125,7 +143,11 @@ Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb} \hypertarget{classBiblioIsisDb_ab6b0a977c066c25c6bdca5c1d3a083e8}{ \index{BiblioIsisDb@{BiblioIsisDb}!entries@{entries}} \index{entries@{entries}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::entries ()}} +\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::entries ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_ab6b0a977c066c25c6bdca5c1d3a083e8} Return number of entries in the database. @@ -139,7 +161,11 @@ Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb} \hypertarget{classBiblioIsisDb_a8e76b289b9e3a9893b9469094753d2bc}{ \index{BiblioIsisDb@{BiblioIsisDb}!example@{example}} \index{example@{example}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a8e76b289b9e3a9893b9469094753d2bc} Return an example schema. @@ -153,7 +179,11 @@ Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb} \hypertarget{classBiblioIsisDb_a73d5d998f9ab7e410c5f71f65e83948b}{ \index{BiblioIsisDb@{BiblioIsisDb}!has\_\-subfields@{has\_\-subfields}} \index{has\_\-subfields@{has\_\-subfields}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{has\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::has\_\-subfields (\$ {\em key})}} +\subsubsection[{has\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::has\_\-subfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ key} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a73d5d998f9ab7e410c5f71f65e83948b} Checks whether a field has subfields. @@ -166,7 +196,12 @@ True if has subfields, false otherwise. \hypertarget{classBiblioIsisDb_aa86380f9e66ea8f175c50675d1fe0a88}{ \index{BiblioIsisDb@{BiblioIsisDb}!is\_\-repetitive@{is\_\-repetitive}} \index{is\_\-repetitive@{is\_\-repetitive}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{is\_\-repetitive}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::is\_\-repetitive (\$ {\em field}, \/ \$ {\em value})}} +\subsubsection[{is\_\-repetitive}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::is\_\-repetitive ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_aa86380f9e66ea8f175c50675d1fe0a88} Deals with repetition. @@ -181,7 +216,11 @@ True if repetitive, false otherwise. \hypertarget{classBiblioIsisDb_a286fb16de5797785d28021068efca561}{ \index{BiblioIsisDb@{BiblioIsisDb}!logger@{logger}} \index{logger@{logger}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::logger (\$ {\em message})}} +\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::logger ( +\begin{DoxyParamCaption} +\item[{\$}]{ message} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a286fb16de5797785d28021068efca561} Class logger. @@ -191,7 +230,12 @@ Class logger. \hypertarget{classBiblioIsisDb_a808cdbc0d4c8f62a1465e74064f4422f}{ \index{BiblioIsisDb@{BiblioIsisDb}!read@{read}} \index{read@{read}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::read (\$ {\em id}, \/ \$ {\em method} = {\ttfamily 'fetch'})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ id, } +\item[{\$}]{ method = {\ttfamily 'fetch'}} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a808cdbc0d4c8f62a1465e74064f4422f} Read an entry. @@ -204,7 +248,12 @@ Read an entry. \hypertarget{classBiblioIsisDb_a04089d61ce04b18aa6a78c94ca02edb9}{ \index{BiblioIsisDb@{BiblioIsisDb}!repetition@{repetition}} \index{repetition@{repetition}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{repetition}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::repetition (\$ {\em key}, \/ \$ {\em value})}} +\subsubsection[{repetition}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::repetition ( +\begin{DoxyParamCaption} +\item[{\$}]{ key, } +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a04089d61ce04b18aa6a78c94ca02edb9} Deals with repetition. @@ -219,7 +268,13 @@ The value according to the repetition config. \hypertarget{classBiblioIsisDb_a450e26ae0b7f4967d8e25c9a3d023c75}{ \index{BiblioIsisDb@{BiblioIsisDb}!subfields@{subfields}} \index{subfields@{subfields}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields (\$ {\em name}, \/ \$ {\em key}, \/ \$ {\em method})}} +\subsubsection[{subfields}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ key, } +\item[{\$}]{ method} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a450e26ae0b7f4967d8e25c9a3d023c75} Makes subfield substitution in a dataset. @@ -232,7 +287,12 @@ Data with processed subfields. \hypertarget{classBiblioIsisDb_a2b08c6a7ba20f6f5eb07edb2b4a914c1}{ \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-from\_\-fetch@{subfields\_\-from\_\-fetch}} \index{subfields\_\-from\_\-fetch@{subfields\_\-from\_\-fetch}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{subfields\_\-from\_\-fetch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-fetch (\$ {\em name}, \/ \$ {\em key})}} +\subsubsection[{subfields\_\-from\_\-fetch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-fetch ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ key} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a2b08c6a7ba20f6f5eb07edb2b4a914c1} Subfield handling for data read by 'from\_\-fetch' method. @@ -245,7 +305,12 @@ Data with processed subfields. \hypertarget{classBiblioIsisDb_a8c6a0081c5296a6db520e98998502ef7}{ \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-from\_\-to\_\-hash@{subfields\_\-from\_\-to\_\-hash}} \index{subfields\_\-from\_\-to\_\-hash@{subfields\_\-from\_\-to\_\-hash}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{subfields\_\-from\_\-to\_\-hash}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-to\_\-hash (\$ {\em name}, \/ \$ {\em key})}} +\subsubsection[{subfields\_\-from\_\-to\_\-hash}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-from\_\-to\_\-hash ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ key} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a8c6a0081c5296a6db520e98998502ef7} Subfield handling for data read by 'to\_\-hash' method. This method is not fully supported and therefore not recommended. @@ -260,7 +325,12 @@ Data with processed subfields. \hypertarget{classBiblioIsisDb_af0be305b211b96dcb4aeb8452c8331a9}{ \index{BiblioIsisDb@{BiblioIsisDb}!subfields\_\-switch@{subfields\_\-switch}} \index{subfields\_\-switch@{subfields\_\-switch}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{subfields\_\-switch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-switch (\$ {\em key}, \/ \&\$ {\em value})}} +\subsubsection[{subfields\_\-switch}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::subfields\_\-switch ( +\begin{DoxyParamCaption} +\item[{\$}]{ key, } +\item[{\&\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_af0be305b211b96dcb4aeb8452c8331a9} Switch keys on subfields. @@ -270,7 +340,12 @@ Switch keys on subfields. \hypertarget{classBiblioIsisDb_a34483b463d81ba1d8031576b5735efbc}{ \index{BiblioIsisDb@{BiblioIsisDb}!tag@{tag}} \index{tag@{tag}!BiblioIsisDb@{BiblioIsisDb}} -\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::tag (\$ {\em results}, \/ \$ {\em method} = {\ttfamily 'fetch'})}} +\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}BiblioIsisDb::tag ( +\begin{DoxyParamCaption} +\item[{\$}]{ results, } +\item[{\$}]{ method = {\ttfamily 'fetch'}} +\end{DoxyParamCaption} +)}} \label{classBiblioIsisDb_a34483b463d81ba1d8031576b5735efbc} Tag results of a db query. diff --git a/doc/latex/classCinisis.tex b/doc/latex/classCinisis.tex index 7f6193b..79999b6 100644 --- a/doc/latex/classCinisis.tex +++ b/doc/latex/classCinisis.tex @@ -44,7 +44,11 @@ static \hyperlink{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e}{main\_\-field\ \hypertarget{classCinisis_ab9cb7a94d6a5dfb13d50e83e58a4cc10}{ \index{Cinisis@{Cinisis}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!Cinisis@{Cinisis}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::\_\-\_\-construct (\$ {\em config} = {\ttfamily NULL})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classCinisis_ab9cb7a94d6a5dfb13d50e83e58a4cc10} Constructor. @@ -57,7 +61,11 @@ Constructor. \hypertarget{classCinisis_a125ecd4426e15e2c27daa16d4aaac3f2}{ \index{Cinisis@{Cinisis}!base@{base}} \index{base@{base}!Cinisis@{Cinisis}} -\subsubsection[{base}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::base ()\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{base}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::base ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_a125ecd4426e15e2c27daa16d4aaac3f2} Get library base folder. @@ -67,7 +75,11 @@ Return base folder. \hypertarget{classCinisis_ae6f679192f136ba61e85130ccab8e7ef}{ \index{Cinisis@{Cinisis}!check@{check}} \index{check@{check}!Cinisis@{Cinisis}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::check (\$ {\em config})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_ae6f679192f136ba61e85130ccab8e7ef} Check configuration. @@ -80,7 +92,12 @@ Array with configuration or FALSE on error. \hypertarget{classCinisis_aac686f5d4862085721eb0de1d6203a57}{ \index{Cinisis@{Cinisis}!file@{file}} \index{file@{file}!Cinisis@{Cinisis}} -\subsubsection[{file}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::file (\$ {\em config} = {\ttfamily NULL}, \/ \$ {\em section} = {\ttfamily 'config'})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{file}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::file ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily NULL}, } +\item[{\$}]{ section = {\ttfamily 'config'}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_aac686f5d4862085721eb0de1d6203a57} Get a file path. @@ -93,7 +110,11 @@ Return the assembled file path. \hypertarget{classCinisis_a0163d3358b31657bd6e91f94aa618918}{ \index{Cinisis@{Cinisis}!join\_\-subfields@{join\_\-subfields}} \index{join\_\-subfields@{join\_\-subfields}!Cinisis@{Cinisis}} -\subsubsection[{join\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::join\_\-subfields (\$ {\em format})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{join\_\-subfields}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::join\_\-subfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ format} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_a0163d3358b31657bd6e91f94aa618918} Whether to join field and subfields in a single array. @@ -106,7 +127,11 @@ Boolean. \hypertarget{classCinisis_a0bd044303b01793f1a59c54040ff0242}{ \index{Cinisis@{Cinisis}!load@{load}} \index{load@{load}!Cinisis@{Cinisis}} -\subsubsection[{load}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::load (\$ {\em file})}} +\subsubsection[{load}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::load ( +\begin{DoxyParamCaption} +\item[{\$}]{ file} +\end{DoxyParamCaption} +)}} \label{classCinisis_a0bd044303b01793f1a59c54040ff0242} Config file load. @@ -119,7 +144,12 @@ Array with configuration or FALSE if error. \hypertarget{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e}{ \index{Cinisis@{Cinisis}!main\_\-field\_\-name@{main\_\-field\_\-name}} \index{main\_\-field\_\-name@{main\_\-field\_\-name}!Cinisis@{Cinisis}} -\subsubsection[{main\_\-field\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::main\_\-field\_\-name (\$ {\em format}, \/ \$ {\em key})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{main\_\-field\_\-name}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::main\_\-field\_\-name ( +\begin{DoxyParamCaption} +\item[{\$}]{ format, } +\item[{\$}]{ key} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_ac470ab9dc1f8c02545708f1c7b820d9e} Determine the main field name depending on db configuration. @@ -132,7 +162,11 @@ Main field name, 'field' by default. \hypertarget{classCinisis_ad5ebe493037aad5a2d8a2f6c51fab09f}{ \index{Cinisis@{Cinisis}!open@{open}} \index{open@{open}!Cinisis@{Cinisis}} -\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::open (\$ {\em config})}} +\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::open ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)}} \label{classCinisis_ad5ebe493037aad5a2d8a2f6c51fab09f} Open an ISIS database. @@ -142,7 +176,12 @@ Open an ISIS database. \hypertarget{classCinisis_ae8d2f767bfb149031b1ac7077c45c7d6}{ \index{Cinisis@{Cinisis}!parse@{parse}} \index{parse@{parse}!Cinisis@{Cinisis}} -\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::parse (\$ {\em config}, \/ \$ {\em class} = {\ttfamily \_\-\_\-CLASS\_\-\_\-})}} +\subsubsection[{parse}]{\setlength{\rightskip}{0pt plus 5cm}Cinisis::parse ( +\begin{DoxyParamCaption} +\item[{\$}]{ config, } +\item[{\$}]{ class = {\ttfamily \_\-\_\-CLASS\_\-\_\-}} +\end{DoxyParamCaption} +)}} \label{classCinisis_ae8d2f767bfb149031b1ac7077c45c7d6} Parse configuration. @@ -155,7 +194,11 @@ Array with configuration or FALSE on error. \hypertarget{classCinisis_add6ffac62cffb6ba5e5b0bec552b2cee}{ \index{Cinisis@{Cinisis}!yaml@{yaml}} \index{yaml@{yaml}!Cinisis@{Cinisis}} -\subsubsection[{yaml}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::yaml (\$ {\em file})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{yaml}]{\setlength{\rightskip}{0pt plus 5cm}static Cinisis::yaml ( +\begin{DoxyParamCaption} +\item[{\$}]{ file} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisis_add6ffac62cffb6ba5e5b0bec552b2cee} Load YAML into array using backend libraries. diff --git a/doc/latex/classCinisisDisplayHelper.tex b/doc/latex/classCinisisDisplayHelper.tex index 9f6dc4a..72f8041 100644 --- a/doc/latex/classCinisisDisplayHelper.tex +++ b/doc/latex/classCinisisDisplayHelper.tex @@ -92,7 +92,11 @@ Display helpers for test scripts. \hypertarget{classCinisisDisplayHelper_ae60a4cc7ad15109c83b3d934f89b283e}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-construct (\$ {\em title})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ title} +\end{DoxyParamCaption} +)}} \label{classCinisisDisplayHelper_ae60a4cc7ad15109c83b3d934f89b283e} Constructor. @@ -105,7 +109,12 @@ Constructor. \hypertarget{classCinisisDisplayHelper_a5601da7181ece90313c1abe2fd0ae621}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-call@{\_\-\_\-call}} \index{\_\-\_\-call@{\_\-\_\-call}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{\_\-\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-call (\$ {\em method}, \/ \$ {\em arguments})}} +\subsubsection[{\_\-\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}CinisisDisplayHelper::\_\-\_\-call ( +\begin{DoxyParamCaption} +\item[{\$}]{ method, } +\item[{\$}]{ arguments} +\end{DoxyParamCaption} +)}} \label{classCinisisDisplayHelper_a5601da7181ece90313c1abe2fd0ae621} Dispatcher, dynamic version. @@ -118,7 +127,12 @@ Callback result. \hypertarget{classCinisisDisplayHelper_abae906d7606b7d76ef5ed754835ba7e2}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!\_\-\_\-callStatic@{\_\-\_\-callStatic}} \index{\_\-\_\-callStatic@{\_\-\_\-callStatic}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{\_\-\_\-callStatic}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::\_\-\_\-callStatic (\$ {\em method}, \/ \$ {\em arguments})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{\_\-\_\-callStatic}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::\_\-\_\-callStatic ( +\begin{DoxyParamCaption} +\item[{\$}]{ method, } +\item[{\$}]{ arguments} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisisDisplayHelper_abae906d7606b7d76ef5ed754835ba7e2} Dispatcher, static version. @@ -131,12 +145,20 @@ Callback result. \hypertarget{classCinisisDisplayHelper_ad61db99c9d639678c96879aa34288323}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliBr@{cliBr}} \index{cliBr@{cliBr}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliBr ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliBr ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_ad61db99c9d639678c96879aa34288323} Draws a line break element, CLI version. \hypertarget{classCinisisDisplayHelper_abd525c7b612f9dce348bb1479470b445}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliDump@{cliDump}} \index{cliDump@{cliDump}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliDump}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliDump (\$ {\em var})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliDump}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliDump ( +\begin{DoxyParamCaption} +\item[{\$}]{ var} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_abd525c7b612f9dce348bb1479470b445} Dump value. @@ -146,7 +168,11 @@ Dump value. \hypertarget{classCinisisDisplayHelper_aa15ca1975a280814a1cdc2df82b8c67d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliH2@{cliH2}} \index{cliH2@{cliH2}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH2 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH2 ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_aa15ca1975a280814a1cdc2df82b8c67d} Draws a h2 element, CLI version. @@ -156,7 +182,11 @@ Draws a h2 element, CLI version. \hypertarget{classCinisisDisplayHelper_a1ed9ee357ffda8e2efd885a6eae20550}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliH3@{cliH3}} \index{cliH3@{cliH3}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH3 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliH3 ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a1ed9ee357ffda8e2efd885a6eae20550} Draws a h3 element, CLI version. @@ -166,7 +196,11 @@ Draws a h3 element, CLI version. \hypertarget{classCinisisDisplayHelper_a50bf73bd3722766cbae1b46b3092453d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliPre@{cliPre}} \index{cliPre@{cliPre}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliPre (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliPre ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a50bf73bd3722766cbae1b46b3092453d} Draws a pre format block element. @@ -176,7 +210,11 @@ Draws a pre format block element. \hypertarget{classCinisisDisplayHelper_a8f0c8aec5b11a144b14278d287238c85}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!cliTitle@{cliTitle}} \index{cliTitle@{cliTitle}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{cliTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliTitle (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{cliTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::cliTitle ( +\begin{DoxyParamCaption} +\item[{\$}]{ title} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a8f0c8aec5b11a144b14278d287238c85} Draws title, CLI version. @@ -186,7 +224,11 @@ Draws title, CLI version. \hypertarget{classCinisisDisplayHelper_ab263cf81e5c459c60baa6ef7fa5f76b2}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!methodName@{methodName}} \index{methodName@{methodName}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::methodName (\$ {\em method})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::methodName ( +\begin{DoxyParamCaption} +\item[{\$}]{ method} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisisDisplayHelper_ab263cf81e5c459c60baa6ef7fa5f76b2} Determine internal method names. @@ -199,17 +241,29 @@ Method name. \hypertarget{classCinisisDisplayHelper_a9c8b637e47e4263901baf4c5f2064d8d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webBr@{webBr}} \index{webBr@{webBr}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webBr ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webBr}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webBr ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a9c8b637e47e4263901baf4c5f2064d8d} Draws a line break element. \hypertarget{classCinisisDisplayHelper_ab4e55ec58b59bc8b2af32b93cdf0d7c1}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webCloseTable@{webCloseTable}} \index{webCloseTable@{webCloseTable}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webCloseTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCloseTable ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webCloseTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCloseTable ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_ab4e55ec58b59bc8b2af32b93cdf0d7c1} Draws tags for closing a table. \hypertarget{classCinisisDisplayHelper_a0155226dc341e71cf2d32a7611a6402b}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webCsv@{webCsv}} \index{webCsv@{webCsv}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webCsv}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsv (\$ {\em value} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webCsv}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsv ( +\begin{DoxyParamCaption} +\item[{\$}]{ value = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a0155226dc341e71cf2d32a7611a6402b} Display a value with CSV format. @@ -219,12 +273,20 @@ Display a value with CSV format. \hypertarget{classCinisisDisplayHelper_aa020ea03001524e4e437069f08ba8e26}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webCsvRow@{webCsvRow}} \index{webCsvRow@{webCsvRow}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webCsvRow}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsvRow ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webCsvRow}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsvRow ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_aa020ea03001524e4e437069f08ba8e26} Display a new CSV row. \hypertarget{classCinisisDisplayHelper_ae15e846c353078222ee061a835c8c0f8}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webCsvTitles@{webCsvTitles}} \index{webCsvTitles@{webCsvTitles}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webCsvTitles}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsvTitles (\$ {\em format})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webCsvTitles}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webCsvTitles ( +\begin{DoxyParamCaption} +\item[{\$}]{ format} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_ae15e846c353078222ee061a835c8c0f8} Display CSV titles. @@ -234,7 +296,11 @@ Display CSV titles. \hypertarget{classCinisisDisplayHelper_a7811830062abc85b90cf391a9ff89fdf}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webDump@{webDump}} \index{webDump@{webDump}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webDump}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webDump (\$ {\em var})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webDump}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webDump ( +\begin{DoxyParamCaption} +\item[{\$}]{ var} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a7811830062abc85b90cf391a9ff89fdf} Dump value. @@ -244,7 +310,11 @@ Dump value. \hypertarget{classCinisisDisplayHelper_a7ffe33c336d0b495807a2c4bae78cbfb}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webEntryLink@{webEntryLink}} \index{webEntryLink@{webEntryLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webEntryLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webEntryLink (\$ {\em entry})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webEntryLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webEntryLink ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a7ffe33c336d0b495807a2c4bae78cbfb} Format an entry link. @@ -257,7 +327,12 @@ Formatted link. \hypertarget{classCinisisDisplayHelper_a5c3500893f3f7e415fe87874c808021d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webFieldLink@{webFieldLink}} \index{webFieldLink@{webFieldLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webFieldLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFieldLink (\$ {\em entry}, \/ \$ {\em fid})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webFieldLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFieldLink ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry, } +\item[{\$}]{ fid} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a5c3500893f3f7e415fe87874c808021d} Format a link to the field app. @@ -270,12 +345,22 @@ Formatted link. \hypertarget{classCinisisDisplayHelper_aa331cd95a86ffd270784736e74f253e6}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webFooter@{webFooter}} \index{webFooter@{webFooter}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webFooter}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFooter ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webFooter}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFooter ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_aa331cd95a86ffd270784736e74f253e6} Draws the page footer. \hypertarget{classCinisisDisplayHelper_a7ba5dd0ddd1ba9de5efdbfa1b62d4efa}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webForm@{webForm}} \index{webForm@{webForm}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webForm}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webForm (\$ {\em content}, \/ \$ {\em action} = {\ttfamily 'index.php'}, \/ \$ {\em method} = {\ttfamily 'get'})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webForm}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webForm ( +\begin{DoxyParamCaption} +\item[{\$}]{ content, } +\item[{\$}]{ action = {\ttfamily 'index.php'}, } +\item[{\$}]{ method = {\ttfamily 'get'}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a7ba5dd0ddd1ba9de5efdbfa1b62d4efa} Draws a form. @@ -285,7 +370,12 @@ Draws a form. \hypertarget{classCinisisDisplayHelper_a4c8934dc88cda9c7a894106b4dc7abba}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webFormInputText@{webFormInputText}} \index{webFormInputText@{webFormInputText}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webFormInputText}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFormInputText (\$ {\em name}, \/ \$ {\em default} = {\ttfamily null})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webFormInputText}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webFormInputText ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ default = {\ttfamily null}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a4c8934dc88cda9c7a894106b4dc7abba} Draws a form text input. @@ -298,7 +388,11 @@ Rendered text input. \hypertarget{classCinisisDisplayHelper_a0f2e5c78f6fdd146df04382e497cfe94}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webH2@{webH2}} \index{webH2@{webH2}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH2 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webH2}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH2 ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a0f2e5c78f6fdd146df04382e497cfe94} Draws a h2 element. @@ -308,7 +402,11 @@ Draws a h2 element. \hypertarget{classCinisisDisplayHelper_acc20c726a214895584d15a434b2f3548}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webH3@{webH3}} \index{webH3@{webH3}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH3 (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webH3}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webH3 ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_acc20c726a214895584d15a434b2f3548} Draws a h3 element. @@ -318,7 +416,11 @@ Draws a h3 element. \hypertarget{classCinisisDisplayHelper_a356d8117dfcb220b7bb9996b569f5f25}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webHeader@{webHeader}} \index{webHeader@{webHeader}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webHeader}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webHeader (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webHeader}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webHeader ( +\begin{DoxyParamCaption} +\item[{\$}]{ title} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a356d8117dfcb220b7bb9996b569f5f25} Draws the page header. @@ -328,7 +430,12 @@ Draws the page header. \hypertarget{classCinisisDisplayHelper_a6629bfa4b0ccd26d1433ca2302ce8c41}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webHttpHeader@{webHttpHeader}} \index{webHttpHeader@{webHttpHeader}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webHttpHeader}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webHttpHeader (\$ {\em mime}, \/ \$ {\em filename})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webHttpHeader}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webHttpHeader ( +\begin{DoxyParamCaption} +\item[{\$}]{ mime, } +\item[{\$}]{ filename} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a6629bfa4b0ccd26d1433ca2302ce8c41} Set the response helper. @@ -338,7 +445,13 @@ Set the response helper. \hypertarget{classCinisisDisplayHelper_aadc869909d8be43402d73fa3415827b4}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webLink@{webLink}} \index{webLink@{webLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webLink (\$ {\em action}, \/ \$ {\em args}, \/ \$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webLink ( +\begin{DoxyParamCaption} +\item[{\$}]{ action, } +\item[{\$}]{ args, } +\item[{\$}]{ title} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_aadc869909d8be43402d73fa3415827b4} Format a link. @@ -351,7 +464,11 @@ Formatted link. \hypertarget{classCinisisDisplayHelper_a6e04da665f31a88eb3c42579d266bd4f}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webMergeCsvItems@{webMergeCsvItems}} \index{webMergeCsvItems@{webMergeCsvItems}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webMergeCsvItems}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webMergeCsvItems (\$ {\em items})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webMergeCsvItems}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webMergeCsvItems ( +\begin{DoxyParamCaption} +\item[{\$}]{ items} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a6e04da665f31a88eb3c42579d266bd4f} Merge items in a CSV roll. @@ -361,7 +478,14 @@ Merge items in a CSV roll. \hypertarget{classCinisisDisplayHelper_a291e2da97fd646e7fa34fb92879fc3d6}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webNavbar@{webNavbar}} \index{webNavbar@{webNavbar}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webNavbar}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webNavbar (\$ {\em entry}, \/ \$ {\em entries}, \/ \$ {\em action} = {\ttfamily 'index.php'}, \/ \$ {\em extra} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webNavbar}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webNavbar ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry, } +\item[{\$}]{ entries, } +\item[{\$}]{ action = {\ttfamily 'index.php'}, } +\item[{\$}]{ extra = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a291e2da97fd646e7fa34fb92879fc3d6} Draws a navigation bar. @@ -371,12 +495,20 @@ Draws a navigation bar. \hypertarget{classCinisisDisplayHelper_a4028def92d8511e525251ec7ab06246d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webOpenTable@{webOpenTable}} \index{webOpenTable@{webOpenTable}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webOpenTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webOpenTable ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webOpenTable}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webOpenTable ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a4028def92d8511e525251ec7ab06246d} Draws tags for opening a table. \hypertarget{classCinisisDisplayHelper_a528283a8b16090918f1878dca5ee24fb}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webPre@{webPre}} \index{webPre@{webPre}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPre (\$ {\em text})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webPre}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPre ( +\begin{DoxyParamCaption} +\item[{\$}]{ text} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a528283a8b16090918f1878dca5ee24fb} Draws a pre format block element. @@ -386,17 +518,32 @@ Draws a pre format block element. \hypertarget{classCinisisDisplayHelper_af4d61af3ed8211300032a208175d72ed}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webPreClose@{webPreClose}} \index{webPreClose@{webPreClose}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webPreClose}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPreClose ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webPreClose}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPreClose ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_af4d61af3ed8211300032a208175d72ed} Draws a pre open element. \hypertarget{classCinisisDisplayHelper_a9c2a28e3865e8b3950b428770a132aa0}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webPreOpen@{webPreOpen}} \index{webPreOpen@{webPreOpen}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webPreOpen}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPreOpen ()\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webPreOpen}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webPreOpen ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a9c2a28e3865e8b3950b428770a132aa0} Draws a pre open element. \hypertarget{classCinisisDisplayHelper_abd8110a9976bb72b42992b28b5aae80d}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webRadio@{webRadio}} \index{webRadio@{webRadio}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webRadio}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRadio (\$ {\em name}, \/ \$ {\em value}, \/ \$ {\em caption}, \/ \$ {\em checked} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webRadio}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRadio ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ value, } +\item[{\$}]{ caption, } +\item[{\$}]{ checked = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_abd8110a9976bb72b42992b28b5aae80d} Renders a radio button. @@ -409,7 +556,13 @@ HTML rendered radio button. \hypertarget{classCinisisDisplayHelper_ac8c66caf42859ab8308aa40dfa33dbd0}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webRadios@{webRadios}} \index{webRadios@{webRadios}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webRadios}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRadios (\$ {\em name}, \/ \$ {\em data}, \/ \$ {\em checked} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webRadios}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRadios ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ data, } +\item[{\$}]{ checked = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_ac8c66caf42859ab8308aa40dfa33dbd0} Draws a combination of radio buttons. @@ -419,7 +572,12 @@ Draws a combination of radio buttons. \hypertarget{classCinisisDisplayHelper_a1400c9d85878229fd02b3651ed9e0d63}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webRepetitionLink@{webRepetitionLink}} \index{webRepetitionLink@{webRepetitionLink}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webRepetitionLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRepetitionLink (\$ {\em entry}, \/ \$ {\em fid})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webRepetitionLink}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webRepetitionLink ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry, } +\item[{\$}]{ fid} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_a1400c9d85878229fd02b3651ed9e0d63} Format a link to the field app. @@ -432,7 +590,11 @@ Formatted link. \hypertarget{classCinisisDisplayHelper_af3849efbba5e6980ddfdb4ceddb6ad17}{ \index{CinisisDisplayHelper@{CinisisDisplayHelper}!webTitle@{webTitle}} \index{webTitle@{webTitle}!CinisisDisplayHelper@{CinisisDisplayHelper}} -\subsubsection[{webTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webTitle (\$ {\em title})\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} +\subsubsection[{webTitle}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisDisplayHelper::webTitle ( +\begin{DoxyParamCaption} +\item[{\$}]{ title} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static, protected\mbox{]}}}} \label{classCinisisDisplayHelper_af3849efbba5e6980ddfdb4ceddb6ad17} Draws a page title. diff --git a/doc/latex/classCinisisHttpHelper.tex b/doc/latex/classCinisisHttpHelper.tex index a0d2b58..b4d01bd 100644 --- a/doc/latex/classCinisisHttpHelper.tex +++ b/doc/latex/classCinisisHttpHelper.tex @@ -20,7 +20,12 @@ Http helper for test scripts. \hypertarget{classCinisisHttpHelper_a308f89e9f2235ae3dd1ccfb03aef4c3c}{ \index{CinisisHttpHelper@{CinisisHttpHelper}!getArg@{getArg}} \index{getArg@{getArg}!CinisisHttpHelper@{CinisisHttpHelper}} -\subsubsection[{getArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getArg (\$ {\em name}, \/ \$ {\em default} = {\ttfamily 1})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{getArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getArg ( +\begin{DoxyParamCaption} +\item[{\$}]{ name, } +\item[{\$}]{ default = {\ttfamily 1}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisisHttpHelper_a308f89e9f2235ae3dd1ccfb03aef4c3c} Get an argument. @@ -33,7 +38,11 @@ Argument value. \hypertarget{classCinisisHttpHelper_a6490e2a456242fae618802f4dac2e553}{ \index{CinisisHttpHelper@{CinisisHttpHelper}!getNumericArg@{getNumericArg}} \index{getNumericArg@{getNumericArg}!CinisisHttpHelper@{CinisisHttpHelper}} -\subsubsection[{getNumericArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getNumericArg (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{getNumericArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getNumericArg ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisisHttpHelper_a6490e2a456242fae618802f4dac2e553} Get a numeric argument. @@ -46,7 +55,11 @@ Argument value. \hypertarget{classCinisisHttpHelper_a6bf24e1b8e1d90e59b52813bb2a65378}{ \index{CinisisHttpHelper@{CinisisHttpHelper}!getTextualArg@{getTextualArg}} \index{getTextualArg@{getTextualArg}!CinisisHttpHelper@{CinisisHttpHelper}} -\subsubsection[{getTextualArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getTextualArg (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{getTextualArg}]{\setlength{\rightskip}{0pt plus 5cm}static CinisisHttpHelper::getTextualArg ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classCinisisHttpHelper_a6bf24e1b8e1d90e59b52813bb2a65378} Get a string argument. diff --git a/doc/latex/classIsisAudit.eps b/doc/latex/classIsisAudit.eps index cc7334b..382062d 100644 --- a/doc/latex/classIsisAudit.eps +++ b/doc/latex/classIsisAudit.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 1030.93 +%%BoundingBox: 0 0 500 1030.927835 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.485 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.485000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -189,27 +189,27 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisAudit) 0 0 box - (IsisFinder) 0 1 box - (IsisConnector) 0 2 box - (IsisMap) 0 3 box - (IsisReader) 0 4 box + (IsisAudit) 0.000000 0.000000 box + (IsisFinder) 0.000000 1.000000 box + (IsisConnector) 0.000000 2.000000 box + (IsisMap) 0.000000 3.000000 box + (IsisReader) 0.000000 4.000000 box % ----- relations ----- solid -0 0 0 out +0 0.000000 0.000000 out solid -1 0 1 in +1 0.000000 1.000000 in solid -0 0 1 out +0 0.000000 1.000000 out solid -1 0 2 in +1 0.000000 2.000000 in solid -0 0 2 out +0 0.000000 2.000000 out solid -1 0 3 in +1 0.000000 3.000000 in solid -0 0 3 out +0 0.000000 3.000000 out solid -1 0 4 in +1 0.000000 4.000000 in diff --git a/doc/latex/classIsisAudit.pdf b/doc/latex/classIsisAudit.pdf Binary files differindex ab53af8..968e337 100644 --- a/doc/latex/classIsisAudit.pdf +++ b/doc/latex/classIsisAudit.pdf diff --git a/doc/latex/classIsisAudit.tex b/doc/latex/classIsisAudit.tex index e073f7b..fb88dd5 100644 --- a/doc/latex/classIsisAudit.tex +++ b/doc/latex/classIsisAudit.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisAudit:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisAudit} +\includegraphics[height=5.000000cm]{classIsisAudit} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -29,7 +29,11 @@ Methods for auditing an Isis database. \hypertarget{classIsisAudit_add19ca3adcb5646d7d1d6906593cd4ab}{ \index{IsisAudit@{IsisAudit}!logger@{logger}} \index{logger@{logger}!IsisAudit@{IsisAudit}} -\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}IsisAudit::logger (\$ {\em message})}} +\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}IsisAudit::logger ( +\begin{DoxyParamCaption} +\item[{\$}]{ message} +\end{DoxyParamCaption} +)}} \label{classIsisAudit_add19ca3adcb5646d7d1d6906593cd4ab} Class logger. @@ -39,7 +43,11 @@ Class logger. \hypertarget{classIsisAudit_a2fb1d5a12933f63f396188bc4229f671}{ \index{IsisAudit@{IsisAudit}!run@{run}} \index{run@{run}!IsisAudit@{IsisAudit}} -\subsubsection[{run}]{\setlength{\rightskip}{0pt plus 5cm}IsisAudit::run ()}} +\subsubsection[{run}]{\setlength{\rightskip}{0pt plus 5cm}IsisAudit::run ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisAudit_a2fb1d5a12933f63f396188bc4229f671} Run a standard audit procedure. diff --git a/doc/latex/classIsisConnector.eps b/doc/latex/classIsisConnector.eps index c780276..6daa5f3 100644 --- a/doc/latex/classIsisConnector.eps +++ b/doc/latex/classIsisConnector.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 1030.93 +%%BoundingBox: 0 0 500 1030.927835 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.485 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.485000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -189,27 +189,27 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisConnector) 0 2 box - (IsisMap) 0 3 box - (IsisReader) 0 4 box - (IsisFinder) 0 1 box - (IsisAudit) 0 0 box + (IsisConnector) 0.000000 2.000000 box + (IsisMap) 0.000000 3.000000 box + (IsisReader) 0.000000 4.000000 box + (IsisFinder) 0.000000 1.000000 box + (IsisAudit) 0.000000 0.000000 box % ----- relations ----- solid -0 0 2 out +0 0.000000 2.000000 out solid -1 0 3 in +1 0.000000 3.000000 in solid -0 0 3 out +0 0.000000 3.000000 out solid -1 0 4 in +1 0.000000 4.000000 in solid -1 0 1.25 out +1 0.000000 1.250000 out solid -0 0 1.75 in +0 0.000000 1.750000 in solid -1 0 0.25 out +1 0.000000 0.250000 out solid -0 0 0.75 in +0 0.000000 0.750000 in diff --git a/doc/latex/classIsisConnector.pdf b/doc/latex/classIsisConnector.pdf Binary files differindex 6b3947e..8d89888 100644 --- a/doc/latex/classIsisConnector.pdf +++ b/doc/latex/classIsisConnector.pdf diff --git a/doc/latex/classIsisConnector.tex b/doc/latex/classIsisConnector.tex index e090fb8..0a72fe5 100644 --- a/doc/latex/classIsisConnector.tex +++ b/doc/latex/classIsisConnector.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisConnector:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisConnector} +\includegraphics[height=5.000000cm]{classIsisConnector} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -54,7 +54,12 @@ Inheritance diagram for IsisConnector:\begin{figure}[H] \hypertarget{classIsisConnector_a10669b49c4145a86dc3662c77733d74d}{ \index{IsisConnector@{IsisConnector}!existingItemKeys@{existingItemKeys}} \index{existingItemKeys@{existingItemKeys}!IsisConnector@{IsisConnector}} -\subsubsection[{existingItemKeys}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::existingItemKeys (\$ {\em field}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{existingItemKeys}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::existingItemKeys ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a10669b49c4145a86dc3662c77733d74d} Return the existing key items for a result. @@ -69,7 +74,13 @@ Array with existing item keys \hypertarget{classIsisConnector_acfea4d86a683cc7455d258cdb80db478}{ \index{IsisConnector@{IsisConnector}!explodeItem@{explodeItem}} \index{explodeItem@{explodeItem}!IsisConnector@{IsisConnector}} -\subsubsection[{explodeItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row})}} +\subsubsection[{explodeItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_acfea4d86a683cc7455d258cdb80db478} Explode brackets for a given item, avoiding null entries. @@ -82,7 +93,13 @@ Exploded item data. \hypertarget{classIsisConnector_afc97554b42b8b9e98f396811bbfa13d8}{ \index{IsisConnector@{IsisConnector}!explodeSubfield@{explodeSubfield}} \index{explodeSubfield@{explodeSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{explodeSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{explodeSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_afc97554b42b8b9e98f396811bbfa13d8} Explode brackets for a given subfield, avoiding null entries. @@ -95,7 +112,13 @@ Exploded subfield data. \hypertarget{classIsisConnector_a8baad24b6abc2ef29d8968f353ea6dae}{ \index{IsisConnector@{IsisConnector}!filterSubfield@{filterSubfield}} \index{filterSubfield@{filterSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{filterSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::filterSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{filterSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::filterSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a8baad24b6abc2ef29d8968f353ea6dae} Filter brackets for a given subfield. @@ -108,7 +131,13 @@ Filterd subfield data. \hypertarget{classIsisConnector_aa16bb24a54837048eee6244957cbf091}{ \index{IsisConnector@{IsisConnector}!getItem@{getItem}} \index{getItem@{getItem}!IsisConnector@{IsisConnector}} -\subsubsection[{getItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_aa16bb24a54837048eee6244957cbf091} Get both main field or subfields from a given field and row. @@ -121,7 +150,12 @@ Item data. \hypertarget{classIsisConnector_aa928456a26e0264bf0c1a4869a02cbb3}{ \index{IsisConnector@{IsisConnector}!getItems@{getItems}} \index{getItems@{getItems}!IsisConnector@{IsisConnector}} -\subsubsection[{getItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItems (\$ {\em field}, \/ \$ {\em item})}} +\subsubsection[{getItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItems ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_aa928456a26e0264bf0c1a4869a02cbb3} Get all rows both main field or subfields from a given field. @@ -134,7 +168,12 @@ Item data. \hypertarget{classIsisConnector_a21c7c4e9fec2440f8c7d36f8a632c8c2}{ \index{IsisConnector@{IsisConnector}!getMainItem@{getMainItem}} \index{getMainItem@{getMainItem}!IsisConnector@{IsisConnector}} -\subsubsection[{getMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItem (\$ {\em field}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a21c7c4e9fec2440f8c7d36f8a632c8c2} Get the value of a given field. @@ -147,7 +186,11 @@ Field data. \hypertarget{classIsisConnector_a2bace7162ec3bf49df9f7acd9367c360}{ \index{IsisConnector@{IsisConnector}!getMainItems@{getMainItems}} \index{getMainItems@{getMainItems}!IsisConnector@{IsisConnector}} -\subsubsection[{getMainItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItems (\$ {\em field})}} +\subsubsection[{getMainItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItems ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a2bace7162ec3bf49df9f7acd9367c360} Get all values of a given field. @@ -160,7 +203,11 @@ Field data. \hypertarget{classIsisConnector_a0d1ebc176fe54568044aae02d7932c9b}{ \index{IsisConnector@{IsisConnector}!getRows@{getRows}} \index{getRows@{getRows}!IsisConnector@{IsisConnector}} -\subsubsection[{getRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getRows (\$ {\em field})}} +\subsubsection[{getRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getRows ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a0d1ebc176fe54568044aae02d7932c9b} Get the number of resulting rows for a given field. @@ -173,7 +220,13 @@ Number of rows. \hypertarget{classIsisConnector_a1ddaff24266ee02d652de9a752c1be8e}{ \index{IsisConnector@{IsisConnector}!getSubfield@{getSubfield}} \index{getSubfield@{getSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{getSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a1ddaff24266ee02d652de9a752c1be8e} Get the value of a given subfield. @@ -186,7 +239,12 @@ Subfield data. \hypertarget{classIsisConnector_ad8af0f5cef3b139649d9fb317264df10}{ \index{IsisConnector@{IsisConnector}!getSubfields@{getSubfields}} \index{getSubfields@{getSubfields}!IsisConnector@{IsisConnector}} -\subsubsection[{getSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfields (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{getSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad8af0f5cef3b139649d9fb317264df10} Get all values of a given subfield. @@ -199,7 +257,11 @@ Subfield data. \hypertarget{classIsisConnector_ad806dcc5be703fe9aea63d72d68af0a2}{ \index{IsisConnector@{IsisConnector}!getValues@{getValues}} \index{getValues@{getValues}!IsisConnector@{IsisConnector}} -\subsubsection[{getValues}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getValues (\$ {\em field})}} +\subsubsection[{getValues}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getValues ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad806dcc5be703fe9aea63d72d68af0a2} Get all values of a given field. @@ -212,7 +274,14 @@ Field data. \hypertarget{classIsisConnector_afbcef48a723b073a2777d5a5ed73d280}{ \index{IsisConnector@{IsisConnector}!hasFieldSubfieldCondition@{hasFieldSubfieldCondition}} \index{hasFieldSubfieldCondition@{hasFieldSubfieldCondition}!IsisConnector@{IsisConnector}} -\subsubsection[{hasFieldSubfieldCondition}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasFieldSubfieldCondition (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em key}, \/ \$ {\em subkey})}} +\subsubsection[{hasFieldSubfieldCondition}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasFieldSubfieldCondition ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ key, } +\item[{\$}]{ subkey} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_afbcef48a723b073a2777d5a5ed73d280} Check if a field and subfield match a given condition. @@ -225,7 +294,13 @@ True if condition match, false otherwise. \hypertarget{classIsisConnector_ad88ed9012aac0687aef1c8554879cd52}{ \index{IsisConnector@{IsisConnector}!hasItem@{hasItem}} \index{hasItem@{hasItem}!IsisConnector@{IsisConnector}} -\subsubsection[{hasItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{hasItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad88ed9012aac0687aef1c8554879cd52} Check if a field result has an item. @@ -238,7 +313,12 @@ True if result has the main item, false otherwise. \hypertarget{classIsisConnector_a7bc914f2aa6c523404f368dc0b7b130b}{ \index{IsisConnector@{IsisConnector}!hasMainItem@{hasMainItem}} \index{hasMainItem@{hasMainItem}!IsisConnector@{IsisConnector}} -\subsubsection[{hasMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasMainItem (\$ {\em field}, \/ \$ {\em row})}} +\subsubsection[{hasMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a7bc914f2aa6c523404f368dc0b7b130b} Check if a field result has a main item. @@ -251,7 +331,13 @@ True if result has the main item, false otherwise. \hypertarget{classIsisConnector_a2e6970a3aca76a1dbb5b4bb5ac3adda1}{ \index{IsisConnector@{IsisConnector}!hasSubfield@{hasSubfield}} \index{hasSubfield@{hasSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{hasSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{hasSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a2e6970a3aca76a1dbb5b4bb5ac3adda1} Check if a field result and row has a given subfield. @@ -264,7 +350,13 @@ True if result has the subfield, false otherwise. \hypertarget{classIsisConnector_a9050227e8d8f10821a4df08a5705832a}{ \index{IsisConnector@{IsisConnector}!specialItem@{specialItem}} \index{specialItem@{specialItem}!IsisConnector@{IsisConnector}} -\subsubsection[{specialItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::specialItem (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em return} = {\ttfamily 'boolean'})}} +\subsubsection[{specialItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::specialItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ return = {\ttfamily 'boolean'}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a9050227e8d8f10821a4df08a5705832a} Deal with special items. diff --git a/doc/latex/classIsisEntryIterator.tex b/doc/latex/classIsisEntryIterator.tex index 07f9418..f216b88 100644 --- a/doc/latex/classIsisEntryIterator.tex +++ b/doc/latex/classIsisEntryIterator.tex @@ -26,7 +26,12 @@ Isis entry iterator. Iterates over all entries in the database. \hypertarget{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e}{ \index{IsisEntryIterator@{IsisEntryIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f}{ \index{IsisEntryIterator@{IsisEntryIterator}!current@{current}} \index{current@{current}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f} Return the current element. \hypertarget{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65}{ \index{IsisEntryIterator@{IsisEntryIterator}!key@{key}} \index{key@{key}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65} Return the key of the current element. \hypertarget{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{ \index{IsisEntryIterator@{IsisEntryIterator}!next@{next}} \index{next@{next}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d} Move forward to next element. \hypertarget{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{ \index{IsisEntryIterator@{IsisEntryIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a} Rewind the Iterator to the first element. \hypertarget{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49}{ \index{IsisEntryIterator@{IsisEntryIterator}!valid@{valid}} \index{valid@{valid}!IsisEntryIterator@{IsisEntryIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49} Check if there is a current element after calls to \hyperlink{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{rewind()} or \hyperlink{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{next()}. diff --git a/doc/latex/classIsisFinder.eps b/doc/latex/classIsisFinder.eps index 4401a3c..2654580 100644 --- a/doc/latex/classIsisFinder.eps +++ b/doc/latex/classIsisFinder.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 1030.93 +%%BoundingBox: 0 0 500 1030.927835 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.485 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.485000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -189,27 +189,27 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisFinder) 0 1 box - (IsisConnector) 0 2 box - (IsisMap) 0 3 box - (IsisReader) 0 4 box - (IsisAudit) 0 0 box + (IsisFinder) 0.000000 1.000000 box + (IsisConnector) 0.000000 2.000000 box + (IsisMap) 0.000000 3.000000 box + (IsisReader) 0.000000 4.000000 box + (IsisAudit) 0.000000 0.000000 box % ----- relations ----- solid -0 0 1 out +0 0.000000 1.000000 out solid -1 0 2 in +1 0.000000 2.000000 in solid -0 0 2 out +0 0.000000 2.000000 out solid -1 0 3 in +1 0.000000 3.000000 in solid -0 0 3 out +0 0.000000 3.000000 out solid -1 0 4 in +1 0.000000 4.000000 in solid -1 0 0.25 out +1 0.000000 0.250000 out solid -0 0 0.75 in +0 0.000000 0.750000 in diff --git a/doc/latex/classIsisFinder.pdf b/doc/latex/classIsisFinder.pdf Binary files differindex 74d1e38..41c8a95 100644 --- a/doc/latex/classIsisFinder.pdf +++ b/doc/latex/classIsisFinder.pdf diff --git a/doc/latex/classIsisFinder.tex b/doc/latex/classIsisFinder.tex index a7e83ea..68b4588 100644 --- a/doc/latex/classIsisFinder.tex +++ b/doc/latex/classIsisFinder.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisFinder:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisFinder} +\includegraphics[height=5.000000cm]{classIsisFinder} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -34,7 +34,12 @@ Provides Isis Database search methods. \hypertarget{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7}{ \index{IsisFinder@{IsisFinder}!hasSubfieldInRows@{hasSubfieldInRows}} \index{hasSubfieldInRows@{hasSubfieldInRows}!IsisFinder@{IsisFinder}} -\subsubsection[{hasSubfieldInRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::hasSubfieldInRows (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{hasSubfieldInRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::hasSubfieldInRows ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a41410b18c4462c05ac669e4ee889d8a7} Check if a field result has a given subfield. @@ -47,7 +52,14 @@ True if result has the subfield, false otherwise. \hypertarget{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae}{ \index{IsisFinder@{IsisFinder}!matchMainItem@{matchMainItem}} \index{matchMainItem@{matchMainItem}!IsisFinder@{IsisFinder}} -\subsubsection[{matchMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchMainItem (\$ {\em field}, \/ \$ {\em row}, \/ \$ {\em search}, \/ \$ {\em match})}} +\subsubsection[{matchMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row, } +\item[{\$}]{ search, } +\item[{\$}]{ match} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_ab35a9bb21e83df846b6ff57bcbe117ae} Check if a main item match a given value. @@ -60,7 +72,15 @@ True if match, false otherwise. \hypertarget{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c}{ \index{IsisFinder@{IsisFinder}!matchSubfield@{matchSubfield}} \index{matchSubfield@{matchSubfield}!IsisFinder@{IsisFinder}} -\subsubsection[{matchSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row}, \/ \$ {\em search}, \/ \$ {\em match})}} +\subsubsection[{matchSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::matchSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row, } +\item[{\$}]{ search, } +\item[{\$}]{ match} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a20539e44cfc30ca3897e174781c4b26c} Check if a subfield match a given value. @@ -73,7 +93,12 @@ True if match, false otherwise. \hypertarget{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d}{ \index{IsisFinder@{IsisFinder}!nextField@{nextField}} \index{nextField@{nextField}!IsisFinder@{IsisFinder}} -\subsubsection[{nextField}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextField (\$ {\em field}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextField}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextField ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_a7d708e281bea35ee38f5875c8f2cad8d} Find the next occurrence of a field. @@ -86,7 +111,12 @@ Next occurrence. \hypertarget{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e}{ \index{IsisFinder@{IsisFinder}!nextRepetition@{nextRepetition}} \index{nextRepetition@{nextRepetition}!IsisFinder@{IsisFinder}} -\subsubsection[{nextRepetition}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextRepetition (\$ {\em field}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextRepetition}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextRepetition ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_ac4e3a8f45995cbf940b3f2899b71bd1e} Find the next repetition of a field. @@ -99,7 +129,15 @@ Next repetition entry and result. \hypertarget{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc}{ \index{IsisFinder@{IsisFinder}!nextResult@{nextResult}} \index{nextResult@{nextResult}!IsisFinder@{IsisFinder}} -\subsubsection[{nextResult}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextResult (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em search}, \/ \$ {\em entry} = {\ttfamily 1}, \/ \$ {\em match} = {\ttfamily TRUE})}} +\subsubsection[{nextResult}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextResult ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ search, } +\item[{\$}]{ entry = {\ttfamily 1}, } +\item[{\$}]{ match = {\ttfamily TRUE}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_af965ba4acae18aa61bc4a3242bcdadfc} Search the next match inside a result. @@ -109,7 +147,13 @@ Search the next match inside a result. \hypertarget{classIsisFinder_aa367980783d341197e003684a639ff1a}{ \index{IsisFinder@{IsisFinder}!nextSubfield@{nextSubfield}} \index{nextSubfield@{nextSubfield}!IsisFinder@{IsisFinder}} -\subsubsection[{nextSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em entry} = {\ttfamily 1})}} +\subsubsection[{nextSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisFinder::nextSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ entry = {\ttfamily 1}} +\end{DoxyParamCaption} +)}} \label{classIsisFinder_aa367980783d341197e003684a639ff1a} Find the next occurrence of a subfield. diff --git a/doc/latex/classIsisItemIterator.tex b/doc/latex/classIsisItemIterator.tex index ba95027..617feca 100644 --- a/doc/latex/classIsisItemIterator.tex +++ b/doc/latex/classIsisItemIterator.tex @@ -26,7 +26,13 @@ Isis field iterator. Iterates over a field for each result row. \hypertarget{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{ \index{IsisItemIterator@{IsisItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field, } +\item[{\$}]{ main = {\ttfamily false}} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a} Constructor. @@ -39,27 +45,47 @@ Constructor. \hypertarget{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{ \index{IsisItemIterator@{IsisItemIterator}!current@{current}} \index{current@{current}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b} Return the current element. \hypertarget{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{ \index{IsisItemIterator@{IsisItemIterator}!key@{key}} \index{key@{key}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5} Return the key of the current element. \hypertarget{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{ \index{IsisItemIterator@{IsisItemIterator}!next@{next}} \index{next@{next}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23} Move forward to next element. \hypertarget{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{ \index{IsisItemIterator@{IsisItemIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c} Rewind the Iterator to the first element. \hypertarget{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{ \index{IsisItemIterator@{IsisItemIterator}!valid@{valid}} \index{valid@{valid}!IsisItemIterator@{IsisItemIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b} Check if there is a current element after calls to \hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind()} or \hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next()}. diff --git a/doc/latex/classIsisMainItemIterator.tex b/doc/latex/classIsisMainItemIterator.tex index e89dc99..938cd8a 100644 --- a/doc/latex/classIsisMainItemIterator.tex +++ b/doc/latex/classIsisMainItemIterator.tex @@ -30,7 +30,12 @@ Isis field iterator. Iterates over all field main values for each result row. \hypertarget{classIsisMainItemIterator_a486e2d00fe13ed908b7384d64fd5f6f0}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_a486e2d00fe13ed908b7384d64fd5f6f0} Constructor. @@ -43,37 +48,65 @@ Constructor. \hypertarget{classIsisMainItemIterator_adab612db1a4e1f16c6bc5848c3d4ee21}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!current@{current}} \index{current@{current}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_adab612db1a4e1f16c6bc5848c3d4ee21} Return the current element. \hypertarget{classIsisMainItemIterator_ad0f3d297912d5101d5227139f8414c80}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!current\_\-null@{current\_\-null}} \index{current\_\-null@{current\_\-null}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{current\_\-null}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current\_\-null ()}} +\subsubsection[{current\_\-null}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current\_\-null ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_ad0f3d297912d5101d5227139f8414c80} Check if the current value is null. \hypertarget{classIsisMainItemIterator_a6c406f34a89316ff7e7fa15a80806b39}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!has\_\-more\_\-rows@{has\_\-more\_\-rows}} \index{has\_\-more\_\-rows@{has\_\-more\_\-rows}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{has\_\-more\_\-rows}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::has\_\-more\_\-rows ()}} +\subsubsection[{has\_\-more\_\-rows}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::has\_\-more\_\-rows ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_a6c406f34a89316ff7e7fa15a80806b39} Check if there are more rows. \hypertarget{classIsisMainItemIterator_a3676fc993eb38641c65363f2e05873f3}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!key@{key}} \index{key@{key}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_a3676fc993eb38641c65363f2e05873f3} Return the key of the current element. \hypertarget{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!next@{next}} \index{next@{next}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae} Move forward to next element. \hypertarget{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07} Rewind the Iterator to the first element. \hypertarget{classIsisMainItemIterator_a376387f6168a95890fc9f3a441967135}{ \index{IsisMainItemIterator@{IsisMainItemIterator}!valid@{valid}} \index{valid@{valid}!IsisMainItemIterator@{IsisMainItemIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMainItemIterator_a376387f6168a95890fc9f3a441967135} Check if there is a current element after calls to \hyperlink{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07}{rewind()} or \hyperlink{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae}{next()}. diff --git a/doc/latex/classIsisMap.eps b/doc/latex/classIsisMap.eps index d1fdab3..ef25d81 100644 --- a/doc/latex/classIsisMap.eps +++ b/doc/latex/classIsisMap.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 1030.93 +%%BoundingBox: 0 0 500 1030.927835 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.485 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.485000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -189,27 +189,27 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisMap) 0 3 box - (IsisReader) 0 4 box - (IsisConnector) 0 2 box - (IsisFinder) 0 1 box - (IsisAudit) 0 0 box + (IsisMap) 0.000000 3.000000 box + (IsisReader) 0.000000 4.000000 box + (IsisConnector) 0.000000 2.000000 box + (IsisFinder) 0.000000 1.000000 box + (IsisAudit) 0.000000 0.000000 box % ----- relations ----- solid -0 0 3 out +0 0.000000 3.000000 out solid -1 0 4 in +1 0.000000 4.000000 in solid -1 0 2.25 out +1 0.000000 2.250000 out solid -0 0 2.75 in +0 0.000000 2.750000 in solid -1 0 1.25 out +1 0.000000 1.250000 out solid -0 0 1.75 in +0 0.000000 1.750000 in solid -1 0 0.25 out +1 0.000000 0.250000 out solid -0 0 0.75 in +0 0.000000 0.750000 in diff --git a/doc/latex/classIsisMap.pdf b/doc/latex/classIsisMap.pdf Binary files differindex a31954d..8cef858 100644 --- a/doc/latex/classIsisMap.pdf +++ b/doc/latex/classIsisMap.pdf diff --git a/doc/latex/classIsisMap.tex b/doc/latex/classIsisMap.tex index 9a72945..7f37d94 100644 --- a/doc/latex/classIsisMap.tex +++ b/doc/latex/classIsisMap.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisMap:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisMap} +\includegraphics[height=5.000000cm]{classIsisMap} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -63,7 +63,11 @@ Provides mappings and schema functionalities around \hyperlink{classCinisis}{Cin \hypertarget{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409}{ \index{IsisMap@{IsisMap}!fieldHasMap@{fieldHasMap}} \index{fieldHasMap@{fieldHasMap}!IsisMap@{IsisMap}} -\subsubsection[{fieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::fieldHasMap (\$ {\em field})}} +\subsubsection[{fieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::fieldHasMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409} Check on an ISIS schema whether a field has a map. @@ -76,7 +80,12 @@ TRUE if field has a map, FALSE otherwise. \hypertarget{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}{ \index{IsisMap@{IsisMap}!getAttributes@{getAttributes}} \index{getAttributes@{getAttributes}!IsisMap@{IsisMap}} -\subsubsection[{getAttributes}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getAttributes (\$ {\em field}, \/ \$ {\em subfield} = {\ttfamily null})}} +\subsubsection[{getAttributes}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getAttributes ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield = {\ttfamily null}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a64c7193dd61a21c1af3624152d31ee51} Get attributes based on field and subfield. @@ -89,7 +98,11 @@ Attributes. \hypertarget{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{ \index{IsisMap@{IsisMap}!getDeniedCombinations@{getDeniedCombinations}} \index{getDeniedCombinations@{getDeniedCombinations}!IsisMap@{IsisMap}} -\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations (\$ {\em field})}} +\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a57808b2ac5892d71308c629b6ae990ff} Defines the denied field combinations. @@ -108,7 +121,11 @@ Sample denied combination. \hypertarget{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{ \index{IsisMap@{IsisMap}!getFieldArray@{getFieldArray}} \index{getFieldArray@{getFieldArray}!IsisMap@{IsisMap}} -\subsubsection[{getFieldArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldArray (\$ {\em field\_\-key})}} +\subsubsection[{getFieldArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldArray ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_aee1953b6e46b1612c725b2da82414d14} Get the array which defines a field. @@ -121,7 +138,11 @@ Field array. \hypertarget{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81}{ \index{IsisMap@{IsisMap}!getFieldKey@{getFieldKey}} \index{getFieldKey@{getFieldKey}!IsisMap@{IsisMap}} -\subsubsection[{getFieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldKey (\$ {\em field})}} +\subsubsection[{getFieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81} Get the key of a field entry. @@ -134,7 +155,11 @@ Field key. \hypertarget{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}{ \index{IsisMap@{IsisMap}!getFieldName@{getFieldName}} \index{getFieldName@{getFieldName}!IsisMap@{IsisMap}} -\subsubsection[{getFieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldName (\$ {\em field\_\-key})}} +\subsubsection[{getFieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ae41313537e399f15ff16a4db887cf5b9} Get a field name. @@ -147,7 +172,11 @@ Field name. \hypertarget{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}{ \index{IsisMap@{IsisMap}!getFieldNames@{getFieldNames}} \index{getFieldNames@{getFieldNames}!IsisMap@{IsisMap}} -\subsubsection[{getFieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldNames ()}} +\subsubsection[{getFieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldNames ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4} Get all field names. @@ -157,7 +186,11 @@ Array with field names. \hypertarget{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{ \index{IsisMap@{IsisMap}!getFullMap@{getFullMap}} \index{getFullMap@{getFullMap}!IsisMap@{IsisMap}} -\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap (\$ {\em field})}} +\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3} Get the full map. @@ -170,7 +203,12 @@ Array with full map or false if there is no map. \hypertarget{classIsisMap_a994934784caa4149737bda55160a459f}{ \index{IsisMap@{IsisMap}!getItemKey@{getItemKey}} \index{getItemKey@{getItemKey}!IsisMap@{IsisMap}} -\subsubsection[{getItemKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getItemKey (\$ {\em field}, \/ \$ {\em item})}} +\subsubsection[{getItemKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getItemKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a994934784caa4149737bda55160a459f} Get the item key. @@ -183,7 +221,11 @@ Item key. \hypertarget{classIsisMap_af689f27e67b0b38a3e880ead17a487f5}{ \index{IsisMap@{IsisMap}!getMainItemName@{getMainItemName}} \index{getMainItemName@{getMainItemName}!IsisMap@{IsisMap}} -\subsubsection[{getMainItemName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMainItemName (\$ {\em field})}} +\subsubsection[{getMainItemName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMainItemName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_af689f27e67b0b38a3e880ead17a487f5} Get the main field name. @@ -196,7 +238,12 @@ Main field name. \hypertarget{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce}{ \index{IsisMap@{IsisMap}!getMap@{getMap}} \index{getMap@{getMap}!IsisMap@{IsisMap}} -\subsubsection[{getMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMap (\$ {\em field}, \/ \$ {\em subfield} = {\ttfamily NULL})}} +\subsubsection[{getMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce} Determine which model field an ISIS db field should be mapped to. When importing an ISIS database to another system, a mapping provided in the database schema can be used to put the originating entries (fields and subfields) in the right place at the destination database. @@ -221,7 +268,11 @@ A map destination to the field or subfield. \hypertarget{classIsisMap_a62b933be483fb6704e12e41f10286cd5}{ \index{IsisMap@{IsisMap}!getMapType@{getMapType}} \index{getMapType@{getMapType}!IsisMap@{IsisMap}} -\subsubsection[{getMapType}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMapType (\$ {\em field})}} +\subsubsection[{getMapType}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMapType ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a62b933be483fb6704e12e41f10286cd5} Get the mapping type of a given field. @@ -234,7 +285,12 @@ The mapping type. \hypertarget{classIsisMap_ae5d904b8407b38751656715fb9efd7cf}{ \index{IsisMap@{IsisMap}!getSubfieldKey@{getSubfieldKey}} \index{getSubfieldKey@{getSubfieldKey}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldKey (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{getSubfieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ae5d904b8407b38751656715fb9efd7cf} Get the key of a subfield entry. @@ -247,7 +303,11 @@ Subfield key. \hypertarget{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4}{ \index{IsisMap@{IsisMap}!getSubfieldList@{getSubfieldList}} \index{getSubfieldList@{getSubfieldList}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldList}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldList (\$ {\em field})}} +\subsubsection[{getSubfieldList}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldList ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4} Get the list of subfields from a given field. @@ -257,7 +317,13 @@ Get the list of subfields from a given field. \hypertarget{classIsisMap_a58d739ea1f014befdafef7035d46c074}{ \index{IsisMap@{IsisMap}!getSubfieldName@{getSubfieldName}} \index{getSubfieldName@{getSubfieldName}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName (\$ {\em field}, \/ \$ {\em subfield\_\-key}, \/ \$ {\em by\_\-key} = {\ttfamily FALSE})}} +\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield\_\-key, } +\item[{\$}]{ by\_\-key = {\ttfamily FALSE}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a58d739ea1f014befdafef7035d46c074} Get a subfield name. @@ -270,7 +336,11 @@ Subfield name. \hypertarget{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}{ \index{IsisMap@{IsisMap}!getSubfieldNames@{getSubfieldNames}} \index{getSubfieldNames@{getSubfieldNames}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldNames (\$ {\em field\_\-key})}} +\subsubsection[{getSubfieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldNames ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68} Get all subfield names. @@ -283,7 +353,11 @@ Array with subfield names. \hypertarget{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117}{ \index{IsisMap@{IsisMap}!mapName@{mapName}} \index{mapName@{mapName}!IsisMap@{IsisMap}} -\subsubsection[{mapName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::mapName (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{mapName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::mapName ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117} Build a map name. @@ -296,7 +370,11 @@ Map name \hypertarget{classIsisMap_af80aedabfeca623a9022dfcbc95d591c}{ \index{IsisMap@{IsisMap}!methodName@{methodName}} \index{methodName@{methodName}!IsisMap@{IsisMap}} -\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::methodName (\$ {\em type})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::methodName ( +\begin{DoxyParamCaption} +\item[{\$}]{ type} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_af80aedabfeca623a9022dfcbc95d591c} Guess a method name from a type. @@ -309,7 +387,11 @@ Method name. \hypertarget{classIsisMap_ae2abf0591a4862f537fa23537ffca705}{ \index{IsisMap@{IsisMap}!normalizeFieldName@{normalizeFieldName}} \index{normalizeFieldName@{normalizeFieldName}!IsisMap@{IsisMap}} -\subsubsection[{normalizeFieldName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::normalizeFieldName (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{normalizeFieldName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::normalizeFieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_ae2abf0591a4862f537fa23537ffca705} Normalize field names. @@ -322,7 +404,12 @@ Normalized field name \hypertarget{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9}{ \index{IsisMap@{IsisMap}!subfieldHasMap@{subfieldHasMap}} \index{subfieldHasMap@{subfieldHasMap}!IsisMap@{IsisMap}} -\subsubsection[{subfieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::subfieldHasMap (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{subfieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::subfieldHasMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9} Check on an ISIS schema whether a subfield has a map. diff --git a/doc/latex/classIsisMethodIterator.tex b/doc/latex/classIsisMethodIterator.tex index 38614f7..589dbb6 100644 --- a/doc/latex/classIsisMethodIterator.tex +++ b/doc/latex/classIsisMethodIterator.tex @@ -26,7 +26,12 @@ Iterates over all callable methods for database mapping. \hypertarget{classIsisMethodIterator_a63918446ce5cb16c55166a23dcf6ac0f}{ \index{IsisMethodIterator@{IsisMethodIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::\_\-\_\-construct (\$ {\em isis}, \/ \$ {\em class} = {\ttfamily NULL})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ isis, } +\item[{\$}]{ class = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_a63918446ce5cb16c55166a23dcf6ac0f} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisMethodIterator_a1d7236d349cd282c4c0ff6ec8f186e93}{ \index{IsisMethodIterator@{IsisMethodIterator}!current@{current}} \index{current@{current}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_a1d7236d349cd282c4c0ff6ec8f186e93} Return the current element. \hypertarget{classIsisMethodIterator_ad750f5dd57dcb6480f64f9ac703492fc}{ \index{IsisMethodIterator@{IsisMethodIterator}!key@{key}} \index{key@{key}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_ad750f5dd57dcb6480f64f9ac703492fc} Return the key of the current element. \hypertarget{classIsisMethodIterator_a8a02e17d6597ba1f199bd82ab9fc1b32}{ \index{IsisMethodIterator@{IsisMethodIterator}!next@{next}} \index{next@{next}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_a8a02e17d6597ba1f199bd82ab9fc1b32} Move forward to next element. The method should be callable, otherwise we move to the next position. \hypertarget{classIsisMethodIterator_a1a0ee1617a50e6aa57fe80cd0c2023df}{ \index{IsisMethodIterator@{IsisMethodIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_a1a0ee1617a50e6aa57fe80cd0c2023df} Rewind the Iterator to the first valid element. \hypertarget{classIsisMethodIterator_acb2ac4c3a336d9c6c25d97bd47f60759}{ \index{IsisMethodIterator@{IsisMethodIterator}!valid@{valid}} \index{valid@{valid}!IsisMethodIterator@{IsisMethodIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisMethodIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMethodIterator_acb2ac4c3a336d9c6c25d97bd47f60759} Check if there is a current element after calls to \hyperlink{classIsisMethodIterator_a1a0ee1617a50e6aa57fe80cd0c2023df}{rewind()} or \hyperlink{classIsisMethodIterator_a8a02e17d6597ba1f199bd82ab9fc1b32}{next()}. diff --git a/doc/latex/classIsisNormalItemFilterIterator.tex b/doc/latex/classIsisNormalItemFilterIterator.tex index 30d095f..63f5949 100644 --- a/doc/latex/classIsisNormalItemFilterIterator.tex +++ b/doc/latex/classIsisNormalItemFilterIterator.tex @@ -16,7 +16,11 @@ Isis normal subfield iterator. Filter out special subfields. \hypertarget{classIsisNormalItemFilterIterator_ad3ef2ecdafb6a163a01b199a7e98cd6f}{ \index{IsisNormalItemFilterIterator@{IsisNormalItemFilterIterator}!accept@{accept}} \index{accept@{accept}!IsisNormalItemFilterIterator@{IsisNormalItemFilterIterator}} -\subsubsection[{accept}]{\setlength{\rightskip}{0pt plus 5cm}IsisNormalItemFilterIterator::accept ()}} +\subsubsection[{accept}]{\setlength{\rightskip}{0pt plus 5cm}IsisNormalItemFilterIterator::accept ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisNormalItemFilterIterator_ad3ef2ecdafb6a163a01b199a7e98cd6f} Filter out special subfields. diff --git a/doc/latex/classIsisReader.eps b/doc/latex/classIsisReader.eps index 7d4c258..881135d 100644 --- a/doc/latex/classIsisReader.eps +++ b/doc/latex/classIsisReader.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 1030.93 +%%BoundingBox: 0 0 500 1030.927835 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.485 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.485000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -189,27 +189,27 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisReader) 0 4 box - (IsisMap) 0 3 box - (IsisConnector) 0 2 box - (IsisFinder) 0 1 box - (IsisAudit) 0 0 box + (IsisReader) 0.000000 4.000000 box + (IsisMap) 0.000000 3.000000 box + (IsisConnector) 0.000000 2.000000 box + (IsisFinder) 0.000000 1.000000 box + (IsisAudit) 0.000000 0.000000 box % ----- relations ----- solid -1 0 3.25 out +1 0.000000 3.250000 out solid -0 0 3.75 in +0 0.000000 3.750000 in solid -1 0 2.25 out +1 0.000000 2.250000 out solid -0 0 2.75 in +0 0.000000 2.750000 in solid -1 0 1.25 out +1 0.000000 1.250000 out solid -0 0 1.75 in +0 0.000000 1.750000 in solid -1 0 0.25 out +1 0.000000 0.250000 out solid -0 0 0.75 in +0 0.000000 0.750000 in diff --git a/doc/latex/classIsisReader.pdf b/doc/latex/classIsisReader.pdf Binary files differindex f2baa84..5356e2e 100644 --- a/doc/latex/classIsisReader.pdf +++ b/doc/latex/classIsisReader.pdf diff --git a/doc/latex/classIsisReader.tex b/doc/latex/classIsisReader.tex index 2ef116a..cfc98f7 100644 --- a/doc/latex/classIsisReader.tex +++ b/doc/latex/classIsisReader.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisReader:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisReader} +\includegraphics[height=5.000000cm]{classIsisReader} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -42,7 +42,11 @@ Provides basic Isis read capabilities around \hyperlink{classCinisis}{Cinisis}. \hypertarget{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac}{ \index{IsisReader@{IsisReader}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisReader@{IsisReader}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::\_\-\_\-construct (\$ {\em config} = {\ttfamily null})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ config = {\ttfamily null}} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a70d1444cf56269795b4947dd82b2a4ac} Constructor. @@ -50,7 +54,11 @@ Constructor. \hypertarget{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e}{ \index{IsisReader@{IsisReader}!explodeBrackets@{explodeBrackets}} \index{explodeBrackets@{explodeBrackets}!IsisReader@{IsisReader}} -\subsubsection[{explodeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeBrackets (\$ {\em subject})}} +\subsubsection[{explodeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ subject} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a4610ebcf69c197e2c596965e2dc0358e} Explode a bracketed string into values. Just strings inside brackets are returned. @@ -63,7 +71,11 @@ Array of matched strings. \hypertarget{classIsisReader_a3cc08df25da082046d496db93778709b}{ \index{IsisReader@{IsisReader}!explodeValue@{explodeValue}} \index{explodeValue@{explodeValue}!IsisReader@{IsisReader}} -\subsubsection[{explodeValue}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeValue (\$ {\em value})}} +\subsubsection[{explodeValue}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::explodeValue ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a3cc08df25da082046d496db93778709b} Explode values from fields or subfields. Split values inside brackets if needed, but then doesn't return any value outside brackets. @@ -76,7 +88,11 @@ Array with values. \hypertarget{classIsisReader_aa6099ed6bd276b32bd7bba184f144529}{ \index{IsisReader@{IsisReader}!filterBrackets@{filterBrackets}} \index{filterBrackets@{filterBrackets}!IsisReader@{IsisReader}} -\subsubsection[{filterBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::filterBrackets (\$ {\em values})}} +\subsubsection[{filterBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::filterBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ values} +\end{DoxyParamCaption} +)}} \label{classIsisReader_aa6099ed6bd276b32bd7bba184f144529} Filter out brackets from strings. @@ -89,7 +105,11 @@ Filtered string or array. \hypertarget{classIsisReader_a109a6ef49b2190bfbcee796dae954baf}{ \index{IsisReader@{IsisReader}!hasBrackets@{hasBrackets}} \index{hasBrackets@{hasBrackets}!IsisReader@{IsisReader}} -\subsubsection[{hasBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::hasBrackets (\$ {\em value})}} +\subsubsection[{hasBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::hasBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a109a6ef49b2190bfbcee796dae954baf} Check if a string has brackets. @@ -102,7 +122,11 @@ True if string has brackets, false otherwise. \hypertarget{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904}{ \index{IsisReader@{IsisReader}!joinSubfields@{joinSubfields}} \index{joinSubfields@{joinSubfields}!IsisReader@{IsisReader}} -\subsubsection[{joinSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::joinSubfields ()}} +\subsubsection[{joinSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::joinSubfields ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisReader_ae65e172e3b5c9ac3c8a5e1352ba80904} Whether to join field and subfields in a single array. @@ -112,7 +136,11 @@ Boolean. \hypertarget{classIsisReader_afa6e3d3d94854913e5ed2604919d2316}{ \index{IsisReader@{IsisReader}!open@{open}} \index{open@{open}!IsisReader@{IsisReader}} -\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::open (\$ {\em config})}} +\subsubsection[{open}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::open ( +\begin{DoxyParamCaption} +\item[{\$}]{ config} +\end{DoxyParamCaption} +)}} \label{classIsisReader_afa6e3d3d94854913e5ed2604919d2316} Open a database. @@ -122,7 +150,11 @@ Open a database. \hypertarget{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{ \index{IsisReader@{IsisReader}!read@{read}} \index{read@{read}!IsisReader@{IsisReader}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::read (\$ {\em entry})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ entry} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a630791a319bec2bc55d0102cbb7f93df} Alias to \$isis-\/$>$db-\/$>$\hyperlink{classIsisReader_a630791a319bec2bc55d0102cbb7f93df}{read()}. @@ -135,7 +167,11 @@ Resulting data. \hypertarget{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e}{ \index{IsisReader@{IsisReader}!removeBrackets@{removeBrackets}} \index{removeBrackets@{removeBrackets}!IsisReader@{IsisReader}} -\subsubsection[{removeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBrackets (\$ {\em value})}} +\subsubsection[{removeBrackets}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBrackets ( +\begin{DoxyParamCaption} +\item[{\$}]{ value} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a99ce7b10b2997dad6a64558ac1f9f10e} Remove brackets from strings whithin an array. @@ -148,7 +184,11 @@ Array with strings without brackets. \hypertarget{classIsisReader_acba8842f0033356fff66c0f88391921e}{ \index{IsisReader@{IsisReader}!removeBracketsCallback@{removeBracketsCallback}} \index{removeBracketsCallback@{removeBracketsCallback}!IsisReader@{IsisReader}} -\subsubsection[{removeBracketsCallback}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsCallback (\&\$ {\em value} = {\ttfamily NULL})}} +\subsubsection[{removeBracketsCallback}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsCallback ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ value = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classIsisReader_acba8842f0033356fff66c0f88391921e} Remove brackets from strings whithin an array. Callback version @@ -158,7 +198,11 @@ Remove brackets from strings whithin an array. Callback version \hypertarget{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724}{ \index{IsisReader@{IsisReader}!removeBracketsFromArray@{removeBracketsFromArray}} \index{removeBracketsFromArray@{removeBracketsFromArray}!IsisReader@{IsisReader}} -\subsubsection[{removeBracketsFromArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsFromArray (\&\$ {\em values})}} +\subsubsection[{removeBracketsFromArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisReader::removeBracketsFromArray ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ values} +\end{DoxyParamCaption} +)}} \label{classIsisReader_a60ece3bbe11a2b4ac6afa6e65f282724} Remove brackets from strings whithin an array. diff --git a/doc/latex/classIsisRowIterator.tex b/doc/latex/classIsisRowIterator.tex index ead6d26..b962bed 100644 --- a/doc/latex/classIsisRowIterator.tex +++ b/doc/latex/classIsisRowIterator.tex @@ -26,7 +26,12 @@ Iterates over all rows from a field result. \hypertarget{classIsisRowIterator_acaab99d2bf18f6f958ddf07db55cb15d}{ \index{IsisRowIterator@{IsisRowIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_acaab99d2bf18f6f958ddf07db55cb15d} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisRowIterator_abe18cfd484f70348fb5832444186b10d}{ \index{IsisRowIterator@{IsisRowIterator}!current@{current}} \index{current@{current}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_abe18cfd484f70348fb5832444186b10d} Return the current element. \hypertarget{classIsisRowIterator_a96f65bca7f2e048a449e6f316d802e6f}{ \index{IsisRowIterator@{IsisRowIterator}!key@{key}} \index{key@{key}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_a96f65bca7f2e048a449e6f316d802e6f} Return the key of the current element. \hypertarget{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853}{ \index{IsisRowIterator@{IsisRowIterator}!next@{next}} \index{next@{next}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853} Move forward to next element. \hypertarget{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf}{ \index{IsisRowIterator@{IsisRowIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf} Rewind the Iterator to the first element. \hypertarget{classIsisRowIterator_a69cb2b1c6e8feaffcfe65363a9178b72}{ \index{IsisRowIterator@{IsisRowIterator}!valid@{valid}} \index{valid@{valid}!IsisRowIterator@{IsisRowIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisRowIterator_a69cb2b1c6e8feaffcfe65363a9178b72} Check if there is a current element after calls to \hyperlink{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf}{rewind()} or \hyperlink{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853}{next()}. diff --git a/doc/latex/classIsisSubfieldIterator.tex b/doc/latex/classIsisSubfieldIterator.tex index 9f2f193..2fea9e8 100644 --- a/doc/latex/classIsisSubfieldIterator.tex +++ b/doc/latex/classIsisSubfieldIterator.tex @@ -26,7 +26,13 @@ Isis subfield iterator. Iterates over subfields for each result row. \hypertarget{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field, } +\item[{\$}]{ main = {\ttfamily false}} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29} Constructor. @@ -39,27 +45,47 @@ Constructor. \hypertarget{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!current@{current}} \index{current@{current}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8} Return the current element. \hypertarget{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!key@{key}} \index{key@{key}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85} Return the key of the current element. \hypertarget{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!next@{next}} \index{next@{next}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371} Move forward to next element. \hypertarget{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40} Rewind the Iterator to the first element. \hypertarget{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{ \index{IsisSubfieldIterator@{IsisSubfieldIterator}!valid@{valid}} \index{valid@{valid}!IsisSubfieldIterator@{IsisSubfieldIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db} Check if there is a current element after calls to \hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind()} or \hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next()}. diff --git a/doc/latex/classIsisValueIterator.tex b/doc/latex/classIsisValueIterator.tex index 3447da2..9c4a26d 100644 --- a/doc/latex/classIsisValueIterator.tex +++ b/doc/latex/classIsisValueIterator.tex @@ -26,7 +26,12 @@ Isis value iterator. Iterates over all values for each result row. \hypertarget{classIsisValueIterator_a4b5811fff950f830cbba2da40dfac497}{ \index{IsisValueIterator@{IsisValueIterator}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ class, } +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a4b5811fff950f830cbba2da40dfac497} Constructor. @@ -39,27 +44,47 @@ Constructor. \hypertarget{classIsisValueIterator_ad7c6dd479b6129ba5bfc2f2003f6ca49}{ \index{IsisValueIterator@{IsisValueIterator}!current@{current}} \index{current@{current}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::current ()}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::current ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_ad7c6dd479b6129ba5bfc2f2003f6ca49} Return the current element. \hypertarget{classIsisValueIterator_a173b393699278fb2fb928e6bd2448a05}{ \index{IsisValueIterator@{IsisValueIterator}!key@{key}} \index{key@{key}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::key ()}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::key ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a173b393699278fb2fb928e6bd2448a05} Return the key of the current element. \hypertarget{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9}{ \index{IsisValueIterator@{IsisValueIterator}!next@{next}} \index{next@{next}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::next ()}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::next ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9} Move forward to next element. \hypertarget{classIsisValueIterator_a175fe47671b335eecc591598053a6a88}{ \index{IsisValueIterator@{IsisValueIterator}!rewind@{rewind}} \index{rewind@{rewind}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::rewind ()}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::rewind ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a175fe47671b335eecc591598053a6a88} Rewind the Iterator to the first element. \hypertarget{classIsisValueIterator_a7f6b3e0941c2110f1b2ba10ba2b87fb8}{ \index{IsisValueIterator@{IsisValueIterator}!valid@{valid}} \index{valid@{valid}!IsisValueIterator@{IsisValueIterator}} -\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::valid ()}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisValueIterator::valid ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisValueIterator_a7f6b3e0941c2110f1b2ba10ba2b87fb8} Check if there is a current element after calls to \hyperlink{classIsisValueIterator_a175fe47671b335eecc591598053a6a88}{rewind()} or \hyperlink{classIsisValueIterator_adc2fb9b1dd029cab4be0b48d6e0f11f9}{next()}. diff --git a/doc/latex/classMaleteDb.eps b/doc/latex/classMaleteDb.eps index 01ae186..7525918 100644 --- a/doc/latex/classMaleteDb.eps +++ b/doc/latex/classMaleteDb.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 540.541 +%%BoundingBox: 0 0 500 540.540541 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.925 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.925000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -186,12 +186,12 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (MaleteDb) 0 0 box - (IsisDb) 0 1 box + (MaleteDb) 0.000000 0.000000 box + (IsisDb) 0.000000 1.000000 box % ----- relations ----- solid -0 0 0 out +0 0.000000 0.000000 out solid -1 0 1 in +1 0.000000 1.000000 in diff --git a/doc/latex/classMaleteDb.pdf b/doc/latex/classMaleteDb.pdf Binary files differindex a6f81f7..f0155a0 100644 --- a/doc/latex/classMaleteDb.pdf +++ b/doc/latex/classMaleteDb.pdf diff --git a/doc/latex/classMaleteDb.tex b/doc/latex/classMaleteDb.tex index 0baaf89..6787941 100644 --- a/doc/latex/classMaleteDb.tex +++ b/doc/latex/classMaleteDb.tex @@ -5,7 +5,7 @@ Inheritance diagram for MaleteDb:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=2cm]{classMaleteDb} +\includegraphics[height=2.000000cm]{classMaleteDb} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -50,7 +50,11 @@ This implementation is currently outdated and lacks basic functionalities such a \hypertarget{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2}{ \index{MaleteDb@{MaleteDb}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!MaleteDb@{MaleteDb}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\_\-\_\-construct (\$ {\em schema})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a60f87371bc1ec156b010e5b38b4c22e2} Constructor. @@ -67,7 +71,12 @@ Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb} \hypertarget{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec}{ \index{MaleteDb@{MaleteDb}!check@{check}} \index{check@{check}!MaleteDb@{MaleteDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ab2da32d84af17df79d947ae32257b4ec} Check configuration. @@ -81,7 +90,11 @@ Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb} \hypertarget{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4}{ \index{MaleteDb@{MaleteDb}!entries@{entries}} \index{entries@{entries}!MaleteDb@{MaleteDb}} -\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::entries ()}} +\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::entries ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a5c6cb09a072e5d2ddce31c77098ccba4} Return number of entries in the database. @@ -97,7 +110,11 @@ Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb} \hypertarget{classMaleteDb_a4f16c48facae498d0db1a042e9727d04}{ \index{MaleteDb@{MaleteDb}!example@{example}} \index{example@{example}!MaleteDb@{MaleteDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a4f16c48facae498d0db1a042e9727d04} Return an example schema. @@ -111,7 +128,11 @@ Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb} \hypertarget{classMaleteDb_a17562c1c53594762454d65be823fcdb5}{ \index{MaleteDb@{MaleteDb}!logger@{logger}} \index{logger@{logger}!MaleteDb@{MaleteDb}} -\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::logger (\$ {\em message})}} +\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::logger ( +\begin{DoxyParamCaption} +\item[{\$}]{ message} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_a17562c1c53594762454d65be823fcdb5} Class logger. @@ -121,7 +142,11 @@ Class logger. \hypertarget{classMaleteDb_ad2a65876db24adc388afce465e0c153e}{ \index{MaleteDb@{MaleteDb}!read@{read}} \index{read@{read}!MaleteDb@{MaleteDb}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::read (\$ {\em id})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ id} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ad2a65876db24adc388afce465e0c153e} Read an entry. @@ -137,7 +162,11 @@ Implements \hyperlink{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{IsisDb} \hypertarget{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033}{ \index{MaleteDb@{MaleteDb}!tag@{tag}} \index{tag@{tag}!MaleteDb@{MaleteDb}} -\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::tag (\$ {\em results})}} +\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}MaleteDb::tag ( +\begin{DoxyParamCaption} +\item[{\$}]{ results} +\end{DoxyParamCaption} +)}} \label{classMaleteDb_ac87c3ac1b3d9a6297be8574aa303e033} Tag results of a db query. diff --git a/doc/latex/classPhpIsisDb.eps b/doc/latex/classPhpIsisDb.eps index 753674f..1035b7d 100644 --- a/doc/latex/classPhpIsisDb.eps +++ b/doc/latex/classPhpIsisDb.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 526.316 +%%BoundingBox: 0 0 500 526.315789 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 0.95 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 0.950000 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -186,12 +186,12 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (PhpIsisDb) 0 0 box - (IsisDb) 0 1 box + (PhpIsisDb) 0.000000 0.000000 box + (IsisDb) 0.000000 1.000000 box % ----- relations ----- solid -0 0 0 out +0 0.000000 0.000000 out solid -1 0 1 in +1 0.000000 1.000000 in diff --git a/doc/latex/classPhpIsisDb.pdf b/doc/latex/classPhpIsisDb.pdf Binary files differindex cd70193..6ca9761 100644 --- a/doc/latex/classPhpIsisDb.pdf +++ b/doc/latex/classPhpIsisDb.pdf diff --git a/doc/latex/classPhpIsisDb.tex b/doc/latex/classPhpIsisDb.tex index a8ae462..903fb5c 100644 --- a/doc/latex/classPhpIsisDb.tex +++ b/doc/latex/classPhpIsisDb.tex @@ -5,7 +5,7 @@ Inheritance diagram for PhpIsisDb:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=2cm]{classPhpIsisDb} +\includegraphics[height=2.000000cm]{classPhpIsisDb} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -53,7 +53,11 @@ This implementation is currently outdated and lacks basic functionalities such a \hypertarget{classPhpIsisDb_abb6db51373d065baf9135fd278653bc5}{ \index{PhpIsisDb@{PhpIsisDb}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::\_\-\_\-construct (\$ {\em schema})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_abb6db51373d065baf9135fd278653bc5} Constructor. @@ -70,7 +74,11 @@ Implements \hyperlink{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{IsisDb} \hypertarget{classPhpIsisDb_a46f8c39b305f170e2cf8ae5f4d218e74}{ \index{PhpIsisDb@{PhpIsisDb}!charset@{charset}} \index{charset@{charset}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::charset (\&\$ {\em data})}} +\subsubsection[{charset}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::charset ( +\begin{DoxyParamCaption} +\item[{\&\$}]{ data} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_a46f8c39b305f170e2cf8ae5f4d218e74} Charset conversion. @@ -85,7 +93,12 @@ String converted to UTF-\/8. \hypertarget{classPhpIsisDb_a23761cc04114090a2863467b2accc80a}{ \index{PhpIsisDb@{PhpIsisDb}!check@{check}} \index{check@{check}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static PhpIsisDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static PhpIsisDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classPhpIsisDb_a23761cc04114090a2863467b2accc80a} Check configuration. @@ -99,7 +112,11 @@ Implements \hyperlink{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{IsisDb} \hypertarget{classPhpIsisDb_a0491ce84e5a85e775f811f18e63ef0fb}{ \index{PhpIsisDb@{PhpIsisDb}!entries@{entries}} \index{entries@{entries}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::entries ()}} +\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::entries ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_a0491ce84e5a85e775f811f18e63ef0fb} Return number of entries in the database. @@ -113,7 +130,11 @@ Implements \hyperlink{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{IsisDb} \hypertarget{classPhpIsisDb_a7f4f3a9fd6dab86bd3cb3149d65f92cd}{ \index{PhpIsisDb@{PhpIsisDb}!example@{example}} \index{example@{example}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_a7f4f3a9fd6dab86bd3cb3149d65f92cd} Return an example schema. @@ -127,7 +148,11 @@ Implements \hyperlink{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{IsisDb} \hypertarget{classPhpIsisDb_a8d8185060a26d4fe673844b2ea3db39a}{ \index{PhpIsisDb@{PhpIsisDb}!logger@{logger}} \index{logger@{logger}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::logger (\$ {\em message})}} +\subsubsection[{logger}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::logger ( +\begin{DoxyParamCaption} +\item[{\$}]{ message} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_a8d8185060a26d4fe673844b2ea3db39a} Class logger. @@ -137,7 +162,11 @@ Class logger. \hypertarget{classPhpIsisDb_af2266931746f6f2335b831be8b8333fb}{ \index{PhpIsisDb@{PhpIsisDb}!read@{read}} \index{read@{read}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::read (\$ {\em id})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ id} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_af2266931746f6f2335b831be8b8333fb} Read an entry. @@ -155,7 +184,11 @@ Implements \hyperlink{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{IsisDb} \hypertarget{classPhpIsisDb_a849f238c3323f53431be1c225a914d98}{ \index{PhpIsisDb@{PhpIsisDb}!tag@{tag}} \index{tag@{tag}!PhpIsisDb@{PhpIsisDb}} -\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::tag (\$ {\em results})}} +\subsubsection[{tag}]{\setlength{\rightskip}{0pt plus 5cm}PhpIsisDb::tag ( +\begin{DoxyParamCaption} +\item[{\$}]{ results} +\end{DoxyParamCaption} +)}} \label{classPhpIsisDb_a849f238c3323f53431be1c225a914d98} Tag results of a db query. diff --git a/doc/latex/classSchemaDb.tex b/doc/latex/classSchemaDb.tex index d2a5c1c..8cee477 100644 --- a/doc/latex/classSchemaDb.tex +++ b/doc/latex/classSchemaDb.tex @@ -25,7 +25,12 @@ static \hyperlink{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61}{check} (\$sch \hypertarget{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61}{ \index{SchemaDb@{SchemaDb}!check@{check}} \index{check@{check}!SchemaDb@{SchemaDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classSchemaDb_a42acc85b08a20b121204b1caf3a83e61} Recursively check for required fields in a database schema. @@ -35,7 +40,11 @@ Recursively check for required fields in a database schema. \hypertarget{classSchemaDb_a923a94169459c4dee3f74000b4aa1807}{ \index{SchemaDb@{SchemaDb}!example@{example}} \index{example@{example}!SchemaDb@{SchemaDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classSchemaDb_a923a94169459c4dee3f74000b4aa1807} Return an example database schema. @@ -45,7 +54,11 @@ Return an example database schema. \hypertarget{classSchemaDb_af5c9271759bed2f9cccc80a05f7c5da8}{ \index{SchemaDb@{SchemaDb}!optional@{optional}} \index{optional@{optional}!SchemaDb@{SchemaDb}} -\subsubsection[{optional}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::optional ()}} +\subsubsection[{optional}]{\setlength{\rightskip}{0pt plus 5cm}SchemaDb::optional ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classSchemaDb_af5c9271759bed2f9cccc80a05f7c5da8} Return the optional database config. @@ -55,7 +68,11 @@ Array with optional config. \hypertarget{classSchemaDb_a31db21bccb179162b5bb02b14b72d3e3}{ \index{SchemaDb@{SchemaDb}!required@{required}} \index{required@{required}!SchemaDb@{SchemaDb}} -\subsubsection[{required}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::required ()\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{required}]{\setlength{\rightskip}{0pt plus 5cm}static SchemaDb::required ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classSchemaDb_a31db21bccb179162b5bb02b14b72d3e3} Return the required database config. diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty index ce4cd41..0f57a37 100644 --- a/doc/latex/doxygen.sty +++ b/doc/latex/doxygen.sty @@ -27,9 +27,9 @@ \fancyplain{}{\bfseries\thepage}% } \rfoot[\fancyplain{}{\bfseries\scriptsize% - Generated on Mon Sep 20 13:53:30 2010 for Cinisis Database Reader by Doxygen }]{} + Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Mon Sep 20 13:53:30 2010 for Cinisis Database Reader by Doxygen }} + Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by Doxygen }} \cfoot{} %---------- Internal commands used in this style file ---------------- @@ -252,6 +252,12 @@ \end{DoxyDesc}% } +% is used for parameters within a detailed function description +\newenvironment{DoxyParamCaption}{% + \renewcommand{\item}[2][]{##1 {\em ##2}}% + }{% +} + % Used by return value lists \newenvironment{DoxyRetVals}[1]{% \begin{DoxyDesc}{#1}% diff --git a/doc/latex/interfaceIsisDb.eps b/doc/latex/interfaceIsisDb.eps index 2729738..7a6b051 100644 --- a/doc/latex/interfaceIsisDb.eps +++ b/doc/latex/interfaceIsisDb.eps @@ -5,7 +5,7 @@ %%For: %Magnification: 1.00 %%Orientation: Portrait -%%BoundingBox: 0 0 500 156.863 +%%BoundingBox: 0 0 500 156.862745 %%Pages: 0 %%BeginSetup %%EndSetup @@ -19,7 +19,7 @@ /marginwidth 10 def /distx 20 def /disty 40 def -/boundaspect 3.1875 def % aspect ratio of the BoundingBox (width/height) +/boundaspect 3.187500 def % aspect ratio of the BoundingBox (width/height) /boundx 500 def /boundy boundx boundaspect div def /xspacing 0 def @@ -188,20 +188,20 @@ boundx scalefactor div boundy scalefactor div scale % ----- classes ----- - (IsisDb) 1 1 box - (BiblioIsisDb) 0 0 box - (MaleteDb) 1 0 box - (PhpIsisDb) 2 0 box + (IsisDb) 1.000000 1.000000 box + (BiblioIsisDb) 0.000000 0.000000 box + (MaleteDb) 1.000000 0.000000 box + (PhpIsisDb) 2.000000 0.000000 box % ----- relations ----- solid -1 1 0.25 out +1 1.000000 0.250000 out solid -0 2 1 conn +0.000000 2.000000 1.000000 conn solid -0 0 0.75 in +0 0.000000 0.750000 in solid -0 1 0.75 in +0 1.000000 0.750000 in solid -0 2 0.75 in +0 2.000000 0.750000 in diff --git a/doc/latex/interfaceIsisDb.pdf b/doc/latex/interfaceIsisDb.pdf Binary files differindex 73b3acb..c721be0 100644 --- a/doc/latex/interfaceIsisDb.pdf +++ b/doc/latex/interfaceIsisDb.pdf diff --git a/doc/latex/interfaceIsisDb.tex b/doc/latex/interfaceIsisDb.tex index 9d7a637..1ec70f4 100644 --- a/doc/latex/interfaceIsisDb.tex +++ b/doc/latex/interfaceIsisDb.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisDb:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=2cm]{interfaceIsisDb} +\includegraphics[height=2.000000cm]{interfaceIsisDb} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -33,7 +33,11 @@ Generic interface for reading Isis databases. \hypertarget{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b}{ \index{IsisDb@{IsisDb}!\_\-\_\-construct@{\_\-\_\-construct}} \index{\_\-\_\-construct@{\_\-\_\-construct}!IsisDb@{IsisDb}} -\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::\_\-\_\-construct (\$ {\em schema})}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::\_\-\_\-construct ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema} +\end{DoxyParamCaption} +)}} \label{interfaceIsisDb_ae1c0a3496d55f710d34c5c19ada7a66b} Constructor. @@ -58,7 +62,12 @@ Implemented in \hyperlink{classBiblioIsisDb_ab2c5ec782b324847e104d8ad35a230af}{B \hypertarget{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8}{ \index{IsisDb@{IsisDb}!check@{check}} \index{check@{check}!IsisDb@{IsisDb}} -\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static IsisDb::check (\$ {\em schema}, \/ \$ {\em section} = {\ttfamily NULL})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{check}]{\setlength{\rightskip}{0pt plus 5cm}static IsisDb::check ( +\begin{DoxyParamCaption} +\item[{\$}]{ schema, } +\item[{\$}]{ section = {\ttfamily NULL}} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{interfaceIsisDb_af681b8f990b579f1835aa7ba4c83f1b8} Configuration check. @@ -75,7 +84,11 @@ Implemented in \hyperlink{classBiblioIsisDb_a929467f1907d3aeaeebe493f0c188c5b}{B \hypertarget{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff}{ \index{IsisDb@{IsisDb}!entries@{entries}} \index{entries@{entries}!IsisDb@{IsisDb}} -\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::entries ()}} +\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::entries ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{interfaceIsisDb_a86f38eca2b6d0835b60770d8a4e511ff} Return number of entries in the database. @@ -89,7 +102,11 @@ Implemented in \hyperlink{classBiblioIsisDb_ab6b0a977c066c25c6bdca5c1d3a083e8}{B \hypertarget{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6}{ \index{IsisDb@{IsisDb}!example@{example}} \index{example@{example}!IsisDb@{IsisDb}} -\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::example ()}} +\subsubsection[{example}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::example ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{interfaceIsisDb_a857c10d90da64067efa17afb2f32edb6} Return an example database schema. @@ -105,7 +122,11 @@ Implemented in \hyperlink{classBiblioIsisDb_a8e76b289b9e3a9893b9469094753d2bc}{B \hypertarget{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686}{ \index{IsisDb@{IsisDb}!read@{read}} \index{read@{read}!IsisDb@{IsisDb}} -\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::read (\$ {\em id})}} +\subsubsection[{read}]{\setlength{\rightskip}{0pt plus 5cm}IsisDb::read ( +\begin{DoxyParamCaption} +\item[{\$}]{ id} +\end{DoxyParamCaption} +)}} \label{interfaceIsisDb_a68335ec0db01ef03f0725621b38b5686} Read an entry from the database. diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index de3a981..9bd6143 100644 --- a/doc/latex/refman.tex +++ b/doc/latex/refman.tex @@ -39,9 +39,9 @@ \begin{center} {\Large Cinisis Database Reader }\\ \vspace*{1cm} -{\large Generated by Doxygen 1.6.3}\\ +{\large Generated by Doxygen 1.7.1}\\ \vspace*{0.5cm} -{\small Mon Sep 20 13:53:30 2010}\\ +{\small Tue Feb 22 2011 10:19:13}\\ \end{center} \end{titlepage} \clearemptydoublepage @@ -50,6 +50,8 @@ \clearemptydoublepage \pagenumbering{arabic} \hypersetup{pageanchor=true} +\chapter{Cinisis Database Reader} +\label{index}\hypertarget{index}{}\input{index} \chapter{Todo List} \label{todo} \hypertarget{todo}{} @@ -60,25 +62,25 @@ \input{annotated} \chapter{Class Documentation} \input{classBiblioIsisDb} -\include{classCinisis} -\include{classCinisisDisplayHelper} -\include{classCinisisHttpHelper} -\include{classIsisAudit} -\include{classIsisConnector} -\include{interfaceIsisDb} -\include{classIsisEntryIterator} -\include{classIsisFinder} -\include{classIsisItemIterator} -\include{classIsisMainItemIterator} -\include{classIsisMap} -\include{classIsisMethodIterator} -\include{classIsisNormalItemFilterIterator} -\include{classIsisReader} -\include{classIsisRowIterator} -\include{classIsisSubfieldIterator} -\include{classIsisValueIterator} -\include{classMaleteDb} -\include{classPhpIsisDb} -\include{classSchemaDb} +\input{classCinisis} +\input{classCinisisDisplayHelper} +\input{classCinisisHttpHelper} +\input{classIsisAudit} +\input{classIsisConnector} +\input{interfaceIsisDb} +\input{classIsisEntryIterator} +\input{classIsisFinder} +\input{classIsisItemIterator} +\input{classIsisMainItemIterator} +\input{classIsisMap} +\input{classIsisMethodIterator} +\input{classIsisNormalItemFilterIterator} +\input{classIsisReader} +\input{classIsisRowIterator} +\input{classIsisSubfieldIterator} +\input{classIsisValueIterator} +\input{classMaleteDb} +\input{classPhpIsisDb} +\input{classSchemaDb} \printindex \end{document} |