docs(Doxyfile,docs): added doxygen config and initial built doc
This commit is contained in:
42
docs/latex/Makefile
Normal file
42
docs/latex/Makefile
Normal file
@@ -0,0 +1,42 @@
|
||||
LATEX_CMD?=pdflatex
|
||||
MKIDX_CMD?=makeindex
|
||||
BIBTEX_CMD?=bibtex
|
||||
LATEX_COUNT?=8
|
||||
MANUAL_FILE?=refman
|
||||
|
||||
all: $(MANUAL_FILE).pdf
|
||||
|
||||
pdf: $(MANUAL_FILE).pdf
|
||||
|
||||
$(MANUAL_FILE).pdf: clean $(MANUAL_FILE).tex
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
latex_count=$(LATEX_COUNT) ; \
|
||||
while grep -E -s 'Rerun (LaTeX|to get cross-references right|to get bibliographical references right)' $(MANUAL_FILE).log && [ $$latex_count -gt 0 ] ;\
|
||||
do \
|
||||
echo "Rerunning latex...." ;\
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi; \
|
||||
latex_count=`expr $$latex_count - 1` ;\
|
||||
done
|
||||
$(MKIDX_CMD) $(MANUAL_FILE).idx
|
||||
$(LATEX_CMD) $(MANUAL_FILE) || \
|
||||
if [ $$? != 0 ] ; then \
|
||||
\echo "Please consult $(MANUAL_FILE).log to see the error messages" ; \
|
||||
false; \
|
||||
fi
|
||||
|
||||
clean:
|
||||
rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out *.brf *.blg *.bbl $(MANUAL_FILE).pdf
|
||||
16
docs/latex/_d_object_8cpp.tex
Normal file
16
docs/latex/_d_object_8cpp.tex
Normal file
@@ -0,0 +1,16 @@
|
||||
\doxysection{src/dobj/private/\+DObject.cpp File Reference}
|
||||
\hypertarget{_d_object_8cpp}{}\label{_d_object_8cpp}\index{src/dobj/private/DObject.cpp@{src/dobj/private/DObject.cpp}}
|
||||
|
||||
|
||||
Implementation of the \doxylink{class_d_object}{DObject} class.
|
||||
|
||||
|
||||
{\ttfamily \#include "{}DObject.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$iostream$>$}\newline
|
||||
{\ttfamily \#include $<$stdexcept$>$}\newline
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Implementation of the \doxylink{class_d_object}{DObject} class.
|
||||
|
||||
Provides the implementation for a universal data container with plugin support.
|
||||
26
docs/latex/_d_object_8h.tex
Normal file
26
docs/latex/_d_object_8h.tex
Normal file
@@ -0,0 +1,26 @@
|
||||
\doxysection{src/dobj/public/\+DObject.h File Reference}
|
||||
\hypertarget{_d_object_8h}{}\label{_d_object_8h}\index{src/dobj/public/DObject.h@{src/dobj/public/DObject.h}}
|
||||
|
||||
|
||||
Defines the \doxylink{class_d_object}{DObject} class, a universal data container for the project.
|
||||
|
||||
|
||||
{\ttfamily \#include "{}Metadata.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$variant$>$}\newline
|
||||
{\ttfamily \#include $<$memory$>$}\newline
|
||||
{\ttfamily \#include $<$vector$>$}\newline
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$mutex$>$}\newline
|
||||
{\ttfamily \#include $<$map$>$}\newline
|
||||
{\ttfamily \#include $<$functional$>$}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \mbox{\hyperlink{class_d_object}{DObject}}
|
||||
\begin{DoxyCompactList}\small\item\em A universal data container class. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Defines the \doxylink{class_d_object}{DObject} class, a universal data container for the project.
|
||||
|
||||
The \doxylink{class_d_object}{DObject} class encapsulates arbitrary data and its associated metadata, providing a consistent interface for public-\/facing functions. It includes support for dynamically registered plugins.
|
||||
62
docs/latex/_d_object_8h_source.tex
Normal file
62
docs/latex/_d_object_8h_source.tex
Normal file
@@ -0,0 +1,62 @@
|
||||
\doxysection{DObject.\+h}
|
||||
\hypertarget{_d_object_8h_source}{}\label{_d_object_8h_source}\index{src/dobj/public/DObject.h@{src/dobj/public/DObject.h}}
|
||||
\mbox{\hyperlink{_d_object_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{00001\ \textcolor{preprocessor}{\#ifndef\ DOBJECT\_H}}
|
||||
\DoxyCodeLine{00002\ \textcolor{preprocessor}{\#define\ DOBJECT\_H}}
|
||||
\DoxyCodeLine{00003\ }
|
||||
\DoxyCodeLine{00004\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{_metadata_8h}{Metadata.h}}"{}}}
|
||||
\DoxyCodeLine{00005\ \textcolor{preprocessor}{\#include\ <variant>}}
|
||||
\DoxyCodeLine{00006\ \textcolor{preprocessor}{\#include\ <memory>}}
|
||||
\DoxyCodeLine{00007\ \textcolor{preprocessor}{\#include\ <vector>}}
|
||||
\DoxyCodeLine{00008\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{00009\ \textcolor{preprocessor}{\#include\ <mutex>}}
|
||||
\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#include\ <map>}}
|
||||
\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#include\ <functional>}}
|
||||
\DoxyCodeLine{00012\ }
|
||||
\DoxyCodeLine{00021\ }
|
||||
\DoxyCodeLine{00029\ \textcolor{keyword}{class\ }\mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}}\ \{}
|
||||
\DoxyCodeLine{00030\ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{00037\ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DataType}}\ =\ std::variant<}
|
||||
\DoxyCodeLine{00038\ \ \ \ \ \ \ \ \ int,\ float,\ double,\ std::string,\ std::monostate,}
|
||||
\DoxyCodeLine{00039\ \ \ \ \ \ \ \ \ std::vector<int>,\ std::vector<float>,\ std::vector<double>}
|
||||
\DoxyCodeLine{00040\ \ \ \ \ >;}
|
||||
\DoxyCodeLine{00041\ }
|
||||
\DoxyCodeLine{00047\ \ \ \ \ \textcolor{keyword}{using\ }\mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}}\ =\ std::function<void(\mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}}\&)>;}
|
||||
\DoxyCodeLine{00048\ }
|
||||
\DoxyCodeLine{00054\ \ \ \ \ \mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}}();}
|
||||
\DoxyCodeLine{00055\ }
|
||||
\DoxyCodeLine{00062\ \ \ \ \ \mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}}(\textcolor{keyword}{const}\ \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DataType}}\&\ data,\ \textcolor{keyword}{const}\ \mbox{\hyperlink{class_metadata}{Metadata}}\&\ metadata);}
|
||||
\DoxyCodeLine{00063\ }
|
||||
\DoxyCodeLine{00071\ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DataType}}\&\ \mbox{\hyperlink{class_d_object_a4862655c3634d019b0a45b811d6f7235}{getData}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00072\ }
|
||||
\DoxyCodeLine{00080\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_ab1718571434e84e90f1ec463e4786a8a}{setData}}(const\ \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DataType}}\&\ data);}
|
||||
\DoxyCodeLine{00081\ }
|
||||
\DoxyCodeLine{00090\ \ \ \ \ const\ \mbox{\hyperlink{class_metadata}{Metadata}}\&\ \mbox{\hyperlink{class_d_object_a157b31e881aac6dd40782d3abc561d4e}{getMetadata}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00091\ }
|
||||
\DoxyCodeLine{00099\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a296b1519249fdc1f6c7b4ab62d5421bc}{setMetadata}}(const\ \mbox{\hyperlink{class_metadata}{Metadata}}\&\ metadata);}
|
||||
\DoxyCodeLine{00100\ }
|
||||
\DoxyCodeLine{00108\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a6f0023aee463e71d92442dcf61b6ed47}{setDebugging}}(\textcolor{keywordtype}{bool}\ enableDebug);}
|
||||
\DoxyCodeLine{00109\ }
|
||||
\DoxyCodeLine{00115\ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{class_d_object_ae47bf220fbe2173cf6933c2380035dbd}{isDebuggingEnabled}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00116\ }
|
||||
\DoxyCodeLine{00125\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a15afffdf339150fc872bf63bdd08d581}{registerPlugin}}(const\ std::\textcolor{keywordtype}{string}\&\ \textcolor{keywordtype}{id},\ \mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}}\ plugin);}
|
||||
\DoxyCodeLine{00126\ }
|
||||
\DoxyCodeLine{00134\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a99b8688849e11501033a25f61efb8356}{unregisterPlugin}}(const\ std::\textcolor{keywordtype}{string}\&\ \textcolor{keywordtype}{id});}
|
||||
\DoxyCodeLine{00135\ }
|
||||
\DoxyCodeLine{00143\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a99072eb52bb22745f0248f273fbf28fb}{runPlugin}}(const\ std::\textcolor{keywordtype}{string}\&\ \textcolor{keywordtype}{id});}
|
||||
\DoxyCodeLine{00144\ }
|
||||
\DoxyCodeLine{00150\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_d_object_a1223275dcbbf20334ea11707346acb93}{runAllPlugins}}();}
|
||||
\DoxyCodeLine{00151\ }
|
||||
\DoxyCodeLine{00161\ \ \ \ \ friend\ std::ostream\&\ operator<<(std::ostream\&\ os,\ const\ \mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}}\&\ obj);}
|
||||
\DoxyCodeLine{00162\ }
|
||||
\DoxyCodeLine{00163\ private:}
|
||||
\DoxyCodeLine{00164\ \ \ \ \ \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DataType}}\ data\_;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00165\ \ \ \ \ \mbox{\hyperlink{class_metadata}{Metadata}}\ metadata\_;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00166\ \ \ \ \ \textcolor{keywordtype}{bool}\ debugEnabled\_\ =\ false;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00167\ \ \ \ \ std::map<std::\textcolor{keywordtype}{string},\ \mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}}>\ plugins\_;\ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00168\ \};}
|
||||
\DoxyCodeLine{00169\ }
|
||||
\DoxyCodeLine{00170\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\ DOBJECT\_H}}
|
||||
|
||||
\end{DoxyCode}
|
||||
7
docs/latex/_d_object_private_8h_source.tex
Normal file
7
docs/latex/_d_object_private_8h_source.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{DObject\+Private.\+h}
|
||||
\hypertarget{_d_object_private_8h_source}{}\label{_d_object_private_8h_source}\index{src/dobj/private/DObjectPrivate.h@{src/dobj/private/DObjectPrivate.h}}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{00001\ }
|
||||
|
||||
\end{DoxyCode}
|
||||
7
docs/latex/_debug_info_8h_source.tex
Normal file
7
docs/latex/_debug_info_8h_source.tex
Normal file
@@ -0,0 +1,7 @@
|
||||
\doxysection{Debug\+Info.\+h}
|
||||
\hypertarget{_debug_info_8h_source}{}\label{_debug_info_8h_source}\index{src/dobj/private/DebugInfo.h@{src/dobj/private/DebugInfo.h}}
|
||||
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{00001\ }
|
||||
|
||||
\end{DoxyCode}
|
||||
20
docs/latex/_lockable_d_object_8h.tex
Normal file
20
docs/latex/_lockable_d_object_8h.tex
Normal file
@@ -0,0 +1,20 @@
|
||||
\doxysection{src/dobj/public/\+Lockable\+DObject.h File Reference}
|
||||
\hypertarget{_lockable_d_object_8h}{}\label{_lockable_d_object_8h}\index{src/dobj/public/LockableDObject.h@{src/dobj/public/LockableDObject.h}}
|
||||
|
||||
|
||||
A lightweight wrapper for \doxylink{class_d_object}{DObject} that adds locking capabilities.
|
||||
|
||||
|
||||
{\ttfamily \#include "{}DObject.\+h"{}}\newline
|
||||
{\ttfamily \#include $<$mutex$>$}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \mbox{\hyperlink{class_lockable_d_object}{Lockable\+DObject}}
|
||||
\begin{DoxyCompactList}\small\item\em Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
A lightweight wrapper for \doxylink{class_d_object}{DObject} that adds locking capabilities.
|
||||
|
||||
This class allows safe concurrent access to a \doxylink{class_d_object}{DObject} by providing locking and unlocking methods.
|
||||
29
docs/latex/_lockable_d_object_8h_source.tex
Normal file
29
docs/latex/_lockable_d_object_8h_source.tex
Normal file
@@ -0,0 +1,29 @@
|
||||
\doxysection{Lockable\+DObject.\+h}
|
||||
\hypertarget{_lockable_d_object_8h_source}{}\label{_lockable_d_object_8h_source}\index{src/dobj/public/LockableDObject.h@{src/dobj/public/LockableDObject.h}}
|
||||
\mbox{\hyperlink{_lockable_d_object_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{00001\ \textcolor{preprocessor}{\#ifndef\ LOCKABLE\_DOBJECT\_H}}
|
||||
\DoxyCodeLine{00002\ \textcolor{preprocessor}{\#define\ LOCKABLE\_DOBJECT\_H}}
|
||||
\DoxyCodeLine{00003\ }
|
||||
\DoxyCodeLine{00004\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{_d_object_8h}{DObject.h}}"{}}}
|
||||
\DoxyCodeLine{00005\ \textcolor{preprocessor}{\#include\ <mutex>}}
|
||||
\DoxyCodeLine{00006\ }
|
||||
\DoxyCodeLine{00014\ }
|
||||
\DoxyCodeLine{00019\ \textcolor{keyword}{class\ }\mbox{\hyperlink{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}{LockableDObject}}\ \{}
|
||||
\DoxyCodeLine{00020\ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{00024\ \ \ \ \ \mbox{\hyperlink{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}{LockableDObject}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{00025\ }
|
||||
\DoxyCodeLine{00030\ \ \ \ \ \mbox{\hyperlink{class_d_object}{DObject}}\&\ \mbox{\hyperlink{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}{get}}();}
|
||||
\DoxyCodeLine{00031\ }
|
||||
\DoxyCodeLine{00035\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}{lock}}();}
|
||||
\DoxyCodeLine{00036\ }
|
||||
\DoxyCodeLine{00040\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}{unlock}}();}
|
||||
\DoxyCodeLine{00041\ }
|
||||
\DoxyCodeLine{00042\ \textcolor{keyword}{private}:}
|
||||
\DoxyCodeLine{00043\ \ \ \ \ \mbox{\hyperlink{class_d_object}{DObject}}\ object\_;\ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00044\ \ \ \ \ std::mutex\ mutex\_;\ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00045\ \};}
|
||||
\DoxyCodeLine{00046\ }
|
||||
\DoxyCodeLine{00047\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\ LOCKABLE\_DOBJECT\_H}}
|
||||
|
||||
\end{DoxyCode}
|
||||
43
docs/latex/_metadata_8cpp.tex
Normal file
43
docs/latex/_metadata_8cpp.tex
Normal file
@@ -0,0 +1,43 @@
|
||||
\doxysection{src/dobj/private/\+Metadata.cpp File Reference}
|
||||
\hypertarget{_metadata_8cpp}{}\label{_metadata_8cpp}\index{src/dobj/private/Metadata.cpp@{src/dobj/private/Metadata.cpp}}
|
||||
|
||||
|
||||
Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
|
||||
{\ttfamily \#include "{}Metadata.\+h"{}}\newline
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{class_metadata}{Metadata}} \&metadata)
|
||||
\begin{DoxyCompactList}\small\item\em Prints the metadata information for debugging purposes. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
Provides methods to manage metadata for data objects, including size, type, dimensions, and debugging flags.
|
||||
|
||||
\doxysubsection{Function Documentation}
|
||||
\Hypertarget{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}\index{Metadata.cpp@{Metadata.cpp}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!Metadata.cpp@{Metadata.cpp}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}}
|
||||
{\footnotesize\ttfamily \label{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{class_metadata}{Metadata}} \&}]{metadata}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Prints the metadata information for debugging purposes.
|
||||
|
||||
This function provides a human-\/readable summary of the metadata. Useful for quick checks or logging during debugging sessions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream to print to. \\
|
||||
\hline
|
||||
{\em metadata} & The \doxylink{class_metadata}{Metadata} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the output stream.
|
||||
\end{DoxyReturn}
|
||||
22
docs/latex/_metadata_8h.tex
Normal file
22
docs/latex/_metadata_8h.tex
Normal file
@@ -0,0 +1,22 @@
|
||||
\doxysection{src/dobj/public/\+Metadata.h File Reference}
|
||||
\hypertarget{_metadata_8h}{}\label{_metadata_8h}\index{src/dobj/public/Metadata.h@{src/dobj/public/Metadata.h}}
|
||||
|
||||
|
||||
Public interface for the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
|
||||
{\ttfamily \#include $<$string$>$}\newline
|
||||
{\ttfamily \#include $<$vector$>$}\newline
|
||||
{\ttfamily \#include $<$cstddef$>$}\newline
|
||||
{\ttfamily \#include $<$iostream$>$}\newline
|
||||
\doxysubsubsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \mbox{\hyperlink{class_metadata}{Metadata}}
|
||||
\begin{DoxyCompactList}\small\item\em Represents metadata information for data objects in the dobj module. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Public interface for the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
The \doxylink{class_metadata}{Metadata} class provides descriptive information about the data encapsulated within a dobj, including size, type, dimensions, and debugging flags.
|
||||
53
docs/latex/_metadata_8h_source.tex
Normal file
53
docs/latex/_metadata_8h_source.tex
Normal file
@@ -0,0 +1,53 @@
|
||||
\doxysection{Metadata.\+h}
|
||||
\hypertarget{_metadata_8h_source}{}\label{_metadata_8h_source}\index{src/dobj/public/Metadata.h@{src/dobj/public/Metadata.h}}
|
||||
\mbox{\hyperlink{_metadata_8h}{Go to the documentation of this file.}}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{00001\ \textcolor{preprocessor}{\#ifndef\ METADATA\_H}}
|
||||
\DoxyCodeLine{00002\ \textcolor{preprocessor}{\#define\ METADATA\_H}}
|
||||
\DoxyCodeLine{00003\ }
|
||||
\DoxyCodeLine{00004\ \textcolor{preprocessor}{\#if\ defined(\_\_APPLE\_\_)\ ||\ defined(\_\_linux\_\_)}}
|
||||
\DoxyCodeLine{00005\ \textcolor{preprocessor}{\#define\ EXPORT\_SYMBOL\ \_\_attribute\_\_((visibility("{}default"{})))}}
|
||||
\DoxyCodeLine{00006\ \textcolor{preprocessor}{\#else}}
|
||||
\DoxyCodeLine{00007\ \textcolor{preprocessor}{\#define\ EXPORT\_SYMBOL}}
|
||||
\DoxyCodeLine{00008\ \textcolor{preprocessor}{\#endif}}
|
||||
\DoxyCodeLine{00009\ }
|
||||
\DoxyCodeLine{00010\ \textcolor{preprocessor}{\#include\ <string>}}
|
||||
\DoxyCodeLine{00011\ \textcolor{preprocessor}{\#include\ <vector>}}
|
||||
\DoxyCodeLine{00012\ \textcolor{preprocessor}{\#include\ <cstddef>}}
|
||||
\DoxyCodeLine{00013\ \textcolor{preprocessor}{\#include\ <iostream>}}
|
||||
\DoxyCodeLine{00014\ }
|
||||
\DoxyCodeLine{00022\ }
|
||||
\DoxyCodeLine{00031\ \textcolor{keyword}{class\ }EXPORT\_SYMBOL\ \mbox{\hyperlink{class_metadata_ae849560667461008cb72e83919c20be0}{Metadata}}\ \{}
|
||||
\DoxyCodeLine{00032\ \textcolor{keyword}{public}:}
|
||||
\DoxyCodeLine{00036\ \ \ \ \ \mbox{\hyperlink{class_metadata_ae849560667461008cb72e83919c20be0}{Metadata}}()\ =\ \textcolor{keywordflow}{default};}
|
||||
\DoxyCodeLine{00037\ }
|
||||
\DoxyCodeLine{00046\ \ \ \ \ \mbox{\hyperlink{class_metadata_ae849560667461008cb72e83919c20be0}{Metadata}}(std::size\_t\ byteSize,\ std::string\ dataType,\ std::vector<std::size\_t>\ dimensions,\ \textcolor{keywordtype}{bool}\ debugFlag\ =\ \textcolor{keyword}{false});}
|
||||
\DoxyCodeLine{00047\ }
|
||||
\DoxyCodeLine{00052\ \ \ \ \ [[nodiscard]]\ std::size\_t\ \mbox{\hyperlink{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}{getByteSize}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00053\ }
|
||||
\DoxyCodeLine{00058\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}{setByteSize}}(std::\textcolor{keywordtype}{size\_t}\ byteSize)\ noexcept;}
|
||||
\DoxyCodeLine{00059\ }
|
||||
\DoxyCodeLine{00064\ \ \ \ \ [[nodiscard]]\ const\ std::\textcolor{keywordtype}{string}\&\ \mbox{\hyperlink{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}{getDataType}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00065\ }
|
||||
\DoxyCodeLine{00070\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}{setDataType}}(const\ std::\textcolor{keywordtype}{string}\&\ dataType);}
|
||||
\DoxyCodeLine{00071\ }
|
||||
\DoxyCodeLine{00076\ \ \ \ \ [[nodiscard]]\ const\ std::vector<std::\textcolor{keywordtype}{size\_t}>\&\ \mbox{\hyperlink{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}{getDimensions}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00077\ }
|
||||
\DoxyCodeLine{00082\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_metadata_af5264d1666839e69c192b565b5cfa606}{setDimensions}}(const\ std::vector<std::\textcolor{keywordtype}{size\_t}>\&\ dimensions);}
|
||||
\DoxyCodeLine{00083\ }
|
||||
\DoxyCodeLine{00088\ \ \ \ \ [[nodiscard]]\ \textcolor{keywordtype}{bool}\ \mbox{\hyperlink{class_metadata_abe52c81e04665628666b4140cd346b69}{isDebugEnabled}}()\ const\ noexcept;}
|
||||
\DoxyCodeLine{00089\ }
|
||||
\DoxyCodeLine{00094\ \ \ \ \ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}{setDebugEnabled}}(\textcolor{keywordtype}{bool}\ debugFlag)\ noexcept;}
|
||||
\DoxyCodeLine{00095\ }
|
||||
\DoxyCodeLine{00103\ \ \ \ \ friend\ std::ostream\&\ operator<<(std::ostream\&\ os,\ const\ \mbox{\hyperlink{class_metadata_ae849560667461008cb72e83919c20be0}{Metadata}}\&\ metadata);}
|
||||
\DoxyCodeLine{00104\ }
|
||||
\DoxyCodeLine{00105\ private:}
|
||||
\DoxyCodeLine{00106\ \ \ \ \ std::\textcolor{keywordtype}{size\_t}\ byteSize\_\ =\ 0;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00107\ \ \ \ \ std::\textcolor{keywordtype}{string}\ dataType\_;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00108\ \ \ \ \ std::vector<std::\textcolor{keywordtype}{size\_t}>\ dimensions\_;\ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00109\ \ \ \ \ \textcolor{keywordtype}{bool}\ debugFlag\_\ =\ false;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ }
|
||||
\DoxyCodeLine{00110\ \};}
|
||||
\DoxyCodeLine{00111\ }
|
||||
\DoxyCodeLine{00112\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{//\ METADATA\_H}}
|
||||
|
||||
\end{DoxyCode}
|
||||
6
docs/latex/annotated.tex
Normal file
6
docs/latex/annotated.tex
Normal file
@@ -0,0 +1,6 @@
|
||||
\doxysection{Class List}
|
||||
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{class_d_object}{DObject}} \\*A universal data container class }{\pageref{class_d_object}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{class_lockable_d_object}{Lockable\+DObject}} \\*Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access }{\pageref{class_lockable_d_object}}{}
|
||||
\item\contentsline{section}{\mbox{\hyperlink{class_metadata}{Metadata}} \\*Represents metadata information for data objects in the dobj module }{\pageref{class_metadata}}{}
|
||||
\end{DoxyCompactList}
|
||||
307
docs/latex/class_d_object.tex
Normal file
307
docs/latex/class_d_object.tex
Normal file
@@ -0,0 +1,307 @@
|
||||
\doxysection{DObject Class Reference}
|
||||
\hypertarget{class_d_object}{}\label{class_d_object}\index{DObject@{DObject}}
|
||||
|
||||
|
||||
A universal data container class.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$DObject.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Types}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
using \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}}
|
||||
\begin{DoxyCompactList}\small\item\em Supported data types for the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
using \mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}} = std\+::function$<$void(\mbox{\hyperlink{class_d_object}{DObject}}\&)$>$
|
||||
\begin{DoxyCompactList}\small\item\em Placeholder type for plugins. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\mbox{\hyperlink{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{DObject}} ()
|
||||
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{class_d_object_ab0c940fa193a42158c6726bf1a2ef54d}{DObject}} (const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}} \&data, const \mbox{\hyperlink{class_metadata}{Metadata}} \&metadata)
|
||||
\begin{DoxyCompactList}\small\item\em Constructor to initialize a \doxylink{class_d_object}{DObject} with data and metadata. \end{DoxyCompactList}\item
|
||||
const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}} \& \mbox{\hyperlink{class_d_object_a4862655c3634d019b0a45b811d6f7235}{get\+Data}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Retrieves the data stored in the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_ab1718571434e84e90f1ec463e4786a8a}{set\+Data}} (const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}} \&data)
|
||||
\begin{DoxyCompactList}\small\item\em Sets the data for the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
const \mbox{\hyperlink{class_metadata}{Metadata}} \& \mbox{\hyperlink{class_d_object_a157b31e881aac6dd40782d3abc561d4e}{get\+Metadata}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Retrieves the metadata associated with the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a296b1519249fdc1f6c7b4ab62d5421bc}{set\+Metadata}} (const \mbox{\hyperlink{class_metadata}{Metadata}} \&metadata)
|
||||
\begin{DoxyCompactList}\small\item\em Updates the metadata for the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a6f0023aee463e71d92442dcf61b6ed47}{set\+Debugging}} (bool enable\+Debug)
|
||||
\begin{DoxyCompactList}\small\item\em Enables or disables debugging and tracing for the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{class_d_object_ae47bf220fbe2173cf6933c2380035dbd}{is\+Debugging\+Enabled}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Checks if debugging is enabled for the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a15afffdf339150fc872bf63bdd08d581}{register\+Plugin}} (const std\+::string \&id, \mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}} plugin)
|
||||
\begin{DoxyCompactList}\small\item\em Registers a plugin with the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a99b8688849e11501033a25f61efb8356}{unregister\+Plugin}} (const std\+::string \&id)
|
||||
\begin{DoxyCompactList}\small\item\em Unregisters a plugin by its identifier. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a99072eb52bb22745f0248f273fbf28fb}{run\+Plugin}} (const std\+::string \&id)
|
||||
\begin{DoxyCompactList}\small\item\em Executes a plugin by its identifier. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_d_object_a1223275dcbbf20334ea11707346acb93}{run\+All\+Plugins}} ()
|
||||
\begin{DoxyCompactList}\small\item\em Executes all registered plugins in the registry. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{class_d_object_aa54e75574f0302a2ca7252f9f0f0b3f1}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{class_d_object}{DObject}} \&obj)
|
||||
\begin{DoxyCompactList}\small\item\em Provides a human-\/readable summary of the \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
A universal data container class.
|
||||
|
||||
The \doxylink{class_d_object}{DObject} class is designed to store arbitrary data alongside descriptive metadata. It supports plugin registration to allow extensible functionality.
|
||||
|
||||
\doxysubsection{Member Typedef Documentation}
|
||||
\Hypertarget{class_d_object_ad6fc2e29eae70cf94a2d241527857573}\index{DObject@{DObject}!DataType@{DataType}}
|
||||
\index{DataType@{DataType}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{DataType}{DataType}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_ad6fc2e29eae70cf94a2d241527857573}
|
||||
using \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DObject\+::\+Data\+Type}}}
|
||||
|
||||
{\bfseries Initial value\+:}
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{\ std::variant<}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ int,\ float,\ double,\ std::string,\ std::monostate,}
|
||||
\DoxyCodeLine{\ \ \ \ \ \ \ \ std::vector<int>,\ std::vector<float>,\ std::vector<double>}
|
||||
\DoxyCodeLine{\ \ \ \ >}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
Supported data types for the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
This type alias uses {\ttfamily std\+::variant} to store different types of data, ensuring type safety and flexibility. \Hypertarget{class_d_object_af11334d08ef85c68b3aae7554548e5a7}\index{DObject@{DObject}!Plugin@{Plugin}}
|
||||
\index{Plugin@{Plugin}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{Plugin}{Plugin}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_af11334d08ef85c68b3aae7554548e5a7}
|
||||
using \mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{DObject\+::\+Plugin}} = std\+::function$<$void(\mbox{\hyperlink{class_d_object}{DObject}}\&)$>$}
|
||||
|
||||
|
||||
|
||||
Placeholder type for plugins.
|
||||
|
||||
In the future, this will be replaced with a concrete interface.
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\Hypertarget{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}\index{DObject@{DObject}!DObject@{DObject}}
|
||||
\index{DObject@{DObject}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{DObject()}{DObject()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}
|
||||
DObject\+::\+DObject (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Default constructor.
|
||||
|
||||
Creates an empty \doxylink{class_d_object}{DObject} with default metadata. \Hypertarget{class_d_object_ab0c940fa193a42158c6726bf1a2ef54d}\index{DObject@{DObject}!DObject@{DObject}}
|
||||
\index{DObject@{DObject}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{DObject()}{DObject()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_ab0c940fa193a42158c6726bf1a2ef54d}
|
||||
DObject\+::\+DObject (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}} \&}]{data}{, }\item[{const \mbox{\hyperlink{class_metadata}{Metadata}} \&}]{metadata}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Constructor to initialize a \doxylink{class_d_object}{DObject} with data and metadata.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em data} & The data to be stored in the \doxylink{class_d_object}{DObject}. \\
|
||||
\hline
|
||||
{\em metadata} & \doxylink{class_metadata}{Metadata} describing the stored data. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{class_d_object_a4862655c3634d019b0a45b811d6f7235}\index{DObject@{DObject}!getData@{getData}}
|
||||
\index{getData@{getData}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{getData()}{getData()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a4862655c3634d019b0a45b811d6f7235}
|
||||
const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{DObject\+::\+Data\+Type}} \& DObject\+::get\+Data (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Retrieves the data stored in the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
Use the appropriate type (matching the stored data) with {\ttfamily std\+::get\texorpdfstring{$<$}{<}T\texorpdfstring{$>$}{>}()}.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A constant reference to the stored data.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_d_object_a157b31e881aac6dd40782d3abc561d4e}\index{DObject@{DObject}!getMetadata@{getMetadata}}
|
||||
\index{getMetadata@{getMetadata}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{getMetadata()}{getMetadata()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a157b31e881aac6dd40782d3abc561d4e}
|
||||
const \mbox{\hyperlink{class_metadata}{Metadata}} \& DObject\+::get\+Metadata (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Retrieves the metadata associated with the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
The metadata provides essential information about the stored data, such as its type, size, and dimensions.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A constant reference to the metadata.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_d_object_ae47bf220fbe2173cf6933c2380035dbd}\index{DObject@{DObject}!isDebuggingEnabled@{isDebuggingEnabled}}
|
||||
\index{isDebuggingEnabled@{isDebuggingEnabled}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{isDebuggingEnabled()}{isDebuggingEnabled()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_ae47bf220fbe2173cf6933c2380035dbd}
|
||||
bool DObject\+::is\+Debugging\+Enabled (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Checks if debugging is enabled for the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
True if debugging is enabled, false otherwise.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_d_object_a15afffdf339150fc872bf63bdd08d581}\index{DObject@{DObject}!registerPlugin@{registerPlugin}}
|
||||
\index{registerPlugin@{registerPlugin}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{registerPlugin()}{registerPlugin()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a15afffdf339150fc872bf63bdd08d581}
|
||||
void DObject\+::register\+Plugin (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{id}{, }\item[{\mbox{\hyperlink{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{Plugin}}}]{plugin}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Registers a plugin with the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
Plugins are stored in a registry and can add custom functionality to the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em id} & A unique identifier for the plugin. \\
|
||||
\hline
|
||||
{\em plugin} & The plugin function to register. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_d_object_a1223275dcbbf20334ea11707346acb93}\index{DObject@{DObject}!runAllPlugins@{runAllPlugins}}
|
||||
\index{runAllPlugins@{runAllPlugins}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{runAllPlugins()}{runAllPlugins()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a1223275dcbbf20334ea11707346acb93}
|
||||
void DObject\+::run\+All\+Plugins (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Executes all registered plugins in the registry.
|
||||
|
||||
Iterates through all plugins and invokes them on the current \doxylink{class_d_object}{DObject}. \Hypertarget{class_d_object_a99072eb52bb22745f0248f273fbf28fb}\index{DObject@{DObject}!runPlugin@{runPlugin}}
|
||||
\index{runPlugin@{runPlugin}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{runPlugin()}{runPlugin()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a99072eb52bb22745f0248f273fbf28fb}
|
||||
void DObject\+::run\+Plugin (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{id}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Executes a plugin by its identifier.
|
||||
|
||||
Invokes the registered plugin function. If the plugin is not found, no action is taken.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em id} & The unique identifier of the plugin to execute. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_d_object_ab1718571434e84e90f1ec463e4786a8a}\index{DObject@{DObject}!setData@{setData}}
|
||||
\index{setData@{setData}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{setData()}{setData()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_ab1718571434e84e90f1ec463e4786a8a}
|
||||
void DObject\+::set\+Data (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{Data\+Type}} \&}]{data}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Sets the data for the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
Updates the stored data and optionally updates metadata.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em data} & The new data to store in the \doxylink{class_d_object}{DObject}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_d_object_a6f0023aee463e71d92442dcf61b6ed47}\index{DObject@{DObject}!setDebugging@{setDebugging}}
|
||||
\index{setDebugging@{setDebugging}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{setDebugging()}{setDebugging()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a6f0023aee463e71d92442dcf61b6ed47}
|
||||
void DObject\+::set\+Debugging (\begin{DoxyParamCaption}\item[{bool}]{enable\+Debug}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Enables or disables debugging and tracing for the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
When debugging is enabled, the \doxylink{class_d_object}{DObject} tracks creation and modification history.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em enable\+Debug} & True to enable debugging, false to disable it. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_d_object_a296b1519249fdc1f6c7b4ab62d5421bc}\index{DObject@{DObject}!setMetadata@{setMetadata}}
|
||||
\index{setMetadata@{setMetadata}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{setMetadata()}{setMetadata()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a296b1519249fdc1f6c7b4ab62d5421bc}
|
||||
void DObject\+::set\+Metadata (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_metadata}{Metadata}} \&}]{metadata}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Updates the metadata for the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
Use this function carefully to ensure consistency between the data and metadata.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em metadata} & The new metadata to associate with the \doxylink{class_d_object}{DObject}. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_d_object_a99b8688849e11501033a25f61efb8356}\index{DObject@{DObject}!unregisterPlugin@{unregisterPlugin}}
|
||||
\index{unregisterPlugin@{unregisterPlugin}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{unregisterPlugin()}{unregisterPlugin()}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_a99b8688849e11501033a25f61efb8356}
|
||||
void DObject\+::unregister\+Plugin (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{id}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Unregisters a plugin by its identifier.
|
||||
|
||||
Removes the plugin from the registry if it exists.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em id} & The unique identifier of the plugin to unregister. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
\doxysubsection{Friends And Related Symbol Documentation}
|
||||
\Hypertarget{class_d_object_aa54e75574f0302a2ca7252f9f0f0b3f1}\index{DObject@{DObject}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!DObject@{DObject}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
||||
{\footnotesize\ttfamily \label{class_d_object_aa54e75574f0302a2ca7252f9f0f0b3f1}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{class_d_object}{DObject}} \&}]{obj}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Provides a human-\/readable summary of the \doxylink{class_d_object}{DObject}.
|
||||
|
||||
Useful for quick inspection or logging during debugging sessions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream to write to. \\
|
||||
\hline
|
||||
{\em obj} & The \doxylink{class_d_object}{DObject} to summarize. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the output stream.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/dobj/public/\mbox{\hyperlink{_d_object_8h}{DObject.\+h}}\item
|
||||
src/dobj/private/\mbox{\hyperlink{_d_object_8cpp}{DObject.\+cpp}}\end{DoxyCompactItemize}
|
||||
50
docs/latex/class_lockable_d_object.tex
Normal file
50
docs/latex/class_lockable_d_object.tex
Normal file
@@ -0,0 +1,50 @@
|
||||
\doxysection{Lockable\+DObject Class Reference}
|
||||
\hypertarget{class_lockable_d_object}{}\label{class_lockable_d_object}\index{LockableDObject@{LockableDObject}}
|
||||
|
||||
|
||||
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$Lockable\+DObject.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\Hypertarget{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}\label{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}
|
||||
{\bfseries Lockable\+DObject} ()=default
|
||||
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{class_d_object}{DObject}} \& \mbox{\hyperlink{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}{get}} ()
|
||||
\begin{DoxyCompactList}\small\item\em Access the underlying \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
\Hypertarget{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}\label{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}
|
||||
void {\bfseries lock} ()
|
||||
\begin{DoxyCompactList}\small\item\em Locks the mutex to ensure thread-\/safe access. \end{DoxyCompactList}\item
|
||||
\Hypertarget{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}\label{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}
|
||||
void {\bfseries unlock} ()
|
||||
\begin{DoxyCompactList}\small\item\em Unlocks the mutex after thread-\/safe access. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}\index{LockableDObject@{LockableDObject}!get@{get}}
|
||||
\index{get@{get}!LockableDObject@{LockableDObject}}
|
||||
\doxysubsubsection{\texorpdfstring{get()}{get()}}
|
||||
{\footnotesize\ttfamily \label{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}
|
||||
\mbox{\hyperlink{class_d_object}{DObject}} \& Lockable\+DObject\+::get (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Access the underlying \doxylink{class_d_object}{DObject}.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the wrapped \doxylink{class_d_object}{DObject}.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/dobj/public/\mbox{\hyperlink{_lockable_d_object_8h}{Lockable\+DObject.\+h}}\item
|
||||
src/dobj/private/Lockable\+DObject.\+cpp\end{DoxyCompactItemize}
|
||||
273
docs/latex/class_metadata.tex
Normal file
273
docs/latex/class_metadata.tex
Normal file
@@ -0,0 +1,273 @@
|
||||
\doxysection{Metadata Class Reference}
|
||||
\hypertarget{class_metadata}{}\label{class_metadata}\index{Metadata@{Metadata}}
|
||||
|
||||
|
||||
Represents metadata information for data objects in the dobj module.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$Metadata.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\Hypertarget{class_metadata_ae849560667461008cb72e83919c20be0}\label{class_metadata_ae849560667461008cb72e83919c20be0}
|
||||
{\bfseries Metadata} ()=default
|
||||
\begin{DoxyCompactList}\small\item\em Default constructor for \doxylink{class_metadata}{Metadata}. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}{Metadata}} (std\+::size\+\_\+t byte\+Size, std\+::string data\+Type, std\+::vector$<$ std\+::size\+\_\+t $>$ dimensions, bool debug\+Flag=false)
|
||||
\begin{DoxyCompactList}\small\item\em Constructor to initialize \doxylink{class_metadata}{Metadata} with specific attributes. \end{DoxyCompactList}\item
|
||||
std\+::size\+\_\+t \mbox{\hyperlink{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}{get\+Byte\+Size}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Gets the total size of the data in bytes. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}{set\+Byte\+Size}} (std\+::size\+\_\+t byte\+Size) noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Sets the total size of the data in bytes. \end{DoxyCompactList}\item
|
||||
const std\+::string \& \mbox{\hyperlink{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}{get\+Data\+Type}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Gets the type of the data. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}{set\+Data\+Type}} (const std\+::string \&data\+Type)
|
||||
\begin{DoxyCompactList}\small\item\em Sets the type of the data. \end{DoxyCompactList}\item
|
||||
const std\+::vector$<$ std\+::size\+\_\+t $>$ \& \mbox{\hyperlink{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}{get\+Dimensions}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Gets the dimensions of the data. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_metadata_af5264d1666839e69c192b565b5cfa606}{set\+Dimensions}} (const std\+::vector$<$ std\+::size\+\_\+t $>$ \&dimensions)
|
||||
\begin{DoxyCompactList}\small\item\em Sets the dimensions of the data. \end{DoxyCompactList}\item
|
||||
bool \mbox{\hyperlink{class_metadata_abe52c81e04665628666b4140cd346b69}{is\+Debug\+Enabled}} () const noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Checks if debugging information is enabled. \end{DoxyCompactList}\item
|
||||
void \mbox{\hyperlink{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}{set\+Debug\+Enabled}} (bool debug\+Flag) noexcept
|
||||
\begin{DoxyCompactList}\small\item\em Sets the debugging flag. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\doxysubsubsection*{Friends}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{class_metadata_a12949a1ea26c4ff1afeb97101c0493c5}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{class_metadata}{Metadata}} \&metadata)
|
||||
\begin{DoxyCompactList}\small\item\em Prints the metadata information for debugging purposes. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Represents metadata information for data objects in the dobj module.
|
||||
|
||||
The \doxylink{class_metadata}{Metadata} class encapsulates details such as data size, type, dimensions, and optional debugging flags. It is designed to provide descriptive attributes in a lightweight and efficient manner.
|
||||
|
||||
\doxysubsection{Constructor \& Destructor Documentation}
|
||||
\Hypertarget{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}\index{Metadata@{Metadata}!Metadata@{Metadata}}
|
||||
\index{Metadata@{Metadata}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{Metadata()}{Metadata()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}
|
||||
Metadata\+::\+Metadata (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{byte\+Size}{, }\item[{std\+::string}]{data\+Type}{, }\item[{std\+::vector$<$ std\+::size\+\_\+t $>$}]{dimensions}{, }\item[{bool}]{debug\+Flag}{ = {\ttfamily false}}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Constructor to initialize \doxylink{class_metadata}{Metadata} with specific attributes.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em byte\+Size} & The total size of the data in bytes. \\
|
||||
\hline
|
||||
{\em data\+Type} & The type of the data (e.\+g., "{}float"{}, "{}double"{}). \\
|
||||
\hline
|
||||
{\em dimensions} & A vector representing the size of each dimension (e.\+g., \{3, 4\} for a 3x4 matrix). \\
|
||||
\hline
|
||||
{\em debug\+Flag} & Whether debugging information is enabled for this \doxylink{class_metadata}{Metadata} instance. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}\index{Metadata@{Metadata}!getByteSize@{getByteSize}}
|
||||
\index{getByteSize@{getByteSize}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{getByteSize()}{getByteSize()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}
|
||||
std\+::size\+\_\+t Metadata\+::get\+Byte\+Size (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Gets the total size of the data in bytes.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The total byte size of the data.
|
||||
\end{DoxyReturn}
|
||||
The size is often required for memory allocation and validation in numerical routines.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
The total byte size of the data.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}\index{Metadata@{Metadata}!getDataType@{getDataType}}
|
||||
\index{getDataType@{getDataType}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{getDataType()}{getDataType()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}
|
||||
const std\+::string \& Metadata\+::get\+Data\+Type (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Gets the type of the data.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string representing the data type.
|
||||
\end{DoxyReturn}
|
||||
The type (e.\+g., "{}float"{}, "{}double"{}) is critical for casting raw data or interfacing with libraries that require specific types.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A string representing the data type.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}\index{Metadata@{Metadata}!getDimensions@{getDimensions}}
|
||||
\index{getDimensions@{getDimensions}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{getDimensions()}{getDimensions()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}
|
||||
const std\+::vector$<$ std\+::size\+\_\+t $>$ \& Metadata\+::get\+Dimensions (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Gets the dimensions of the data.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A vector representing the size of each dimension.
|
||||
\end{DoxyReturn}
|
||||
Dimensions define the shape of the data (e.\+g., 2D arrays, 3D matrices). This is essential for ensuring that operations (e.\+g., matrix multiplication) are performed correctly.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A vector representing the size of each dimension.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_metadata_abe52c81e04665628666b4140cd346b69}\index{Metadata@{Metadata}!isDebugEnabled@{isDebugEnabled}}
|
||||
\index{isDebugEnabled@{isDebugEnabled}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{isDebugEnabled()}{isDebugEnabled()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_abe52c81e04665628666b4140cd346b69}
|
||||
bool Metadata\+::is\+Debug\+Enabled (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [nodiscard]}, {\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Checks if debugging information is enabled.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
True if debugging is enabled, false otherwise.
|
||||
\end{DoxyReturn}
|
||||
Debugging flags can be useful for tracking performance metrics or error provenance.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
True if debugging is enabled, false otherwise.
|
||||
\end{DoxyReturn}
|
||||
\Hypertarget{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}\index{Metadata@{Metadata}!setByteSize@{setByteSize}}
|
||||
\index{setByteSize@{setByteSize}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{setByteSize()}{setByteSize()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}
|
||||
void Metadata\+::set\+Byte\+Size (\begin{DoxyParamCaption}\item[{std\+::size\+\_\+t}]{byte\+Size}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Sets the total size of the data in bytes.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em byte\+Size} & The total byte size to set.\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
It\textquotesingle{}s important to ensure this matches the actual data size in memory to prevent overflows or incorrect computations downstream.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em byte\+Size} & The total byte size to set. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}\index{Metadata@{Metadata}!setDataType@{setDataType}}
|
||||
\index{setDataType@{setDataType}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{setDataType()}{setDataType()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}
|
||||
void Metadata\+::set\+Data\+Type (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{data\+Type}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Sets the type of the data.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em data\+Type} & A string representing the data type.\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
When setting the data type, ensure it aligns with the underlying data representation. Mismatched types can lead to undefined behavior in numerical calculations.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em data\+Type} & A string representing the data type. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}\index{Metadata@{Metadata}!setDebugEnabled@{setDebugEnabled}}
|
||||
\index{setDebugEnabled@{setDebugEnabled}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{setDebugEnabled()}{setDebugEnabled()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}
|
||||
void Metadata\+::set\+Debug\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{debug\+Flag}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [noexcept]}}
|
||||
|
||||
|
||||
|
||||
Sets the debugging flag.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em debug\+Flag} & Whether debugging is enabled.\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
Enabling debugging can introduce performance overhead but provides valuable insights during development or testing.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em debug\+Flag} & Whether debugging is enabled. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\Hypertarget{class_metadata_af5264d1666839e69c192b565b5cfa606}\index{Metadata@{Metadata}!setDimensions@{setDimensions}}
|
||||
\index{setDimensions@{setDimensions}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{setDimensions()}{setDimensions()}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_af5264d1666839e69c192b565b5cfa606}
|
||||
void Metadata\+::set\+Dimensions (\begin{DoxyParamCaption}\item[{const std\+::vector$<$ std\+::size\+\_\+t $>$ \&}]{dimensions}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Sets the dimensions of the data.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em dimensions} & A vector representing the size of each dimension.\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
When modifying dimensions, verify that they are consistent with the actual data representation.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em dimensions} & A vector representing the size of each dimension. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
|
||||
|
||||
\doxysubsection{Friends And Related Symbol Documentation}
|
||||
\Hypertarget{class_metadata_a12949a1ea26c4ff1afeb97101c0493c5}\index{Metadata@{Metadata}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!Metadata@{Metadata}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
|
||||
{\footnotesize\ttfamily \label{class_metadata_a12949a1ea26c4ff1afeb97101c0493c5}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{class_metadata}{Metadata}} \&}]{metadata}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}
|
||||
|
||||
|
||||
|
||||
Prints the metadata information for debugging purposes.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream to print to. \\
|
||||
\hline
|
||||
{\em metadata} & The \doxylink{class_metadata}{Metadata} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the output stream.
|
||||
\end{DoxyReturn}
|
||||
This function provides a human-\/readable summary of the metadata. Useful for quick checks or logging during debugging sessions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream to print to. \\
|
||||
\hline
|
||||
{\em metadata} & The \doxylink{class_metadata}{Metadata} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the output stream.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/dobj/public/\mbox{\hyperlink{_metadata_8h}{Metadata.\+h}}\item
|
||||
src/dobj/private/\mbox{\hyperlink{_metadata_8cpp}{Metadata.\+cpp}}\end{DoxyCompactItemize}
|
||||
714
docs/latex/doxygen.sty
Normal file
714
docs/latex/doxygen.sty
Normal file
@@ -0,0 +1,714 @@
|
||||
\NeedsTeXFormat{LaTeX2e}
|
||||
\ProvidesPackage{doxygen}
|
||||
|
||||
% Packages used by this style file
|
||||
\RequirePackage{alltt}
|
||||
%%\RequirePackage{array} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\RequirePackage{calc}
|
||||
\RequirePackage{float}
|
||||
%%\RequirePackage{ifthen} %% moved to refman.tex due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\RequirePackage{verbatim}
|
||||
\RequirePackage[table]{xcolor}
|
||||
\RequirePackage{longtable_doxygen}
|
||||
\RequirePackage{tabu_doxygen}
|
||||
\RequirePackage{fancyvrb}
|
||||
\RequirePackage{tabularx}
|
||||
\RequirePackage{multicol}
|
||||
\RequirePackage{multirow}
|
||||
\RequirePackage{hanging}
|
||||
\RequirePackage{ifpdf}
|
||||
\RequirePackage{adjustbox}
|
||||
\RequirePackage{amssymb}
|
||||
\RequirePackage{stackengine}
|
||||
\RequirePackage{enumitem}
|
||||
\RequirePackage{alphalph}
|
||||
\RequirePackage[normalem]{ulem} % for strikeout, but don't modify emphasis
|
||||
|
||||
%---------- Internal commands used in this style file ----------------
|
||||
|
||||
\newcommand{\ensurespace}[1]{%
|
||||
\begingroup%
|
||||
\setlength{\dimen@}{#1}%
|
||||
\vskip\z@\@plus\dimen@%
|
||||
\penalty -100\vskip\z@\@plus -\dimen@%
|
||||
\vskip\dimen@%
|
||||
\penalty 9999%
|
||||
\vskip -\dimen@%
|
||||
\vskip\z@skip% hide the previous |\vskip| from |\addvspace|
|
||||
\endgroup%
|
||||
}
|
||||
|
||||
\newcommand{\DoxyHorRuler}[1]{%
|
||||
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||
\ifthenelse{#1=0}%
|
||||
{%
|
||||
\hrule%
|
||||
}%
|
||||
{%
|
||||
\hrulefilll%
|
||||
}%
|
||||
}
|
||||
\newcommand{\DoxyLabelFont}{}
|
||||
\newcommand{\entrylabel}[1]{%
|
||||
{%
|
||||
\parbox[b]{\labelwidth-4pt}{%
|
||||
\makebox[0pt][l]{\DoxyLabelFont#1}%
|
||||
\vspace{1.5\baselineskip}%
|
||||
}%
|
||||
}%
|
||||
}
|
||||
|
||||
\newenvironment{DoxyDesc}[1]{%
|
||||
\ensurespace{4\baselineskip}%
|
||||
\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
%\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}%
|
||||
\item[#1]%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
\newsavebox{\xrefbox}
|
||||
\newlength{\xreflength}
|
||||
\newcommand{\xreflabel}[1]{%
|
||||
\sbox{\xrefbox}{#1}%
|
||||
\setlength{\xreflength}{\wd\xrefbox}%
|
||||
\ifthenelse{\xreflength>\labelwidth}{%
|
||||
\begin{minipage}{\textwidth}%
|
||||
\setlength{\parindent}{0pt}%
|
||||
\hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
|
||||
\end{minipage}%
|
||||
}{%
|
||||
\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
|
||||
}%
|
||||
}
|
||||
|
||||
%---------- Commands used by doxygen LaTeX output generator ----------
|
||||
|
||||
% Used by <pre> ... </pre>
|
||||
\newenvironment{DoxyPre}{%
|
||||
\small%
|
||||
\begin{alltt}%
|
||||
}{%
|
||||
\end{alltt}%
|
||||
\normalsize%
|
||||
}
|
||||
% Necessary for redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||
\newlength{\CodeWidthChar}
|
||||
\newlength{\CodeHeightChar}
|
||||
\settowidth{\CodeWidthChar}{?}
|
||||
\settoheight{\CodeHeightChar}{?}
|
||||
% Necessary for hanging indent
|
||||
\newlength{\DoxyCodeWidth}
|
||||
|
||||
\newcommand\DoxyCodeLine[1]{
|
||||
\ifthenelse{\equal{\detokenize{#1}}{}}
|
||||
{
|
||||
\vspace*{\baselineskip}
|
||||
}
|
||||
{
|
||||
\hangpara{\DoxyCodeWidth}{1}{#1}\par
|
||||
}
|
||||
}
|
||||
|
||||
\newcommand\NiceSpace{%
|
||||
\discretionary{}{\kern\fontdimen2\font}{\kern\fontdimen2\font}%
|
||||
}
|
||||
|
||||
% Used by @code ... @endcode
|
||||
\newenvironment{DoxyCode}[1]{%
|
||||
\par%
|
||||
\vspace{2pt}%
|
||||
\scriptsize%
|
||||
\normalfont\ttfamily%
|
||||
\rightskip0pt plus 1fil%
|
||||
\settowidth{\DoxyCodeWidth}{000000}%
|
||||
\settowidth{\CodeWidthChar}{?}%
|
||||
\settoheight{\CodeHeightChar}{?}%
|
||||
\setlength{\parskip}{0ex plus 0ex minus 0ex}%
|
||||
\ifthenelse{\equal{#1}{0}}%
|
||||
{%
|
||||
{\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces%
|
||||
}%
|
||||
{%
|
||||
{\lccode`~32 \lowercase{\global\let~}}\obeyspaces%
|
||||
}%
|
||||
\vspace{2pt}%
|
||||
}{%
|
||||
\normalfont%
|
||||
\normalsize%
|
||||
\settowidth{\CodeWidthChar}{?}%
|
||||
\settoheight{\CodeHeightChar}{?}%
|
||||
}
|
||||
|
||||
% Redefining not defined characters, i.e. "Replacement Character" in tex output.
|
||||
\def\ucr{\adjustbox{width=\CodeWidthChar,height=\CodeHeightChar}{\stackinset{c}{}{c}{-.2pt}{%
|
||||
\textcolor{white}{\sffamily\bfseries\small ?}}{%
|
||||
\rotatebox{45}{$\blacksquare$}}}}
|
||||
|
||||
% Used by @example, @include, @includelineno and @dontinclude
|
||||
\newenvironment{DoxyCodeInclude}[1]{%
|
||||
\DoxyCode{#1}%
|
||||
}{%
|
||||
\endDoxyCode%
|
||||
}
|
||||
|
||||
% Used by @verbatim ... @endverbatim
|
||||
\newenvironment{DoxyVerb}{%
|
||||
\par%
|
||||
\footnotesize%
|
||||
\verbatim%
|
||||
}{%
|
||||
\endverbatim%
|
||||
\normalsize%
|
||||
}
|
||||
|
||||
% Used by @verbinclude
|
||||
\newenvironment{DoxyVerbInclude}{%
|
||||
\DoxyVerb%
|
||||
}{%
|
||||
\endDoxyVerb%
|
||||
}
|
||||
|
||||
% Used by numbered lists (using '-#' or <ol> ... </ol>)
|
||||
\setlistdepth{12}
|
||||
\newlist{DoxyEnumerate}{enumerate}{12}
|
||||
\setlist[DoxyEnumerate,1]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,2]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,3]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,4]{label=\enumAlphAlphcnt*.}
|
||||
\setlist[DoxyEnumerate,5]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,6]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,7]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,8]{label=\enumAlphAlphcnt*.}
|
||||
\setlist[DoxyEnumerate,9]{label=\arabic*.}
|
||||
\setlist[DoxyEnumerate,10]{label=(\enumalphalphcnt*)}
|
||||
\setlist[DoxyEnumerate,11]{label=\roman*.}
|
||||
\setlist[DoxyEnumerate,12]{label=\enumAlphAlphcnt*.}
|
||||
|
||||
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
|
||||
\setlistdepth{12}
|
||||
\newlist{DoxyItemize}{itemize}{12}
|
||||
\setlist[DoxyItemize]{label=\textperiodcentered}
|
||||
|
||||
\setlist[DoxyItemize,1]{label=\textbullet}
|
||||
\setlist[DoxyItemize,2]{label=\normalfont\bfseries \textendash}
|
||||
\setlist[DoxyItemize,3]{label=\textasteriskcentered}
|
||||
\setlist[DoxyItemize,4]{label=\textperiodcentered}
|
||||
|
||||
% Used for check boxes
|
||||
\newcommand{\DoxyUnchecked}{$\square$}
|
||||
\newcommand{\DoxyChecked}{\rlap{\raisebox{0.3ex}{\hspace{0.4ex}\tiny \checkmark}}$\square$}
|
||||
|
||||
% Used by description lists (using <dl> ... </dl>)
|
||||
\newenvironment{DoxyDescription}{%
|
||||
\description%
|
||||
}{%
|
||||
\enddescription%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if caption is specified)
|
||||
\newenvironment{DoxyImage}{%
|
||||
\begin{figure}[H]%
|
||||
\centering%
|
||||
}{%
|
||||
\end{figure}%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if no caption is specified)
|
||||
\newenvironment{DoxyImageNoCaption}{%
|
||||
\begin{center}%
|
||||
}{%
|
||||
\end{center}%
|
||||
}
|
||||
|
||||
% Used by @image
|
||||
% (only if inline is specified)
|
||||
\newenvironment{DoxyInlineImage}{%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by @attention
|
||||
\newenvironment{DoxyAttention}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @important
|
||||
\newenvironment{DoxyImportant}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @author and @authors
|
||||
\newenvironment{DoxyAuthor}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @date
|
||||
\newenvironment{DoxyDate}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @invariant
|
||||
\newenvironment{DoxyInvariant}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @note
|
||||
\newenvironment{DoxyNote}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @post
|
||||
\newenvironment{DoxyPostcond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @pre
|
||||
\newenvironment{DoxyPrecond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @copyright
|
||||
\newenvironment{DoxyCopyright}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @remark
|
||||
\newenvironment{DoxyRemark}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @return and @returns
|
||||
\newenvironment{DoxyReturn}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @since
|
||||
\newenvironment{DoxySince}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @see
|
||||
\newenvironment{DoxySeeAlso}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @version
|
||||
\newenvironment{DoxyVersion}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @warning
|
||||
\newenvironment{DoxyWarning}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @par and @paragraph
|
||||
\newenvironment{DoxyParagraph}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by parameter lists
|
||||
\newenvironment{DoxyParams}[2][]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\ifthenelse{\equal{#1}{}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description
|
||||
{\ifthenelse{\equal{#1}{1}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc
|
||||
}
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields of simple structs
|
||||
\newenvironment{DoxyFields}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields simple class style enums
|
||||
\newenvironment{DoxyEnumFields}[2][]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\ifthenelse{\equal{#1}{2}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}}%
|
||||
{\begin{longtabu*}spread 0pt [l]{|X[-1,l]|X[-1,r]|X[-1,l]|}}% with init value
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for parameters within a detailed function description
|
||||
\newenvironment{DoxyParamCaption}{%
|
||||
\renewcommand{\item}[3][]{\\ \hspace*{2.0cm} ##1 {\em ##2}##3}%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by return value lists
|
||||
\newenvironment{DoxyRetVals}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by exception lists
|
||||
\newenvironment{DoxyExceptions}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by template parameter lists
|
||||
\newenvironment{DoxyTemplParams}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu*}spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu*}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for member lists
|
||||
\newenvironment{DoxyCompactItemize}{%
|
||||
\begin{itemize}%
|
||||
\setlength{\itemsep}{-3pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\setlength{\partopsep}{0pt}%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
}
|
||||
|
||||
% Used for member descriptions
|
||||
\newenvironment{DoxyCompactList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\renewcommand{\makelabel}{\hfill}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used for reference lists (@bug, @deprecated, @todo, etc.)
|
||||
\newenvironment{DoxyRefList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\labelwidth}{10pt}%
|
||||
\setlength{\leftmargin}{\labelwidth}%
|
||||
\addtolength{\leftmargin}{\labelsep}%
|
||||
\renewcommand{\makelabel}{\xreflabel}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by @bug, @deprecated, @todo, etc.
|
||||
\newenvironment{DoxyRefDesc}[1]{%
|
||||
\begin{list}{}{%
|
||||
\renewcommand\makelabel[1]{\textbf{##1}}%
|
||||
\settowidth\labelwidth{\makelabel{#1}}%
|
||||
\setlength\leftmargin{\labelwidth+\labelsep}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by parameter lists and simple sections
|
||||
\newenvironment{Desc}
|
||||
{\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by tables
|
||||
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
|
||||
\newenvironment{TabularC}[1]%
|
||||
{\tabulinesep=1mm
|
||||
\begin{longtabu*}spread 0pt [c]{*#1{|X[-1]}|}}%
|
||||
{\end{longtabu*}\par}%
|
||||
|
||||
\newenvironment{TabularNC}[1]%
|
||||
{\begin{tabu}spread 0pt [l]{*#1{|X[-1]}|}}%
|
||||
{\end{tabu}\par}%
|
||||
|
||||
% Used for member group headers
|
||||
\newenvironment{Indent}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
}%
|
||||
\item[]\ignorespaces%
|
||||
}{%
|
||||
\unskip%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned on
|
||||
\newcommand{\doxylink}[2]{%
|
||||
\mbox{\hyperlink{#1}{#2}}%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned on
|
||||
% Third argument is the SectionType, see the doxygen internal
|
||||
% documentation for the values (relevant: Page ... Subsubsection).
|
||||
\newcommand{\doxysectlink}[3]{%
|
||||
\mbox{\hyperlink{#1}{#2}}%
|
||||
}
|
||||
% Used when hyperlinks are turned off
|
||||
\newcommand{\doxyref}[3]{%
|
||||
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned off
|
||||
% Fourth argument is the SectionType, see the doxygen internal
|
||||
% documentation for the values (relevant: Page ... Subsubsection).
|
||||
\newcommand{\doxysectref}[4]{%
|
||||
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned on
|
||||
\newcommand{\doxytablelink}[2]{%
|
||||
\ref{#1}%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned off
|
||||
\newcommand{\doxytableref}[3]{%
|
||||
\ref{#3}%
|
||||
}
|
||||
|
||||
% Used by @addindex
|
||||
\newcommand{\lcurly}{\{}
|
||||
\newcommand{\rcurly}{\}}
|
||||
|
||||
% Colors used for syntax highlighting
|
||||
\definecolor{comment}{rgb}{0.5,0.0,0.0}
|
||||
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
|
||||
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
|
||||
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
|
||||
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
|
||||
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
|
||||
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
|
||||
\definecolor{xmlcdata}{rgb}{0.0,0.0,0.0}
|
||||
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
|
||||
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
|
||||
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
|
||||
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
|
||||
|
||||
% Color used for table heading
|
||||
\newcommand{\tableheadbgcolor}{lightgray}%
|
||||
|
||||
% Version of hypertarget with correct landing location
|
||||
\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}}
|
||||
|
||||
% possibility to have sections etc. be within the margins
|
||||
% unfortunately had to copy part of book.cls and add \raggedright
|
||||
\makeatletter
|
||||
\newcounter{subsubsubsection}[subsubsection]
|
||||
\newcounter{subsubsubsubsection}[subsubsubsection]
|
||||
\newcounter{subsubsubsubsubsection}[subsubsubsubsection]
|
||||
\newcounter{subsubsubsubsubsubsection}[subsubsubsubsubsection]
|
||||
\renewcommand{\thesubsubsubsection}{\thesubsubsection.\arabic{subsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsection}{\thesubsubsubsection.\arabic{subsubsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsubsection}{\thesubsubsubsubsection.\arabic{subsubsubsubsubsection}}
|
||||
\renewcommand{\thesubsubsubsubsubsubsection}{\thesubsubsubsubsubsection.\arabic{subsubsubsubsubsubsection}}
|
||||
\newcommand{\subsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsubsectionmark}[1]{}
|
||||
\newcommand{\subsubsubsubsubsubsectionmark}[1]{}
|
||||
\def\toclevel@subsubsubsection{4}
|
||||
\def\toclevel@subsubsubsubsection{5}
|
||||
\def\toclevel@subsubsubsubsubsection{6}
|
||||
\def\toclevel@subsubsubsubsubsubsection{7}
|
||||
\def\toclevel@paragraph{8}
|
||||
\def\toclevel@subparagraph{9}
|
||||
|
||||
\newcommand\doxysection{\@startsection {section}{1}{\z@}%
|
||||
{-3.5ex \@plus -1ex \@minus -.2ex}%
|
||||
{2.3ex \@plus.2ex}%
|
||||
{\raggedright\normalfont\Large\bfseries}}
|
||||
\newcommand\doxysubsection{\@startsection{subsection}{2}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\large\bfseries}}
|
||||
\newcommand\doxysubsubsection{\@startsection{subsubsection}{3}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsection{\@startsection{subsubsubsection}{4}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsection{\@startsection{subsubsubsubsection}{5}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsubsection{\@startsection{subsubsubsubsubsection}{6}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubsubsubsubsubsubsection{\@startsection{subsubsubsubsubsubsection}{7}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxyparagraph{\@startsection{paragraph}{8}{\z@}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
\newcommand\doxysubparagraph{\@startsection{subparagraph}{9}{\parindent}%
|
||||
{-3.25ex\@plus -1ex \@minus -.2ex}%
|
||||
{1.5ex \@plus .2ex}%
|
||||
{\raggedright\normalfont\normalsize\bfseries}}
|
||||
|
||||
\newcommand\l@subsubsubsection{\@dottedtocline{4}{10.0em}{7.8em}}
|
||||
\newcommand\l@subsubsubsubsection{\@dottedtocline{5}{13.0em}{9.4em}}
|
||||
\newcommand\l@subsubsubsubsubsection{\@dottedtocline{6}{15.0em}{11em}}
|
||||
\newcommand\l@subsubsubsubsubsubsection{\@dottedtocline{7}{18.0em}{12.6em}}
|
||||
\renewcommand\l@paragraph{\@dottedtocline{8}{21.0em}{14.2em}}
|
||||
\renewcommand\l@subparagraph{\@dottedtocline{9}{24.0em}{15.8em}}
|
||||
\makeatother
|
||||
% the sectsty doesn't look to be maintained but gives, in our case, some warning like:
|
||||
% LaTeX Warning: Command \underline has changed.
|
||||
% Check if current package is valid.
|
||||
% unfortunately had to copy the relevant part
|
||||
\newcommand*{\doxypartfont} [1]
|
||||
{\gdef\SS@partnumberfont{\SS@sectid{0}\SS@nopart\SS@makeulinepartchap#1}
|
||||
\gdef\SS@parttitlefont{\SS@sectid{0}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxychapterfont} [1]
|
||||
{\gdef\SS@chapnumfont{\SS@sectid{1}\SS@nopart\SS@makeulinepartchap#1}
|
||||
\gdef\SS@chaptitlefont{\SS@sectid{1}\SS@titlepart\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxysectionfont} [1]
|
||||
{\gdef\SS@sectfont{\SS@sectid{2}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubsectionfont} [1]
|
||||
{\gdef\SS@subsectfont{\SS@sectid{3}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubsubsectionfont} [1]
|
||||
{\gdef\SS@subsubsectfont{\SS@sectid{4}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxyparagraphfont} [1]
|
||||
{\gdef\SS@parafont{\SS@sectid{5}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxysubparagraphfont} [1]
|
||||
{\gdef\SS@subparafont{\SS@sectid{6}\SS@rr\SS@makeulinesect#1}}
|
||||
\newcommand*{\doxyminisecfont} [1]
|
||||
{\gdef\SS@minisecfont{\SS@sectid{7}\SS@rr\SS@makeulinepartchap#1}}
|
||||
\newcommand*{\doxyallsectionsfont} [1] {\doxypartfont{#1}%
|
||||
\doxychapterfont{#1}%
|
||||
\doxysectionfont{#1}%
|
||||
\doxysubsectionfont{#1}%
|
||||
\doxysubsubsectionfont{#1}%
|
||||
\doxyparagraphfont{#1}%
|
||||
\doxysubparagraphfont{#1}%
|
||||
\doxyminisecfont{#1}}%
|
||||
% Define caption that is also suitable in a table
|
||||
% for usage with hyperlinks
|
||||
\makeatletter
|
||||
\def\doxyfigcaption{%
|
||||
\H@refstepcounter{figure}%
|
||||
\@dblarg{\@caption{figure}}}
|
||||
|
||||
% for usage without hyperlinks
|
||||
\def\doxyfigcaptionnolink{%
|
||||
\refstepcounter{figure}%
|
||||
\@dblarg{\@caption{figure}}}
|
||||
\makeatother
|
||||
|
||||
% Define alpha enumarative names for counters > 26
|
||||
\makeatletter
|
||||
\def\enumalphalphcnt#1{\expandafter\@enumalphalphcnt\csname c@#1\endcsname}
|
||||
\def\@enumalphalphcnt#1{\alphalph{#1}}
|
||||
\def\enumAlphAlphcnt#1{\expandafter\@enumAlphAlphcnt\csname c@#1\endcsname}
|
||||
\def\@enumAlphAlphcnt#1{\AlphAlph{#1}}
|
||||
\makeatother
|
||||
\AddEnumerateCounter{\enumalphalphcnt}{\@enumalphalphcnt}{aa}
|
||||
\AddEnumerateCounter{\enumAlphAlphcnt}{\@enumAlphAlphcnt}{AA}
|
||||
2178
docs/latex/etoc_doxygen.sty
Normal file
2178
docs/latex/etoc_doxygen.sty
Normal file
File diff suppressed because it is too large
Load Diff
10
docs/latex/files.tex
Normal file
10
docs/latex/files.tex
Normal file
@@ -0,0 +1,10 @@
|
||||
\doxysection{File List}
|
||||
Here is a list of all documented files with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_debug_info_8h_source}{Debug\+Info.\+h}} }{\pageref{_debug_info_8h_source}}{}
|
||||
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_d_object_8cpp}{DObject.\+cpp}} \\*Implementation of the \doxylink{class_d_object}{DObject} class }{\pageref{_d_object_8cpp}}{}
|
||||
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_d_object_private_8h_source}{DObject\+Private.\+h}} }{\pageref{_d_object_private_8h_source}}{}
|
||||
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{_metadata_8cpp}{Metadata.\+cpp}} \\*Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module }{\pageref{_metadata_8cpp}}{}
|
||||
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_d_object_8h}{DObject.\+h}} \\*Defines the \doxylink{class_d_object}{DObject} class, a universal data container for the project }{\pageref{_d_object_8h}}{}
|
||||
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_lockable_d_object_8h}{Lockable\+DObject.\+h}} \\*A lightweight wrapper for \doxylink{class_d_object}{DObject} that adds locking capabilities }{\pageref{_lockable_d_object_8h}}{}
|
||||
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{_metadata_8h}{Metadata.\+h}} \\*Public interface for the \doxylink{class_metadata}{Metadata} class used in the dobj module }{\pageref{_metadata_8h}}{}
|
||||
\end{DoxyCompactList}
|
||||
459
docs/latex/longtable_doxygen.sty
Normal file
459
docs/latex/longtable_doxygen.sty
Normal file
@@ -0,0 +1,459 @@
|
||||
%%
|
||||
%% This is file `longtable.sty',
|
||||
%% generated with the docstrip utility.
|
||||
%%
|
||||
%% The original source files were:
|
||||
%%
|
||||
%% longtable.dtx (with options: `package')
|
||||
%%
|
||||
%% This is a generated file.
|
||||
%%
|
||||
%% The source is maintained by the LaTeX Project team and bug
|
||||
%% reports for it can be opened at http://latex-project.org/bugs.html
|
||||
%% (but please observe conditions on bug reports sent to that address!)
|
||||
%%
|
||||
%% Copyright 1993-2016
|
||||
%% The LaTeX3 Project and any individual authors listed elsewhere
|
||||
%% in this file.
|
||||
%%
|
||||
%% This file was generated from file(s) of the Standard LaTeX `Tools Bundle'.
|
||||
%% --------------------------------------------------------------------------
|
||||
%%
|
||||
%% It may be distributed and/or modified under the
|
||||
%% conditions of the LaTeX Project Public License, either version 1.3c
|
||||
%% of this license or (at your option) any later version.
|
||||
%% The latest version of this license is in
|
||||
%% http://www.latex-project.org/lppl.txt
|
||||
%% and version 1.3c or later is part of all distributions of LaTeX
|
||||
%% version 2005/12/01 or later.
|
||||
%%
|
||||
%% This file may only be distributed together with a copy of the LaTeX
|
||||
%% `Tools Bundle'. You may however distribute the LaTeX `Tools Bundle'
|
||||
%% without such generated files.
|
||||
%%
|
||||
%% The list of all files belonging to the LaTeX `Tools Bundle' is
|
||||
%% given in the file `manifest.txt'.
|
||||
%%
|
||||
%% File: longtable.dtx Copyright (C) 1990-2001 David Carlisle
|
||||
\NeedsTeXFormat{LaTeX2e}[1995/06/01]
|
||||
\ProvidesPackage{longtable_doxygen}
|
||||
[2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen]
|
||||
\def\LT@err{\PackageError{longtable}}
|
||||
\def\LT@warn{\PackageWarning{longtable}}
|
||||
\def\LT@final@warn{%
|
||||
\AtEndDocument{%
|
||||
\LT@warn{Table \@width s have changed. Rerun LaTeX.\@gobbletwo}}%
|
||||
\global\let\LT@final@warn\relax}
|
||||
\DeclareOption{errorshow}{%
|
||||
\def\LT@warn{\PackageInfo{longtable}}}
|
||||
\DeclareOption{pausing}{%
|
||||
\def\LT@warn#1{%
|
||||
\LT@err{#1}{This is not really an error}}}
|
||||
\DeclareOption{set}{}
|
||||
\DeclareOption{final}{}
|
||||
\ProcessOptions
|
||||
\newskip\LTleft \LTleft=\fill
|
||||
\newskip\LTright \LTright=\fill
|
||||
\newskip\LTpre \LTpre=\bigskipamount
|
||||
\newskip\LTpost \LTpost=\bigskipamount
|
||||
\newcount\LTchunksize \LTchunksize=20
|
||||
\let\c@LTchunksize\LTchunksize
|
||||
\newdimen\LTcapwidth \LTcapwidth=4in
|
||||
\newbox\LT@head
|
||||
\newbox\LT@firsthead
|
||||
\newbox\LT@foot
|
||||
\newbox\LT@lastfoot
|
||||
\newcount\LT@cols
|
||||
\newcount\LT@rows
|
||||
\newcounter{LT@tables}
|
||||
\newcounter{LT@chunks}[LT@tables]
|
||||
\ifx\c@table\undefined
|
||||
\newcounter{table}
|
||||
\def\fnum@table{\tablename~\thetable}
|
||||
\fi
|
||||
\ifx\tablename\undefined
|
||||
\def\tablename{Table}
|
||||
\fi
|
||||
\newtoks\LT@p@ftn
|
||||
\mathchardef\LT@end@pen=30000
|
||||
\def\longtable{%
|
||||
\par
|
||||
\ifx\multicols\@undefined
|
||||
\else
|
||||
\ifnum\col@number>\@ne
|
||||
\@twocolumntrue
|
||||
\fi
|
||||
\fi
|
||||
\if@twocolumn
|
||||
\LT@err{longtable not in 1-column mode}\@ehc
|
||||
\fi
|
||||
\begingroup
|
||||
\@ifnextchar[\LT@array{\LT@array[x]}}
|
||||
\def\LT@array[#1]#2{%
|
||||
\refstepcounter{table}\stepcounter{LT@tables}%
|
||||
\if l#1%
|
||||
\LTleft\z@ \LTright\fill
|
||||
\else\if r#1%
|
||||
\LTleft\fill \LTright\z@
|
||||
\else\if c#1%
|
||||
\LTleft\fill \LTright\fill
|
||||
\fi\fi\fi
|
||||
\let\LT@mcol\multicolumn
|
||||
\let\LT@@tabarray\@tabarray
|
||||
\let\LT@@hl\hline
|
||||
\def\@tabarray{%
|
||||
\let\hline\LT@@hl
|
||||
\LT@@tabarray}%
|
||||
\let\\\LT@tabularcr\let\tabularnewline\\%
|
||||
\def\newpage{\noalign{\break}}%
|
||||
\def\pagebreak{\noalign{\ifnum`}=0\fi\@testopt{\LT@no@pgbk-}4}%
|
||||
\def\nopagebreak{\noalign{\ifnum`}=0\fi\@testopt\LT@no@pgbk4}%
|
||||
\let\hline\LT@hline \let\kill\LT@kill\let\caption\LT@caption
|
||||
\@tempdima\ht\strutbox
|
||||
\let\@endpbox\LT@endpbox
|
||||
\ifx\extrarowheight\@undefined
|
||||
\let\@acol\@tabacol
|
||||
\let\@classz\@tabclassz \let\@classiv\@tabclassiv
|
||||
\def\@startpbox{\vtop\LT@startpbox}%
|
||||
\let\@@startpbox\@startpbox
|
||||
\let\@@endpbox\@endpbox
|
||||
\let\LT@LL@FM@cr\@tabularcr
|
||||
\else
|
||||
\advance\@tempdima\extrarowheight
|
||||
\col@sep\tabcolsep
|
||||
\let\@startpbox\LT@startpbox\let\LT@LL@FM@cr\@arraycr
|
||||
\fi
|
||||
\setbox\@arstrutbox\hbox{\vrule
|
||||
\@height \arraystretch \@tempdima
|
||||
\@depth \arraystretch \dp \strutbox
|
||||
\@width \z@}%
|
||||
\let\@sharp##\let\protect\relax
|
||||
\begingroup
|
||||
\@mkpream{#2}%
|
||||
\xdef\LT@bchunk{%
|
||||
\global\advance\c@LT@chunks\@ne
|
||||
\global\LT@rows\z@\setbox\z@\vbox\bgroup
|
||||
\LT@setprevdepth
|
||||
\tabskip\LTleft \noexpand\halign to\hsize\bgroup
|
||||
\tabskip\z@ \@arstrut \@preamble \tabskip\LTright \cr}%
|
||||
\endgroup
|
||||
\expandafter\LT@nofcols\LT@bchunk&\LT@nofcols
|
||||
\LT@make@row
|
||||
\m@th\let\par\@empty
|
||||
\everycr{}\lineskip\z@\baselineskip\z@
|
||||
\LT@bchunk}
|
||||
\def\LT@no@pgbk#1[#2]{\penalty #1\@getpen{#2}\ifnum`{=0\fi}}
|
||||
\def\LT@start{%
|
||||
\let\LT@start\endgraf
|
||||
\endgraf\penalty\z@\vskip\LTpre
|
||||
\dimen@\pagetotal
|
||||
\advance\dimen@ \ht\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||
\advance\dimen@ \dp\ifvoid\LT@firsthead\LT@head\else\LT@firsthead\fi
|
||||
\advance\dimen@ \ht\LT@foot
|
||||
\dimen@ii\vfuzz
|
||||
\vfuzz\maxdimen
|
||||
\setbox\tw@\copy\z@
|
||||
\setbox\tw@\vsplit\tw@ to \ht\@arstrutbox
|
||||
\setbox\tw@\vbox{\unvbox\tw@}%
|
||||
\vfuzz\dimen@ii
|
||||
\advance\dimen@ \ht
|
||||
\ifdim\ht\@arstrutbox>\ht\tw@\@arstrutbox\else\tw@\fi
|
||||
\advance\dimen@\dp
|
||||
\ifdim\dp\@arstrutbox>\dp\tw@\@arstrutbox\else\tw@\fi
|
||||
\advance\dimen@ -\pagegoal
|
||||
\ifdim \dimen@>\z@\vfil\break\fi
|
||||
\global\@colroom\@colht
|
||||
\ifvoid\LT@foot\else
|
||||
\global\advance\vsize-\ht\LT@foot
|
||||
\global\advance\@colroom-\ht\LT@foot
|
||||
\dimen@\pagegoal\advance\dimen@-\ht\LT@foot\pagegoal\dimen@
|
||||
\maxdepth\z@
|
||||
\fi
|
||||
\ifvoid\LT@firsthead\copy\LT@head\else\box\LT@firsthead\fi\nobreak
|
||||
\output{\LT@output}}
|
||||
\def\endlongtable{%
|
||||
\crcr
|
||||
\noalign{%
|
||||
\let\LT@entry\LT@entry@chop
|
||||
\xdef\LT@save@row{\LT@save@row}}%
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\if@filesw
|
||||
{\let\LT@entry\LT@entry@write\immediate\write\@auxout{%
|
||||
\gdef\expandafter\noexpand
|
||||
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||
{\LT@save@row}}}%
|
||||
\fi
|
||||
\ifx\LT@save@row\LT@@save@row
|
||||
\else
|
||||
\LT@warn{Column \@width s have changed\MessageBreak
|
||||
in table \thetable}%
|
||||
\LT@final@warn
|
||||
\fi
|
||||
\endgraf\penalty -\LT@end@pen
|
||||
\ifvoid\LT@foot\else
|
||||
\global\advance\vsize\ht\LT@foot
|
||||
\global\advance\@colroom\ht\LT@foot
|
||||
\dimen@\pagegoal\advance\dimen@\ht\LT@foot\pagegoal\dimen@
|
||||
\fi
|
||||
\endgroup
|
||||
\global\@mparbottom\z@
|
||||
\endgraf\penalty\z@\addvspace\LTpost
|
||||
\ifvoid\footins\else\insert\footins{}\fi}
|
||||
\def\LT@nofcols#1&{%
|
||||
\futurelet\@let@token\LT@n@fcols}
|
||||
\def\LT@n@fcols{%
|
||||
\advance\LT@cols\@ne
|
||||
\ifx\@let@token\LT@nofcols
|
||||
\expandafter\@gobble
|
||||
\else
|
||||
\expandafter\LT@nofcols
|
||||
\fi}
|
||||
\def\LT@tabularcr{%
|
||||
\relax\iffalse{\fi\ifnum0=`}\fi
|
||||
\@ifstar
|
||||
{\def\crcr{\LT@crcr\noalign{\nobreak}}\let\cr\crcr
|
||||
\LT@t@bularcr}%
|
||||
{\LT@t@bularcr}}
|
||||
\let\LT@crcr\crcr
|
||||
\let\LT@setprevdepth\relax
|
||||
\def\LT@t@bularcr{%
|
||||
\global\advance\LT@rows\@ne
|
||||
\ifnum\LT@rows=\LTchunksize
|
||||
\gdef\LT@setprevdepth{%
|
||||
\prevdepth\z@\global
|
||||
\global\let\LT@setprevdepth\relax}%
|
||||
\expandafter\LT@xtabularcr
|
||||
\else
|
||||
\ifnum0=`{}\fi
|
||||
\expandafter\LT@LL@FM@cr
|
||||
\fi}
|
||||
\def\LT@xtabularcr{%
|
||||
\@ifnextchar[\LT@argtabularcr\LT@ntabularcr}
|
||||
\def\LT@ntabularcr{%
|
||||
\ifnum0=`{}\fi
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\LT@argtabularcr[#1]{%
|
||||
\ifnum0=`{}\fi
|
||||
\ifdim #1>\z@
|
||||
\unskip\@xargarraycr{#1}%
|
||||
\else
|
||||
\@yargarraycr{#1}%
|
||||
\fi
|
||||
\LT@echunk
|
||||
\LT@start
|
||||
\unvbox\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\LT@echunk{%
|
||||
\crcr\LT@save@row\cr\egroup
|
||||
\global\setbox\@ne\lastbox
|
||||
\unskip
|
||||
\egroup}
|
||||
\def\LT@entry#1#2{%
|
||||
\ifhmode\@firstofone{&}\fi\omit
|
||||
\ifnum#1=\c@LT@chunks
|
||||
\else
|
||||
\kern#2\relax
|
||||
\fi}
|
||||
\def\LT@entry@chop#1#2{%
|
||||
\noexpand\LT@entry
|
||||
{\ifnum#1>\c@LT@chunks
|
||||
1}{0pt%
|
||||
\else
|
||||
#1}{#2%
|
||||
\fi}}
|
||||
\def\LT@entry@write{%
|
||||
\noexpand\LT@entry^^J%
|
||||
\@spaces}
|
||||
\def\LT@kill{%
|
||||
\LT@echunk
|
||||
\LT@get@widths
|
||||
\expandafter\LT@rebox\LT@bchunk}
|
||||
\def\LT@rebox#1\bgroup{%
|
||||
#1\bgroup
|
||||
\unvbox\z@
|
||||
\unskip
|
||||
\setbox\z@\lastbox}
|
||||
\def\LT@blank@row{%
|
||||
\xdef\LT@save@row{\expandafter\LT@build@blank
|
||||
\romannumeral\number\LT@cols 001 }}
|
||||
\def\LT@build@blank#1{%
|
||||
\if#1m%
|
||||
\noexpand\LT@entry{1}{0pt}%
|
||||
\expandafter\LT@build@blank
|
||||
\fi}
|
||||
\def\LT@make@row{%
|
||||
\global\expandafter\let\expandafter\LT@save@row
|
||||
\csname LT@\romannumeral\c@LT@tables\endcsname
|
||||
\ifx\LT@save@row\relax
|
||||
\LT@blank@row
|
||||
\else
|
||||
{\let\LT@entry\or
|
||||
\if!%
|
||||
\ifcase\expandafter\expandafter\expandafter\LT@cols
|
||||
\expandafter\@gobble\LT@save@row
|
||||
\or
|
||||
\else
|
||||
\relax
|
||||
\fi
|
||||
!%
|
||||
\else
|
||||
\aftergroup\LT@blank@row
|
||||
\fi}%
|
||||
\fi}
|
||||
\let\setlongtables\relax
|
||||
\def\LT@get@widths{%
|
||||
\setbox\tw@\hbox{%
|
||||
\unhbox\@ne
|
||||
\let\LT@old@row\LT@save@row
|
||||
\global\let\LT@save@row\@empty
|
||||
\count@\LT@cols
|
||||
\loop
|
||||
\unskip
|
||||
\setbox\tw@\lastbox
|
||||
\ifhbox\tw@
|
||||
\LT@def@row
|
||||
\advance\count@\m@ne
|
||||
\repeat}%
|
||||
\ifx\LT@@save@row\@undefined
|
||||
\let\LT@@save@row\LT@save@row
|
||||
\fi}
|
||||
\def\LT@def@row{%
|
||||
\let\LT@entry\or
|
||||
\edef\@tempa{%
|
||||
\ifcase\expandafter\count@\LT@old@row
|
||||
\else
|
||||
{1}{0pt}%
|
||||
\fi}%
|
||||
\let\LT@entry\relax
|
||||
\xdef\LT@save@row{%
|
||||
\LT@entry
|
||||
\expandafter\LT@max@sel\@tempa
|
||||
\LT@save@row}}
|
||||
\def\LT@max@sel#1#2{%
|
||||
{\ifdim#2=\wd\tw@
|
||||
#1%
|
||||
\else
|
||||
\number\c@LT@chunks
|
||||
\fi}%
|
||||
{\the\wd\tw@}}
|
||||
\def\LT@hline{%
|
||||
\noalign{\ifnum0=`}\fi
|
||||
\penalty\@M
|
||||
\futurelet\@let@token\LT@@hline}
|
||||
\def\LT@@hline{%
|
||||
\ifx\@let@token\hline
|
||||
\global\let\@gtempa\@gobble
|
||||
\gdef\LT@sep{\penalty-\@medpenalty\vskip\doublerulesep}%
|
||||
\else
|
||||
\global\let\@gtempa\@empty
|
||||
\gdef\LT@sep{\penalty-\@lowpenalty\vskip-\arrayrulewidth}%
|
||||
\fi
|
||||
\ifnum0=`{\fi}%
|
||||
\multispan\LT@cols
|
||||
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||
\noalign{\LT@sep}%
|
||||
\multispan\LT@cols
|
||||
\unskip\leaders\hrule\@height\arrayrulewidth\hfill\cr
|
||||
\noalign{\penalty\@M}%
|
||||
\@gtempa}
|
||||
\def\LT@caption{%
|
||||
\noalign\bgroup
|
||||
\@ifnextchar[{\egroup\LT@c@ption\@firstofone}\LT@capti@n}
|
||||
\def\LT@c@ption#1[#2]#3{%
|
||||
\LT@makecaption#1\fnum@table{#3}%
|
||||
\def\@tempa{#2}%
|
||||
\ifx\@tempa\@empty\else
|
||||
{\let\\\space
|
||||
\addcontentsline{lot}{table}{\protect\numberline{\thetable}{#2}}}%
|
||||
\fi}
|
||||
\def\LT@capti@n{%
|
||||
\@ifstar
|
||||
{\egroup\LT@c@ption\@gobble[]}%
|
||||
{\egroup\@xdblarg{\LT@c@ption\@firstofone}}}
|
||||
\def\LT@makecaption#1#2#3{%
|
||||
\LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
|
||||
\sbox\@tempboxa{#1{#2: }#3}%
|
||||
\ifdim\wd\@tempboxa>\hsize
|
||||
#1{#2: }#3%
|
||||
\else
|
||||
\hbox to\hsize{\hfil\box\@tempboxa\hfil}%
|
||||
\fi
|
||||
\endgraf\vskip\baselineskip}%
|
||||
\hss}}}
|
||||
\def\LT@output{%
|
||||
\ifnum\outputpenalty <-\@Mi
|
||||
\ifnum\outputpenalty > -\LT@end@pen
|
||||
\LT@err{floats and marginpars not allowed in a longtable}\@ehc
|
||||
\else
|
||||
\setbox\z@\vbox{\unvbox\@cclv}%
|
||||
\ifdim \ht\LT@lastfoot>\ht\LT@foot
|
||||
\dimen@\pagegoal
|
||||
\advance\dimen@\ht\LT@foot
|
||||
\advance\dimen@-\ht\LT@lastfoot
|
||||
\ifdim\dimen@<\ht\z@
|
||||
\setbox\@cclv\vbox{\unvbox\z@\copy\LT@foot\vss}%
|
||||
\@makecol
|
||||
\@outputpage
|
||||
\global\vsize\@colroom
|
||||
\setbox\z@\vbox{\box\LT@head}%
|
||||
\fi
|
||||
\fi
|
||||
\unvbox\z@\ifvoid\LT@lastfoot\copy\LT@foot\else\box\LT@lastfoot\fi
|
||||
\fi
|
||||
\else
|
||||
\setbox\@cclv\vbox{\unvbox\@cclv\copy\LT@foot\vss}%
|
||||
\@makecol
|
||||
\@outputpage
|
||||
\global\vsize\@colroom
|
||||
\copy\LT@head\nobreak
|
||||
\fi}
|
||||
\def\LT@end@hd@ft#1{%
|
||||
\LT@echunk
|
||||
\ifx\LT@start\endgraf
|
||||
\LT@err
|
||||
{Longtable head or foot not at start of table}%
|
||||
{Increase LTchunksize}%
|
||||
\fi
|
||||
\setbox#1\box\z@
|
||||
\LT@get@widths
|
||||
\LT@bchunk}
|
||||
\def\endfirsthead{\LT@end@hd@ft\LT@firsthead}
|
||||
\def\endhead{\LT@end@hd@ft\LT@head}
|
||||
\def\endfoot{\LT@end@hd@ft\LT@foot}
|
||||
\def\endlastfoot{\LT@end@hd@ft\LT@lastfoot}
|
||||
\def\LT@startpbox#1{%
|
||||
\bgroup
|
||||
\let\@footnotetext\LT@p@ftntext
|
||||
\setlength\hsize{#1}%
|
||||
\@arrayparboxrestore
|
||||
\vrule \@height \ht\@arstrutbox \@width \z@}
|
||||
\def\LT@endpbox{%
|
||||
\@finalstrut\@arstrutbox
|
||||
\egroup
|
||||
\the\LT@p@ftn
|
||||
\global\LT@p@ftn{}%
|
||||
\hfil}
|
||||
%% added \long to prevent:
|
||||
% LaTeX Warning: Command \LT@p@ftntext has changed.
|
||||
%
|
||||
% from the original repository (https://github.com/latex3/latex2e/blob/develop/required/tools/longtable.dtx):
|
||||
% \changes{v4.15}{2021/03/28}
|
||||
% {make long for gh/364}
|
||||
% Inside the `p' column, just save up the footnote text in a token
|
||||
% register.
|
||||
\long\def\LT@p@ftntext#1{%
|
||||
\edef\@tempa{\the\LT@p@ftn\noexpand\footnotetext[\the\c@footnote]}%
|
||||
\global\LT@p@ftn\expandafter{\@tempa{#1}}}%
|
||||
|
||||
\@namedef{ver@longtable.sty}{2014/10/28 v4.11 Multi-page Table package (DPC) - frozen version for doxygen}
|
||||
\endinput
|
||||
%%
|
||||
%% End of file `longtable.sty'.
|
||||
194
docs/latex/refman.aux
Normal file
194
docs/latex/refman.aux
Normal file
@@ -0,0 +1,194 @@
|
||||
\relax
|
||||
\providecommand\hyper@newdestlabel[2]{}
|
||||
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
|
||||
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
|
||||
\global\let\oldnewlabel\newlabel
|
||||
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
|
||||
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
|
||||
\AtEndDocument{\ifx\hyper@anchor\@undefined
|
||||
\let\newlabel\oldnewlabel
|
||||
\fi}
|
||||
\fi}
|
||||
\global\let\hyper@last\relax
|
||||
\gdef\HyperFirstAtBeginDocument#1{#1}
|
||||
\providecommand\HyField@AuxAddToFields[1]{}
|
||||
\providecommand\HyField@AuxAddToCoFields[2]{}
|
||||
\providecommand \oddpage@label [2]{}
|
||||
\@writefile{toc}{\@ifundefined {etoctocstyle}{\let \etoc@startlocaltoc \@gobble \let \etoc@settocdepth \@gobble \let \etoc@depthtag \@gobble \let \etoc@setlocaltop \@gobble }{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {1}Class Index}{1}{chapter.1}\protected@file@percent }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {1.1}Class List}{1}{section.1.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {2}File Index}{3}{chapter.2}\protected@file@percent }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.1}File List}{3}{section.2.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Class Documentation}{5}{chapter.3}\protected@file@percent }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.1}DObject Class Reference}{5}{section.3.1}\protected@file@percent }
|
||||
\newlabel{class_d_object}{{3.1}{5}{DObject Class Reference}{section.3.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.1}Detailed Description}{6}{subsection.3.1.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.2}Member Typedef Documentation}{6}{subsection.3.1.2}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2.1}DataType}{6}{subsubsection.3.1.2.1}\protected@file@percent }
|
||||
\newlabel{class_d_object_ad6fc2e29eae70cf94a2d241527857573}{{3.1.2.1}{6}{\texorpdfstring {DataType}{DataType}}{subsubsection.3.1.2.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2.2}Plugin}{6}{subsubsection.3.1.2.2}\protected@file@percent }
|
||||
\newlabel{class_d_object_af11334d08ef85c68b3aae7554548e5a7}{{3.1.2.2}{6}{\texorpdfstring {Plugin}{Plugin}}{subsubsection.3.1.2.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.3}Constructor \& Destructor Documentation}{6}{subsection.3.1.3}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.3.1}DObject()\hspace {0.1cm}{\footnotesize \ttfamily [1/2]}}{6}{subsubsection.3.1.3.1}\protected@file@percent }
|
||||
\newlabel{class_d_object_a0ae54853e18265657296bfb5ac3bf9d0}{{3.1.3.1}{6}{\texorpdfstring {DObject()}{DObject()}\hspace {0.1cm}{\footnotesize \ttfamily [1/2]}}{subsubsection.3.1.3.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.3.2}DObject()\hspace {0.1cm}{\footnotesize \ttfamily [2/2]}}{6}{subsubsection.3.1.3.2}\protected@file@percent }
|
||||
\newlabel{class_d_object_ab0c940fa193a42158c6726bf1a2ef54d}{{3.1.3.2}{6}{\texorpdfstring {DObject()}{DObject()}\hspace {0.1cm}{\footnotesize \ttfamily [2/2]}}{subsubsection.3.1.3.2}{}}
|
||||
\gdef \LT@i {\LT@entry
|
||||
{3}{50.3202pt}\LT@entry
|
||||
{3}{159.9786pt}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.4}Member Function Documentation}{7}{subsection.3.1.4}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.1}getData()}{7}{subsubsection.3.1.4.1}\protected@file@percent }
|
||||
\newlabel{class_d_object_a4862655c3634d019b0a45b811d6f7235}{{3.1.4.1}{7}{\texorpdfstring {getData()}{getData()}}{subsubsection.3.1.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.2}getMetadata()}{7}{subsubsection.3.1.4.2}\protected@file@percent }
|
||||
\newlabel{class_d_object_a157b31e881aac6dd40782d3abc561d4e}{{3.1.4.2}{7}{\texorpdfstring {getMetadata()}{getMetadata()}}{subsubsection.3.1.4.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.3}isDebuggingEnabled()}{7}{subsubsection.3.1.4.3}\protected@file@percent }
|
||||
\newlabel{class_d_object_ae47bf220fbe2173cf6933c2380035dbd}{{3.1.4.3}{7}{\texorpdfstring {isDebuggingEnabled()}{isDebuggingEnabled()}}{subsubsection.3.1.4.3}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.4}registerPlugin()}{7}{subsubsection.3.1.4.4}\protected@file@percent }
|
||||
\newlabel{class_d_object_a15afffdf339150fc872bf63bdd08d581}{{3.1.4.4}{7}{\texorpdfstring {registerPlugin()}{registerPlugin()}}{subsubsection.3.1.4.4}{}}
|
||||
\gdef \LT@ii {\LT@entry
|
||||
{3}{36.81152pt}\LT@entry
|
||||
{3}{141.19608pt}}
|
||||
\gdef \LT@iii {\LT@entry
|
||||
{3}{19.80185pt}\LT@entry
|
||||
{3}{191.3252pt}}
|
||||
\gdef \LT@iv {\LT@entry
|
||||
{3}{30.3136pt}\LT@entry
|
||||
{3}{161.29266pt}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.5}runAllPlugins()}{8}{subsubsection.3.1.4.5}\protected@file@percent }
|
||||
\newlabel{class_d_object_a1223275dcbbf20334ea11707346acb93}{{3.1.4.5}{8}{\texorpdfstring {runAllPlugins()}{runAllPlugins()}}{subsubsection.3.1.4.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.6}runPlugin()}{8}{subsubsection.3.1.4.6}\protected@file@percent }
|
||||
\newlabel{class_d_object_a99072eb52bb22745f0248f273fbf28fb}{{3.1.4.6}{8}{\texorpdfstring {runPlugin()}{runPlugin()}}{subsubsection.3.1.4.6}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.7}setData()}{8}{subsubsection.3.1.4.7}\protected@file@percent }
|
||||
\newlabel{class_d_object_ab1718571434e84e90f1ec463e4786a8a}{{3.1.4.7}{8}{\texorpdfstring {setData()}{setData()}}{subsubsection.3.1.4.7}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.8}setDebugging()}{8}{subsubsection.3.1.4.8}\protected@file@percent }
|
||||
\newlabel{class_d_object_a6f0023aee463e71d92442dcf61b6ed47}{{3.1.4.8}{8}{\texorpdfstring {setDebugging()}{setDebugging()}}{subsubsection.3.1.4.8}{}}
|
||||
\gdef \LT@v {\LT@entry
|
||||
{3}{65.9711pt}\LT@entry
|
||||
{3}{187.7431pt}}
|
||||
\gdef \LT@vi {\LT@entry
|
||||
{3}{50.3202pt}\LT@entry
|
||||
{3}{208.30786pt}}
|
||||
\gdef \LT@vii {\LT@entry
|
||||
{3}{19.80185pt}\LT@entry
|
||||
{3}{200.04575pt}}
|
||||
\gdef \LT@viii {\LT@entry
|
||||
{3}{24.80576pt}\LT@entry
|
||||
{3}{129.22621pt}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.9}setMetadata()}{9}{subsubsection.3.1.4.9}\protected@file@percent }
|
||||
\newlabel{class_d_object_a296b1519249fdc1f6c7b4ab62d5421bc}{{3.1.4.9}{9}{\texorpdfstring {setMetadata()}{setMetadata()}}{subsubsection.3.1.4.9}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.4.10}unregisterPlugin()}{9}{subsubsection.3.1.4.10}\protected@file@percent }
|
||||
\newlabel{class_d_object_a99b8688849e11501033a25f61efb8356}{{3.1.4.10}{9}{\texorpdfstring {unregisterPlugin()}{unregisterPlugin()}}{subsubsection.3.1.4.10}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1.5}Friends And Related Symbol Documentation}{9}{subsection.3.1.5}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.5.1}operator$<$$<$}{9}{subsubsection.3.1.5.1}\protected@file@percent }
|
||||
\newlabel{class_d_object_aa54e75574f0302a2ca7252f9f0f0b3f1}{{3.1.5.1}{9}{\texorpdfstring {operator$<$$<$}{operator<<}}{subsubsection.3.1.5.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject Class Reference}{10}{section.3.2}\protected@file@percent }
|
||||
\newlabel{class_lockable_d_object}{{3.2}{10}{Lockable\+DObject Class Reference}{section.3.2}{}}
|
||||
\newlabel{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}{{3.2}{10}{Public Member Functions}{section*.4}{}}
|
||||
\newlabel{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}{{3.2}{10}{Public Member Functions}{section*.4}{}}
|
||||
\newlabel{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}{{3.2}{10}{Public Member Functions}{section*.4}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2.1}Detailed Description}{10}{subsection.3.2.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2.2}Member Function Documentation}{10}{subsection.3.2.2}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.2.1}get()}{10}{subsubsection.3.2.2.1}\protected@file@percent }
|
||||
\newlabel{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}{{3.2.2.1}{10}{\texorpdfstring {get()}{get()}}{subsubsection.3.2.2.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.3}Metadata Class Reference}{10}{section.3.3}\protected@file@percent }
|
||||
\newlabel{class_metadata}{{3.3}{10}{Metadata Class Reference}{section.3.3}{}}
|
||||
\newlabel{class_metadata_ae849560667461008cb72e83919c20be0}{{3.3}{11}{Public Member Functions}{section*.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.1}Detailed Description}{11}{subsection.3.3.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.2}Constructor \& Destructor Documentation}{11}{subsection.3.3.2}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.2.1}Metadata()}{11}{subsubsection.3.3.2.1}\protected@file@percent }
|
||||
\newlabel{class_metadata_a3d56c8c5adee4b8c7d2089802211522b}{{3.3.2.1}{11}{\texorpdfstring {Metadata()}{Metadata()}}{subsubsection.3.3.2.1}{}}
|
||||
\gdef \LT@ix {\LT@entry
|
||||
{3}{58.31227pt}\LT@entry
|
||||
{3}{322.9112pt}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.3}Member Function Documentation}{12}{subsection.3.3.3}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.1}getByteSize()}{12}{subsubsection.3.3.3.1}\protected@file@percent }
|
||||
\newlabel{class_metadata_ac7980d1efdd6ae434f0115f83d08348e}{{3.3.3.1}{12}{\texorpdfstring {getByteSize()}{getByteSize()}}{subsubsection.3.3.3.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.2}getDataType()}{12}{subsubsection.3.3.3.2}\protected@file@percent }
|
||||
\newlabel{class_metadata_aeed7f22ccc61d9a3d6425441d381dcdc}{{3.3.3.2}{12}{\texorpdfstring {getDataType()}{getDataType()}}{subsubsection.3.3.3.2}{}}
|
||||
\gdef \LT@x {\LT@entry
|
||||
{3}{46.9995pt}\LT@entry
|
||||
{3}{112.13582pt}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.3}getDimensions()}{13}{subsubsection.3.3.3.3}\protected@file@percent }
|
||||
\newlabel{class_metadata_a412c0c0b8754d85f9edbbdcd637f3b20}{{3.3.3.3}{13}{\texorpdfstring {getDimensions()}{getDimensions()}}{subsubsection.3.3.3.3}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.4}isDebugEnabled()}{13}{subsubsection.3.3.3.4}\protected@file@percent }
|
||||
\newlabel{class_metadata_abe52c81e04665628666b4140cd346b69}{{3.3.3.4}{13}{\texorpdfstring {isDebugEnabled()}{isDebugEnabled()}}{subsubsection.3.3.3.4}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.5}setByteSize()}{13}{subsubsection.3.3.3.5}\protected@file@percent }
|
||||
\newlabel{class_metadata_a07035de7b0c780ef340e1a11c60a4d2b}{{3.3.3.5}{13}{\texorpdfstring {setByteSize()}{setByteSize()}}{subsubsection.3.3.3.5}{}}
|
||||
\gdef \LT@xi {\LT@entry
|
||||
{3}{46.9995pt}\LT@entry
|
||||
{3}{112.13582pt}}
|
||||
\gdef \LT@xii {\LT@entry
|
||||
{3}{49.24037pt}\LT@entry
|
||||
{3}{152.4728pt}}
|
||||
\gdef \LT@xiii {\LT@entry
|
||||
{3}{49.24037pt}\LT@entry
|
||||
{3}{152.4728pt}}
|
||||
\gdef \LT@xiv {\LT@entry
|
||||
{3}{55.14427pt}\LT@entry
|
||||
{3}{136.60649pt}}
|
||||
\gdef \LT@xv {\LT@entry
|
||||
{3}{55.14427pt}\LT@entry
|
||||
{3}{136.60649pt}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.6}setDataType()}{14}{subsubsection.3.3.3.6}\protected@file@percent }
|
||||
\newlabel{class_metadata_a88f4f57d443e2b7664e75e57a29dfbf0}{{3.3.3.6}{14}{\texorpdfstring {setDataType()}{setDataType()}}{subsubsection.3.3.3.6}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.7}setDebugEnabled()}{14}{subsubsection.3.3.3.7}\protected@file@percent }
|
||||
\newlabel{class_metadata_a365c4594ad65c3b10b40a1cf4f4aea26}{{3.3.3.7}{14}{\texorpdfstring {setDebugEnabled()}{setDebugEnabled()}}{subsubsection.3.3.3.7}{}}
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.3.8}setDimensions()}{14}{subsubsection.3.3.3.8}\protected@file@percent }
|
||||
\newlabel{class_metadata_af5264d1666839e69c192b565b5cfa606}{{3.3.3.8}{14}{\texorpdfstring {setDimensions()}{setDimensions()}}{subsubsection.3.3.3.8}{}}
|
||||
\gdef \LT@xvi {\LT@entry
|
||||
{3}{58.31227pt}\LT@entry
|
||||
{3}{209.127pt}}
|
||||
\gdef \LT@xvii {\LT@entry
|
||||
{3}{58.31227pt}\LT@entry
|
||||
{3}{209.127pt}}
|
||||
\gdef \LT@xviii {\LT@entry
|
||||
{3}{50.3202pt}\LT@entry
|
||||
{3}{127.7322pt}}
|
||||
\gdef \LT@xix {\LT@entry
|
||||
{3}{50.3202pt}\LT@entry
|
||||
{3}{127.7322pt}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.4}Friends And Related Symbol Documentation}{15}{subsection.3.3.4}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.4.1}operator$<$$<$}{15}{subsubsection.3.3.4.1}\protected@file@percent }
|
||||
\newlabel{class_metadata_a12949a1ea26c4ff1afeb97101c0493c5}{{3.3.4.1}{15}{\texorpdfstring {operator$<$$<$}{operator<<}}{subsubsection.3.3.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {4}File Documentation}{17}{chapter.4}\protected@file@percent }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Debug\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Info.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{17}{section.4.1}\protected@file@percent }
|
||||
\newlabel{_debug_info_8h_source}{{4.1}{17}{Debug\+Info.\+h}{section.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.2}src/dobj/private/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.cpp File Reference}{17}{section.4.2}\protected@file@percent }
|
||||
\newlabel{_d_object_8cpp}{{4.2}{17}{src/dobj/private/\+DObject.cpp File Reference}{section.4.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}Detailed Description}{17}{subsection.4.2.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.3}DObject\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Private.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{17}{section.4.3}\protected@file@percent }
|
||||
\newlabel{_d_object_private_8h_source}{{4.3}{17}{DObject\+Private.\+h}{section.4.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.4}src/dobj/private/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Metadata.cpp File Reference}{17}{section.4.4}\protected@file@percent }
|
||||
\newlabel{_metadata_8cpp}{{4.4}{17}{src/dobj/private/\+Metadata.cpp File Reference}{section.4.4}{}}
|
||||
\gdef \LT@xx {\LT@entry
|
||||
{3}{50.3202pt}\LT@entry
|
||||
{3}{127.7322pt}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.1}Detailed Description}{18}{subsection.4.4.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.2}Function Documentation}{18}{subsection.4.4.2}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.4.2.1}operator$<$$<$()}{18}{subsubsection.4.4.2.1}\protected@file@percent }
|
||||
\newlabel{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}{{4.4.2.1}{18}{\texorpdfstring {operator$<$$<$()}{operator<<()}}{subsubsection.4.4.2.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.5}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.h File Reference}{18}{section.4.5}\protected@file@percent }
|
||||
\newlabel{_d_object_8h}{{4.5}{18}{src/dobj/public/\+DObject.h File Reference}{section.4.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.5.1}Detailed Description}{19}{subsection.4.5.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.6}DObject.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{19}{section.4.6}\protected@file@percent }
|
||||
\newlabel{_d_object_8h_source}{{4.6}{19}{DObject.\+h}{section.4.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.7}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.h File Reference}{20}{section.4.7}\protected@file@percent }
|
||||
\newlabel{_lockable_d_object_8h}{{4.7}{20}{src/dobj/public/\+Lockable\+DObject.h File Reference}{section.4.7}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.7.1}Detailed Description}{20}{subsection.4.7.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.8}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{20}{section.4.8}\protected@file@percent }
|
||||
\newlabel{_lockable_d_object_8h_source}{{4.8}{20}{Lockable\+DObject.\+h}{section.4.8}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.9}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Metadata.h File Reference}{20}{section.4.9}\protected@file@percent }
|
||||
\newlabel{_metadata_8h}{{4.9}{20}{src/dobj/public/\+Metadata.h File Reference}{section.4.9}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.9.1}Detailed Description}{21}{subsection.4.9.1}\protected@file@percent }
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.10}Metadata.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{21}{section.4.10}\protected@file@percent }
|
||||
\newlabel{_metadata_8h_source}{{4.10}{21}{Metadata.\+h}{section.4.10}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{Index}{23}{section*.11}\protected@file@percent }
|
||||
\gdef \@abspage@last{27}
|
||||
67
docs/latex/refman.idx
Normal file
67
docs/latex/refman.idx
Normal file
@@ -0,0 +1,67 @@
|
||||
\indexentry{DObject@{DObject}|hyperpage}{5}
|
||||
\indexentry{DObject@{DObject}!DataType@{DataType}|hyperpage}{6}
|
||||
\indexentry{DataType@{DataType}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!Plugin@{Plugin}|hyperpage}{6}
|
||||
\indexentry{Plugin@{Plugin}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!DObject@{DObject}|hyperpage}{6}
|
||||
\indexentry{DObject@{DObject}!getData@{getData}|hyperpage}{7}
|
||||
\indexentry{getData@{getData}!DObject@{DObject}|hyperpage}{7}
|
||||
\indexentry{DObject@{DObject}!getMetadata@{getMetadata}|hyperpage}{7}
|
||||
\indexentry{getMetadata@{getMetadata}!DObject@{DObject}|hyperpage}{7}
|
||||
\indexentry{DObject@{DObject}!isDebuggingEnabled@{isDebuggingEnabled}|hyperpage}{7}
|
||||
\indexentry{isDebuggingEnabled@{isDebuggingEnabled}!DObject@{DObject}|hyperpage}{7}
|
||||
\indexentry{DObject@{DObject}!registerPlugin@{registerPlugin}|hyperpage}{7}
|
||||
\indexentry{registerPlugin@{registerPlugin}!DObject@{DObject}|hyperpage}{7}
|
||||
\indexentry{DObject@{DObject}!runAllPlugins@{runAllPlugins}|hyperpage}{8}
|
||||
\indexentry{runAllPlugins@{runAllPlugins}!DObject@{DObject}|hyperpage}{8}
|
||||
\indexentry{DObject@{DObject}!runPlugin@{runPlugin}|hyperpage}{8}
|
||||
\indexentry{runPlugin@{runPlugin}!DObject@{DObject}|hyperpage}{8}
|
||||
\indexentry{DObject@{DObject}!setData@{setData}|hyperpage}{8}
|
||||
\indexentry{setData@{setData}!DObject@{DObject}|hyperpage}{8}
|
||||
\indexentry{DObject@{DObject}!setDebugging@{setDebugging}|hyperpage}{8}
|
||||
\indexentry{setDebugging@{setDebugging}!DObject@{DObject}|hyperpage}{8}
|
||||
\indexentry{DObject@{DObject}!setMetadata@{setMetadata}|hyperpage}{9}
|
||||
\indexentry{setMetadata@{setMetadata}!DObject@{DObject}|hyperpage}{9}
|
||||
\indexentry{DObject@{DObject}!unregisterPlugin@{unregisterPlugin}|hyperpage}{9}
|
||||
\indexentry{unregisterPlugin@{unregisterPlugin}!DObject@{DObject}|hyperpage}{9}
|
||||
\indexentry{DObject@{DObject}!operator$<$$<$@{operator$<$$<$}|hyperpage}{9}
|
||||
\indexentry{operator$<$$<$@{operator$<$$<$}!DObject@{DObject}|hyperpage}{9}
|
||||
\indexentry{LockableDObject@{LockableDObject}|hyperpage}{10}
|
||||
\indexentry{LockableDObject@{LockableDObject}!get@{get}|hyperpage}{10}
|
||||
\indexentry{get@{get}!LockableDObject@{LockableDObject}|hyperpage}{10}
|
||||
\indexentry{Metadata@{Metadata}|hyperpage}{10}
|
||||
\indexentry{Metadata@{Metadata}!Metadata@{Metadata}|hyperpage}{11}
|
||||
\indexentry{Metadata@{Metadata}!Metadata@{Metadata}|hyperpage}{11}
|
||||
\indexentry{Metadata@{Metadata}!getByteSize@{getByteSize}|hyperpage}{12}
|
||||
\indexentry{getByteSize@{getByteSize}!Metadata@{Metadata}|hyperpage}{12}
|
||||
\indexentry{Metadata@{Metadata}!getDataType@{getDataType}|hyperpage}{12}
|
||||
\indexentry{getDataType@{getDataType}!Metadata@{Metadata}|hyperpage}{12}
|
||||
\indexentry{Metadata@{Metadata}!getDimensions@{getDimensions}|hyperpage}{12}
|
||||
\indexentry{getDimensions@{getDimensions}!Metadata@{Metadata}|hyperpage}{12}
|
||||
\indexentry{Metadata@{Metadata}!isDebugEnabled@{isDebugEnabled}|hyperpage}{13}
|
||||
\indexentry{isDebugEnabled@{isDebugEnabled}!Metadata@{Metadata}|hyperpage}{13}
|
||||
\indexentry{Metadata@{Metadata}!setByteSize@{setByteSize}|hyperpage}{13}
|
||||
\indexentry{setByteSize@{setByteSize}!Metadata@{Metadata}|hyperpage}{13}
|
||||
\indexentry{Metadata@{Metadata}!setDataType@{setDataType}|hyperpage}{14}
|
||||
\indexentry{setDataType@{setDataType}!Metadata@{Metadata}|hyperpage}{14}
|
||||
\indexentry{Metadata@{Metadata}!setDebugEnabled@{setDebugEnabled}|hyperpage}{14}
|
||||
\indexentry{setDebugEnabled@{setDebugEnabled}!Metadata@{Metadata}|hyperpage}{14}
|
||||
\indexentry{Metadata@{Metadata}!setDimensions@{setDimensions}|hyperpage}{14}
|
||||
\indexentry{setDimensions@{setDimensions}!Metadata@{Metadata}|hyperpage}{14}
|
||||
\indexentry{Metadata@{Metadata}!operator$<$$<$@{operator$<$$<$}|hyperpage}{15}
|
||||
\indexentry{operator$<$$<$@{operator$<$$<$}!Metadata@{Metadata}|hyperpage}{15}
|
||||
\indexentry{src/dobj/private/DebugInfo.h@{src/dobj/private/DebugInfo.h}|hyperpage}{17}
|
||||
\indexentry{src/dobj/private/DObject.cpp@{src/dobj/private/DObject.cpp}|hyperpage}{17}
|
||||
\indexentry{src/dobj/private/DObjectPrivate.h@{src/dobj/private/DObjectPrivate.h}|hyperpage}{17}
|
||||
\indexentry{src/dobj/private/Metadata.cpp@{src/dobj/private/Metadata.cpp}|hyperpage}{17}
|
||||
\indexentry{Metadata.cpp@{Metadata.cpp}!operator$<$$<$@{operator$<$$<$}|hyperpage}{18}
|
||||
\indexentry{operator$<$$<$@{operator$<$$<$}!Metadata.cpp@{Metadata.cpp}|hyperpage}{18}
|
||||
\indexentry{src/dobj/public/DObject.h@{src/dobj/public/DObject.h}|hyperpage}{18}
|
||||
\indexentry{src/dobj/public/DObject.h@{src/dobj/public/DObject.h}|hyperpage}{19}
|
||||
\indexentry{src/dobj/public/LockableDObject.h@{src/dobj/public/LockableDObject.h}|hyperpage}{20}
|
||||
\indexentry{src/dobj/public/LockableDObject.h@{src/dobj/public/LockableDObject.h}|hyperpage}{20}
|
||||
\indexentry{src/dobj/public/Metadata.h@{src/dobj/public/Metadata.h}|hyperpage}{20}
|
||||
\indexentry{src/dobj/public/Metadata.h@{src/dobj/public/Metadata.h}|hyperpage}{21}
|
||||
6
docs/latex/refman.ilg
Normal file
6
docs/latex/refman.ilg
Normal file
@@ -0,0 +1,6 @@
|
||||
This is makeindex, version 2.17 [TeX Live 2023] (kpathsea + Thai support).
|
||||
Scanning input file refman.idx....done (67 entries accepted, 0 rejected).
|
||||
Sorting entries....done (414 comparisons).
|
||||
Generating output file refman.ind....done (114 lines written, 0 warnings).
|
||||
Output written in refman.ind.
|
||||
Transcript written in refman.ilg.
|
||||
114
docs/latex/refman.ind
Normal file
114
docs/latex/refman.ind
Normal file
@@ -0,0 +1,114 @@
|
||||
\begin{theindex}
|
||||
|
||||
\item {DataType}
|
||||
\subitem {DObject}, \hyperpage{6}
|
||||
\item {DObject}, \hyperpage{5}
|
||||
\subitem {DataType}, \hyperpage{6}
|
||||
\subitem {DObject}, \hyperpage{6}
|
||||
\subitem {getData}, \hyperpage{7}
|
||||
\subitem {getMetadata}, \hyperpage{7}
|
||||
\subitem {isDebuggingEnabled}, \hyperpage{7}
|
||||
\subitem {operator$<$$<$}, \hyperpage{9}
|
||||
\subitem {Plugin}, \hyperpage{6}
|
||||
\subitem {registerPlugin}, \hyperpage{7}
|
||||
\subitem {runAllPlugins}, \hyperpage{8}
|
||||
\subitem {runPlugin}, \hyperpage{8}
|
||||
\subitem {setData}, \hyperpage{8}
|
||||
\subitem {setDebugging}, \hyperpage{8}
|
||||
\subitem {setMetadata}, \hyperpage{9}
|
||||
\subitem {unregisterPlugin}, \hyperpage{9}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {get}
|
||||
\subitem {LockableDObject}, \hyperpage{10}
|
||||
\item {getByteSize}
|
||||
\subitem {Metadata}, \hyperpage{12}
|
||||
\item {getData}
|
||||
\subitem {DObject}, \hyperpage{7}
|
||||
\item {getDataType}
|
||||
\subitem {Metadata}, \hyperpage{12}
|
||||
\item {getDimensions}
|
||||
\subitem {Metadata}, \hyperpage{12}
|
||||
\item {getMetadata}
|
||||
\subitem {DObject}, \hyperpage{7}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {isDebugEnabled}
|
||||
\subitem {Metadata}, \hyperpage{13}
|
||||
\item {isDebuggingEnabled}
|
||||
\subitem {DObject}, \hyperpage{7}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {LockableDObject}, \hyperpage{10}
|
||||
\subitem {get}, \hyperpage{10}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {Metadata}, \hyperpage{10}
|
||||
\subitem {getByteSize}, \hyperpage{12}
|
||||
\subitem {getDataType}, \hyperpage{12}
|
||||
\subitem {getDimensions}, \hyperpage{12}
|
||||
\subitem {isDebugEnabled}, \hyperpage{13}
|
||||
\subitem {Metadata}, \hyperpage{11}
|
||||
\subitem {operator$<$$<$}, \hyperpage{15}
|
||||
\subitem {setByteSize}, \hyperpage{13}
|
||||
\subitem {setDataType}, \hyperpage{14}
|
||||
\subitem {setDebugEnabled}, \hyperpage{14}
|
||||
\subitem {setDimensions}, \hyperpage{14}
|
||||
\item {Metadata.cpp}
|
||||
\subitem {operator$<$$<$}, \hyperpage{18}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {operator$<$$<$}
|
||||
\subitem {DObject}, \hyperpage{9}
|
||||
\subitem {Metadata}, \hyperpage{15}
|
||||
\subitem {Metadata.cpp}, \hyperpage{18}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {Plugin}
|
||||
\subitem {DObject}, \hyperpage{6}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {registerPlugin}
|
||||
\subitem {DObject}, \hyperpage{7}
|
||||
\item {runAllPlugins}
|
||||
\subitem {DObject}, \hyperpage{8}
|
||||
\item {runPlugin}
|
||||
\subitem {DObject}, \hyperpage{8}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {setByteSize}
|
||||
\subitem {Metadata}, \hyperpage{13}
|
||||
\item {setData}
|
||||
\subitem {DObject}, \hyperpage{8}
|
||||
\item {setDataType}
|
||||
\subitem {Metadata}, \hyperpage{14}
|
||||
\item {setDebugEnabled}
|
||||
\subitem {Metadata}, \hyperpage{14}
|
||||
\item {setDebugging}
|
||||
\subitem {DObject}, \hyperpage{8}
|
||||
\item {setDimensions}
|
||||
\subitem {Metadata}, \hyperpage{14}
|
||||
\item {setMetadata}
|
||||
\subitem {DObject}, \hyperpage{9}
|
||||
\item {src/dobj/private/DebugInfo.h}, \hyperpage{17}
|
||||
\item {src/dobj/private/DObject.cpp}, \hyperpage{17}
|
||||
\item {src/dobj/private/DObjectPrivate.h}, \hyperpage{17}
|
||||
\item {src/dobj/private/Metadata.cpp}, \hyperpage{17}
|
||||
\item {src/dobj/public/DObject.h}, \hyperpage{18, 19}
|
||||
\item {src/dobj/public/LockableDObject.h}, \hyperpage{20}
|
||||
\item {src/dobj/public/Metadata.h}, \hyperpage{20, 21}
|
||||
|
||||
\indexspace
|
||||
|
||||
\item {unregisterPlugin}
|
||||
\subitem {DObject}, \hyperpage{9}
|
||||
|
||||
\end{theindex}
|
||||
1065
docs/latex/refman.log
Normal file
1065
docs/latex/refman.log
Normal file
File diff suppressed because it is too large
Load Diff
64
docs/latex/refman.out
Normal file
64
docs/latex/refman.out
Normal file
@@ -0,0 +1,64 @@
|
||||
\BOOKMARK [0][-]{chapter.1}{\376\377\0001\000\040\000C\000l\000a\000s\000s\000\040\000I\000n\000d\000e\000x}{}% 1
|
||||
\BOOKMARK [1][-]{section.1.1}{\376\377\0001\000.\0001\000\040\000C\000l\000a\000s\000s\000\040\000L\000i\000s\000t}{chapter.1}% 2
|
||||
\BOOKMARK [0][-]{chapter.2}{\376\377\0002\000\040\000F\000i\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 3
|
||||
\BOOKMARK [1][-]{section.2.1}{\376\377\0002\000.\0001\000\040\000F\000i\000l\000e\000\040\000L\000i\000s\000t}{chapter.2}% 4
|
||||
\BOOKMARK [0][-]{chapter.3}{\376\377\0003\000\040\000C\000l\000a\000s\000s\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 5
|
||||
\BOOKMARK [1][-]{section.3.1}{\376\377\0003\000.\0001\000\040\000D\000O\000b\000j\000e\000c\000t\000\040\000C\000l\000a\000s\000s\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.3}% 6
|
||||
\BOOKMARK [2][-]{subsection.3.1.1}{\376\377\0003\000.\0001\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.3.1}% 7
|
||||
\BOOKMARK [2][-]{subsection.3.1.2}{\376\377\0003\000.\0001\000.\0002\000\040\000M\000e\000m\000b\000e\000r\000\040\000T\000y\000p\000e\000d\000e\000f\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.1}% 8
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.2.1}{\376\377\0003\000.\0001\000.\0002\000.\0001\000\040\000D\000a\000t\000a\000T\000y\000p\000e}{subsection.3.1.2}% 9
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.2.2}{\376\377\0003\000.\0001\000.\0002\000.\0002\000\040\000P\000l\000u\000g\000i\000n}{subsection.3.1.2}% 10
|
||||
\BOOKMARK [2][-]{subsection.3.1.3}{\376\377\0003\000.\0001\000.\0003\000\040\000C\000o\000n\000s\000t\000r\000u\000c\000t\000o\000r\000\040\000\046\000\040\000D\000e\000s\000t\000r\000u\000c\000t\000o\000r\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.1}% 11
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.3.1}{\376\377\0003\000.\0001\000.\0003\000.\0001\000\040\000D\000O\000b\000j\000e\000c\000t\000\050\000\051\000\040\000[\0001\000/\0002\000]}{subsection.3.1.3}% 12
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.3.2}{\376\377\0003\000.\0001\000.\0003\000.\0002\000\040\000D\000O\000b\000j\000e\000c\000t\000\050\000\051\000\040\000[\0002\000/\0002\000]}{subsection.3.1.3}% 13
|
||||
\BOOKMARK [2][-]{subsection.3.1.4}{\376\377\0003\000.\0001\000.\0004\000\040\000M\000e\000m\000b\000e\000r\000\040\000F\000u\000n\000c\000t\000i\000o\000n\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.1}% 14
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.1}{\376\377\0003\000.\0001\000.\0004\000.\0001\000\040\000g\000e\000t\000D\000a\000t\000a\000\050\000\051}{subsection.3.1.4}% 15
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.2}{\376\377\0003\000.\0001\000.\0004\000.\0002\000\040\000g\000e\000t\000M\000e\000t\000a\000d\000a\000t\000a\000\050\000\051}{subsection.3.1.4}% 16
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.3}{\376\377\0003\000.\0001\000.\0004\000.\0003\000\040\000i\000s\000D\000e\000b\000u\000g\000g\000i\000n\000g\000E\000n\000a\000b\000l\000e\000d\000\050\000\051}{subsection.3.1.4}% 17
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.4}{\376\377\0003\000.\0001\000.\0004\000.\0004\000\040\000r\000e\000g\000i\000s\000t\000e\000r\000P\000l\000u\000g\000i\000n\000\050\000\051}{subsection.3.1.4}% 18
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.5}{\376\377\0003\000.\0001\000.\0004\000.\0005\000\040\000r\000u\000n\000A\000l\000l\000P\000l\000u\000g\000i\000n\000s\000\050\000\051}{subsection.3.1.4}% 19
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.6}{\376\377\0003\000.\0001\000.\0004\000.\0006\000\040\000r\000u\000n\000P\000l\000u\000g\000i\000n\000\050\000\051}{subsection.3.1.4}% 20
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.7}{\376\377\0003\000.\0001\000.\0004\000.\0007\000\040\000s\000e\000t\000D\000a\000t\000a\000\050\000\051}{subsection.3.1.4}% 21
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.8}{\376\377\0003\000.\0001\000.\0004\000.\0008\000\040\000s\000e\000t\000D\000e\000b\000u\000g\000g\000i\000n\000g\000\050\000\051}{subsection.3.1.4}% 22
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.9}{\376\377\0003\000.\0001\000.\0004\000.\0009\000\040\000s\000e\000t\000M\000e\000t\000a\000d\000a\000t\000a\000\050\000\051}{subsection.3.1.4}% 23
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.4.10}{\376\377\0003\000.\0001\000.\0004\000.\0001\0000\000\040\000u\000n\000r\000e\000g\000i\000s\000t\000e\000r\000P\000l\000u\000g\000i\000n\000\050\000\051}{subsection.3.1.4}% 24
|
||||
\BOOKMARK [2][-]{subsection.3.1.5}{\376\377\0003\000.\0001\000.\0005\000\040\000F\000r\000i\000e\000n\000d\000s\000\040\000A\000n\000d\000\040\000R\000e\000l\000a\000t\000e\000d\000\040\000S\000y\000m\000b\000o\000l\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.1}% 25
|
||||
\BOOKMARK [3][-]{subsubsection.3.1.5.1}{\376\377\0003\000.\0001\000.\0005\000.\0001\000\040\000o\000p\000e\000r\000a\000t\000o\000r\000<\000<}{subsection.3.1.5}% 26
|
||||
\BOOKMARK [1][-]{section.3.2}{\376\377\0003\000.\0002\000\040\000L\000o\000c\000k\000a\000b\000l\000e\000D\000O\000b\000j\000e\000c\000t\000\040\000C\000l\000a\000s\000s\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.3}% 27
|
||||
\BOOKMARK [2][-]{subsection.3.2.1}{\376\377\0003\000.\0002\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.3.2}% 28
|
||||
\BOOKMARK [2][-]{subsection.3.2.2}{\376\377\0003\000.\0002\000.\0002\000\040\000M\000e\000m\000b\000e\000r\000\040\000F\000u\000n\000c\000t\000i\000o\000n\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.2}% 29
|
||||
\BOOKMARK [3][-]{subsubsection.3.2.2.1}{\376\377\0003\000.\0002\000.\0002\000.\0001\000\040\000g\000e\000t\000\050\000\051}{subsection.3.2.2}% 30
|
||||
\BOOKMARK [1][-]{section.3.3}{\376\377\0003\000.\0003\000\040\000M\000e\000t\000a\000d\000a\000t\000a\000\040\000C\000l\000a\000s\000s\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.3}% 31
|
||||
\BOOKMARK [2][-]{subsection.3.3.1}{\376\377\0003\000.\0003\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.3.3}% 32
|
||||
\BOOKMARK [2][-]{subsection.3.3.2}{\376\377\0003\000.\0003\000.\0002\000\040\000C\000o\000n\000s\000t\000r\000u\000c\000t\000o\000r\000\040\000\046\000\040\000D\000e\000s\000t\000r\000u\000c\000t\000o\000r\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.3}% 33
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.2.1}{\376\377\0003\000.\0003\000.\0002\000.\0001\000\040\000M\000e\000t\000a\000d\000a\000t\000a\000\050\000\051}{subsection.3.3.2}% 34
|
||||
\BOOKMARK [2][-]{subsection.3.3.3}{\376\377\0003\000.\0003\000.\0003\000\040\000M\000e\000m\000b\000e\000r\000\040\000F\000u\000n\000c\000t\000i\000o\000n\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.3}% 35
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.1}{\376\377\0003\000.\0003\000.\0003\000.\0001\000\040\000g\000e\000t\000B\000y\000t\000e\000S\000i\000z\000e\000\050\000\051}{subsection.3.3.3}% 36
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.2}{\376\377\0003\000.\0003\000.\0003\000.\0002\000\040\000g\000e\000t\000D\000a\000t\000a\000T\000y\000p\000e\000\050\000\051}{subsection.3.3.3}% 37
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.3}{\376\377\0003\000.\0003\000.\0003\000.\0003\000\040\000g\000e\000t\000D\000i\000m\000e\000n\000s\000i\000o\000n\000s\000\050\000\051}{subsection.3.3.3}% 38
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.4}{\376\377\0003\000.\0003\000.\0003\000.\0004\000\040\000i\000s\000D\000e\000b\000u\000g\000E\000n\000a\000b\000l\000e\000d\000\050\000\051}{subsection.3.3.3}% 39
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.5}{\376\377\0003\000.\0003\000.\0003\000.\0005\000\040\000s\000e\000t\000B\000y\000t\000e\000S\000i\000z\000e\000\050\000\051}{subsection.3.3.3}% 40
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.6}{\376\377\0003\000.\0003\000.\0003\000.\0006\000\040\000s\000e\000t\000D\000a\000t\000a\000T\000y\000p\000e\000\050\000\051}{subsection.3.3.3}% 41
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.7}{\376\377\0003\000.\0003\000.\0003\000.\0007\000\040\000s\000e\000t\000D\000e\000b\000u\000g\000E\000n\000a\000b\000l\000e\000d\000\050\000\051}{subsection.3.3.3}% 42
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.3.8}{\376\377\0003\000.\0003\000.\0003\000.\0008\000\040\000s\000e\000t\000D\000i\000m\000e\000n\000s\000i\000o\000n\000s\000\050\000\051}{subsection.3.3.3}% 43
|
||||
\BOOKMARK [2][-]{subsection.3.3.4}{\376\377\0003\000.\0003\000.\0004\000\040\000F\000r\000i\000e\000n\000d\000s\000\040\000A\000n\000d\000\040\000R\000e\000l\000a\000t\000e\000d\000\040\000S\000y\000m\000b\000o\000l\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.3.3}% 44
|
||||
\BOOKMARK [3][-]{subsubsection.3.3.4.1}{\376\377\0003\000.\0003\000.\0004\000.\0001\000\040\000o\000p\000e\000r\000a\000t\000o\000r\000<\000<}{subsection.3.3.4}% 45
|
||||
\BOOKMARK [0][-]{chapter.4}{\376\377\0004\000\040\000F\000i\000l\000e\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{}% 46
|
||||
\BOOKMARK [1][-]{section.4.1}{\376\377\0004\000.\0001\000\040\000D\000e\000b\000u\000g\000I\000n\000f\000o\000.\000h}{chapter.4}% 47
|
||||
\BOOKMARK [1][-]{section.4.2}{\376\377\0004\000.\0002\000\040\000s\000r\000c\000/\000d\000o\000b\000j\000/\000p\000r\000i\000v\000a\000t\000e\000/\000D\000O\000b\000j\000e\000c\000t\000.\000c\000p\000p\000\040\000F\000i\000l\000e\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.4}% 48
|
||||
\BOOKMARK [2][-]{subsection.4.2.1}{\376\377\0004\000.\0002\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.4.2}% 49
|
||||
\BOOKMARK [1][-]{section.4.3}{\376\377\0004\000.\0003\000\040\000D\000O\000b\000j\000e\000c\000t\000P\000r\000i\000v\000a\000t\000e\000.\000h}{chapter.4}% 50
|
||||
\BOOKMARK [1][-]{section.4.4}{\376\377\0004\000.\0004\000\040\000s\000r\000c\000/\000d\000o\000b\000j\000/\000p\000r\000i\000v\000a\000t\000e\000/\000M\000e\000t\000a\000d\000a\000t\000a\000.\000c\000p\000p\000\040\000F\000i\000l\000e\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.4}% 51
|
||||
\BOOKMARK [2][-]{subsection.4.4.1}{\376\377\0004\000.\0004\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.4.4}% 52
|
||||
\BOOKMARK [2][-]{subsection.4.4.2}{\376\377\0004\000.\0004\000.\0002\000\040\000F\000u\000n\000c\000t\000i\000o\000n\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000a\000t\000i\000o\000n}{section.4.4}% 53
|
||||
\BOOKMARK [3][-]{subsubsection.4.4.2.1}{\376\377\0004\000.\0004\000.\0002\000.\0001\000\040\000o\000p\000e\000r\000a\000t\000o\000r\000<\000<\000\050\000\051}{subsection.4.4.2}% 54
|
||||
\BOOKMARK [1][-]{section.4.5}{\376\377\0004\000.\0005\000\040\000s\000r\000c\000/\000d\000o\000b\000j\000/\000p\000u\000b\000l\000i\000c\000/\000D\000O\000b\000j\000e\000c\000t\000.\000h\000\040\000F\000i\000l\000e\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.4}% 55
|
||||
\BOOKMARK [2][-]{subsection.4.5.1}{\376\377\0004\000.\0005\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.4.5}% 56
|
||||
\BOOKMARK [1][-]{section.4.6}{\376\377\0004\000.\0006\000\040\000D\000O\000b\000j\000e\000c\000t\000.\000h}{chapter.4}% 57
|
||||
\BOOKMARK [1][-]{section.4.7}{\376\377\0004\000.\0007\000\040\000s\000r\000c\000/\000d\000o\000b\000j\000/\000p\000u\000b\000l\000i\000c\000/\000L\000o\000c\000k\000a\000b\000l\000e\000D\000O\000b\000j\000e\000c\000t\000.\000h\000\040\000F\000i\000l\000e\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.4}% 58
|
||||
\BOOKMARK [2][-]{subsection.4.7.1}{\376\377\0004\000.\0007\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.4.7}% 59
|
||||
\BOOKMARK [1][-]{section.4.8}{\376\377\0004\000.\0008\000\040\000L\000o\000c\000k\000a\000b\000l\000e\000D\000O\000b\000j\000e\000c\000t\000.\000h}{chapter.4}% 60
|
||||
\BOOKMARK [1][-]{section.4.9}{\376\377\0004\000.\0009\000\040\000s\000r\000c\000/\000d\000o\000b\000j\000/\000p\000u\000b\000l\000i\000c\000/\000M\000e\000t\000a\000d\000a\000t\000a\000.\000h\000\040\000F\000i\000l\000e\000\040\000R\000e\000f\000e\000r\000e\000n\000c\000e}{chapter.4}% 61
|
||||
\BOOKMARK [2][-]{subsection.4.9.1}{\376\377\0004\000.\0009\000.\0001\000\040\000D\000e\000t\000a\000i\000l\000e\000d\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{section.4.9}% 62
|
||||
\BOOKMARK [1][-]{section.4.10}{\376\377\0004\000.\0001\0000\000\040\000M\000e\000t\000a\000d\000a\000t\000a\000.\000h}{chapter.4}% 63
|
||||
\BOOKMARK [0][-]{section*.11}{\376\377\000I\000n\000d\000e\000x}{}% 64
|
||||
BIN
docs/latex/refman.pdf
Normal file
BIN
docs/latex/refman.pdf
Normal file
Binary file not shown.
264
docs/latex/refman.tex
Normal file
264
docs/latex/refman.tex
Normal file
@@ -0,0 +1,264 @@
|
||||
% Handle batch mode
|
||||
% to overcome problems with too many open files
|
||||
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
||||
\RequirePackage{iftex}
|
||||
\ifLuaTeX
|
||||
\directlua{pdf.setminorversion(7)}
|
||||
\fi
|
||||
\ifXeTeX
|
||||
\special{pdf:minorversion 7}
|
||||
\fi
|
||||
\ifPDFTeX
|
||||
\pdfminorversion=7
|
||||
\fi
|
||||
% Set document class depending on configuration
|
||||
\documentclass[twoside]{book}
|
||||
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\usepackage{ifthen}
|
||||
\ifx\requestedLaTeXdate\undefined
|
||||
\usepackage{array}
|
||||
\else
|
||||
\usepackage{array}[=2016-10-06]
|
||||
\fi
|
||||
%%
|
||||
% Packages required by doxygen
|
||||
\makeatletter
|
||||
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
|
||||
% suppress package identification of infwarerr as it contains the word "warning"
|
||||
\let\@@protected@wlog\protected@wlog
|
||||
\def\protected@wlog#1{\wlog{package info suppressed}}
|
||||
\RequirePackage{infwarerr}
|
||||
\let\protected@wlog\@@protected@wlog
|
||||
\makeatother
|
||||
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
|
||||
\ifPDFTeX
|
||||
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
|
||||
\fi
|
||||
\usepackage{doxygen}
|
||||
\usepackage{graphicx}
|
||||
\iftutex
|
||||
\usepackage{fontspec}
|
||||
\defaultfontfeatures{Ligatures={TeX}}
|
||||
\usepackage{unicode-math}
|
||||
\else
|
||||
\usepackage[utf8]{inputenc}
|
||||
\fi
|
||||
\usepackage{makeidx}
|
||||
\PassOptionsToPackage{warn}{textcomp}
|
||||
\usepackage{textcomp}
|
||||
\usepackage[nointegrals]{wasysym}
|
||||
\usepackage{ifxetex}
|
||||
% NLS support packages
|
||||
% Define default fonts
|
||||
% Font selection
|
||||
\iftutex
|
||||
\else
|
||||
\usepackage[T1]{fontenc}
|
||||
\fi
|
||||
% set main and monospaced font
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\doxyallsectionsfont{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\renewcommand{\DoxyLabelFont}{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
||||
% Arguments of doxygenemoji:
|
||||
% 1) ':<text>:' form of the emoji, already LaTeX-escaped
|
||||
% 2) file with the name of the emoji without the .png extension
|
||||
% in case image exist use this otherwise use the ':<text>:' form
|
||||
\newcommand{\doxygenemoji}[2]{%
|
||||
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
|
||||
}
|
||||
% Page & text layout
|
||||
\usepackage{geometry}
|
||||
\geometry{%
|
||||
a4paper,%
|
||||
top=2.5cm,%
|
||||
bottom=2.5cm,%
|
||||
left=2.5cm,%
|
||||
right=2.5cm%
|
||||
}
|
||||
\usepackage{changepage}
|
||||
% Allow a bit of overflow to go unnoticed by other means
|
||||
\tolerance=750
|
||||
\hfuzz=15pt
|
||||
\hbadness=750
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\setlength{\parindent}{0cm}
|
||||
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
|
||||
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
|
||||
\doxynormalparskip
|
||||
% Redefine paragraph/subparagraph environments, using sectsty fonts
|
||||
\makeatletter
|
||||
\renewcommand{\paragraph}{%
|
||||
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@parafont%
|
||||
}%
|
||||
}
|
||||
\renewcommand{\subparagraph}{%
|
||||
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@subparafont%
|
||||
}%
|
||||
}
|
||||
\makeatother
|
||||
\makeatletter
|
||||
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
|
||||
\makeatother
|
||||
% Headers & footers
|
||||
\usepackage{fancyhdr}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\fancypagestyle{fancyplain}{
|
||||
\fancyhf{}
|
||||
\fancyhead[LE, RO]{\bfseries\thepage}
|
||||
\fancyhead[LO]{\bfseries\rightmark}
|
||||
\fancyhead[RE]{\bfseries\leftmark}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
}
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\chaptermark}[1]{%
|
||||
\markboth{#1}{}%
|
||||
}
|
||||
\renewcommand{\sectionmark}[1]{%
|
||||
\markright{\thesection\ #1}%
|
||||
}
|
||||
% ToC, LoF, LoT, bibliography, and index
|
||||
% Indices & bibliography
|
||||
\usepackage[numbers]{natbib}
|
||||
\usepackage[titles]{tocloft}
|
||||
\setcounter{tocdepth}{3}
|
||||
\setcounter{secnumdepth}{5}
|
||||
% creating indexes
|
||||
\makeindex
|
||||
\ifPDFTeX
|
||||
\usepackage{newunicodechar}
|
||||
\makeatletter
|
||||
\def\doxynewunicodechar#1#2{%
|
||||
\@tempswafalse
|
||||
\edef\nuc@tempa{\detokenize{#1}}%
|
||||
\if\relax\nuc@tempa\relax
|
||||
\nuc@emptyargerr
|
||||
\else
|
||||
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
|
||||
\nuc@check
|
||||
\if@tempswa
|
||||
\@namedef{u8:\nuc@tempa}{#2}%
|
||||
\fi
|
||||
\fi
|
||||
}
|
||||
\makeatother
|
||||
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
|
||||
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
|
||||
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
|
||||
\fi
|
||||
% Hyperlinks
|
||||
% Hyperlinks (required, but should be loaded last)
|
||||
\ifPDFTeX
|
||||
\usepackage[pdftex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\ifXeTeX
|
||||
\usepackage[xetex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\ifLuaTeX
|
||||
\usepackage[luatex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
||||
\fi
|
||||
\fi
|
||||
\fi
|
||||
\hypersetup{%
|
||||
colorlinks=true,%
|
||||
linkcolor=blue,%
|
||||
citecolor=blue,%
|
||||
unicode,%
|
||||
pdftitle={New 4\+DSSE Code},%
|
||||
pdfsubject={}%
|
||||
}
|
||||
% Custom commands used by the header
|
||||
% Custom commands
|
||||
\newcommand{\clearemptydoublepage}{%
|
||||
\newpage{\pagestyle{empty}\cleardoublepage}%
|
||||
}
|
||||
% caption style definition
|
||||
\usepackage{caption}
|
||||
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
||||
% in page table of contents
|
||||
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
|
||||
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
||||
\etocsetlevel{subsubsubsection}{4}
|
||||
\etocsetlevel{subsubsubsubsection}{5}
|
||||
\etocsetlevel{subsubsubsubsubsection}{6}
|
||||
\etocsetlevel{subsubsubsubsubsubsection}{7}
|
||||
\etocsetlevel{paragraph}{8}
|
||||
\etocsetlevel{subparagraph}{9}
|
||||
% prevent numbers overlap the titles in toc
|
||||
\renewcommand{\numberline}[1]{#1~}
|
||||
% End of preamble, now comes the document contents
|
||||
%===== C O N T E N T S =====
|
||||
\begin{document}
|
||||
\raggedbottom
|
||||
% Titlepage & ToC
|
||||
% To avoid duplicate page anchors due to reuse of same numbers for
|
||||
% the index (be it as roman numbers)
|
||||
\hypersetup{pageanchor=false,
|
||||
bookmarksnumbered=true,
|
||||
pdfencoding=unicode
|
||||
}
|
||||
\pagenumbering{alph}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large New 4\+DSSE Code}\\
|
||||
[1ex]\large 0.\+0.\+1a \\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.13.2}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{arabic}
|
||||
% re-enable anchors again
|
||||
\hypersetup{pageanchor=true}
|
||||
%--- Begin generated contents ---
|
||||
\chapter{Class Index}
|
||||
\input{annotated}
|
||||
\chapter{File Index}
|
||||
\input{files}
|
||||
\chapter{Class Documentation}
|
||||
\input{class_d_object}
|
||||
\input{class_lockable_d_object}
|
||||
\input{class_metadata}
|
||||
\chapter{File Documentation}
|
||||
\input{_debug_info_8h_source}
|
||||
\input{_d_object_8cpp}
|
||||
\input{_d_object_private_8h_source}
|
||||
\input{_metadata_8cpp}
|
||||
\input{_d_object_8h}
|
||||
\input{_d_object_8h_source}
|
||||
\input{_lockable_d_object_8h}
|
||||
\input{_lockable_d_object_8h_source}
|
||||
\input{_metadata_8h}
|
||||
\input{_metadata_8h_source}
|
||||
%--- End generated contents ---
|
||||
% Index
|
||||
\backmatter
|
||||
\newpage
|
||||
\phantomsection
|
||||
\clearemptydoublepage
|
||||
\addcontentsline{toc}{chapter}{\indexname}
|
||||
\printindex
|
||||
% Required for some languages (in combination with latexdocumentpre from the header)
|
||||
\end{document}
|
||||
65
docs/latex/refman.toc
Normal file
65
docs/latex/refman.toc
Normal file
@@ -0,0 +1,65 @@
|
||||
\@ifundefined {etoctocstyle}{\let \etoc@startlocaltoc \@gobble \let \etoc@settocdepth \@gobble \let \etoc@depthtag \@gobble \let \etoc@setlocaltop \@gobble }{}
|
||||
\contentsline {chapter}{\numberline {1}Class Index}{1}{chapter.1}%
|
||||
\contentsline {section}{\numberline {1.1}Class List}{1}{section.1.1}%
|
||||
\contentsline {chapter}{\numberline {2}File Index}{3}{chapter.2}%
|
||||
\contentsline {section}{\numberline {2.1}File List}{3}{section.2.1}%
|
||||
\contentsline {chapter}{\numberline {3}Class Documentation}{5}{chapter.3}%
|
||||
\contentsline {section}{\numberline {3.1}DObject Class Reference}{5}{section.3.1}%
|
||||
\contentsline {subsection}{\numberline {3.1.1}Detailed Description}{6}{subsection.3.1.1}%
|
||||
\contentsline {subsection}{\numberline {3.1.2}Member Typedef Documentation}{6}{subsection.3.1.2}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.2.1}DataType}{6}{subsubsection.3.1.2.1}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.2.2}Plugin}{6}{subsubsection.3.1.2.2}%
|
||||
\contentsline {subsection}{\numberline {3.1.3}Constructor \& Destructor Documentation}{6}{subsection.3.1.3}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.3.1}DObject()\hspace {0.1cm}{\footnotesize \ttfamily [1/2]}}{6}{subsubsection.3.1.3.1}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.3.2}DObject()\hspace {0.1cm}{\footnotesize \ttfamily [2/2]}}{6}{subsubsection.3.1.3.2}%
|
||||
\contentsline {subsection}{\numberline {3.1.4}Member Function Documentation}{7}{subsection.3.1.4}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.1}getData()}{7}{subsubsection.3.1.4.1}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.2}getMetadata()}{7}{subsubsection.3.1.4.2}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.3}isDebuggingEnabled()}{7}{subsubsection.3.1.4.3}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.4}registerPlugin()}{7}{subsubsection.3.1.4.4}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.5}runAllPlugins()}{8}{subsubsection.3.1.4.5}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.6}runPlugin()}{8}{subsubsection.3.1.4.6}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.7}setData()}{8}{subsubsection.3.1.4.7}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.8}setDebugging()}{8}{subsubsection.3.1.4.8}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.9}setMetadata()}{9}{subsubsection.3.1.4.9}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.4.10}unregisterPlugin()}{9}{subsubsection.3.1.4.10}%
|
||||
\contentsline {subsection}{\numberline {3.1.5}Friends And Related Symbol Documentation}{9}{subsection.3.1.5}%
|
||||
\contentsline {subsubsection}{\numberline {3.1.5.1}operator$<$$<$}{9}{subsubsection.3.1.5.1}%
|
||||
\contentsline {section}{\numberline {3.2}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject Class Reference}{10}{section.3.2}%
|
||||
\contentsline {subsection}{\numberline {3.2.1}Detailed Description}{10}{subsection.3.2.1}%
|
||||
\contentsline {subsection}{\numberline {3.2.2}Member Function Documentation}{10}{subsection.3.2.2}%
|
||||
\contentsline {subsubsection}{\numberline {3.2.2.1}get()}{10}{subsubsection.3.2.2.1}%
|
||||
\contentsline {section}{\numberline {3.3}Metadata Class Reference}{10}{section.3.3}%
|
||||
\contentsline {subsection}{\numberline {3.3.1}Detailed Description}{11}{subsection.3.3.1}%
|
||||
\contentsline {subsection}{\numberline {3.3.2}Constructor \& Destructor Documentation}{11}{subsection.3.3.2}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.2.1}Metadata()}{11}{subsubsection.3.3.2.1}%
|
||||
\contentsline {subsection}{\numberline {3.3.3}Member Function Documentation}{12}{subsection.3.3.3}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.1}getByteSize()}{12}{subsubsection.3.3.3.1}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.2}getDataType()}{12}{subsubsection.3.3.3.2}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.3}getDimensions()}{13}{subsubsection.3.3.3.3}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.4}isDebugEnabled()}{13}{subsubsection.3.3.3.4}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.5}setByteSize()}{13}{subsubsection.3.3.3.5}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.6}setDataType()}{14}{subsubsection.3.3.3.6}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.7}setDebugEnabled()}{14}{subsubsection.3.3.3.7}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.3.8}setDimensions()}{14}{subsubsection.3.3.3.8}%
|
||||
\contentsline {subsection}{\numberline {3.3.4}Friends And Related Symbol Documentation}{15}{subsection.3.3.4}%
|
||||
\contentsline {subsubsection}{\numberline {3.3.4.1}operator$<$$<$}{15}{subsubsection.3.3.4.1}%
|
||||
\contentsline {chapter}{\numberline {4}File Documentation}{17}{chapter.4}%
|
||||
\contentsline {section}{\numberline {4.1}Debug\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Info.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{17}{section.4.1}%
|
||||
\contentsline {section}{\numberline {4.2}src/dobj/private/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.cpp File Reference}{17}{section.4.2}%
|
||||
\contentsline {subsection}{\numberline {4.2.1}Detailed Description}{17}{subsection.4.2.1}%
|
||||
\contentsline {section}{\numberline {4.3}DObject\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Private.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{17}{section.4.3}%
|
||||
\contentsline {section}{\numberline {4.4}src/dobj/private/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Metadata.cpp File Reference}{17}{section.4.4}%
|
||||
\contentsline {subsection}{\numberline {4.4.1}Detailed Description}{18}{subsection.4.4.1}%
|
||||
\contentsline {subsection}{\numberline {4.4.2}Function Documentation}{18}{subsection.4.4.2}%
|
||||
\contentsline {subsubsection}{\numberline {4.4.2.1}operator$<$$<$()}{18}{subsubsection.4.4.2.1}%
|
||||
\contentsline {section}{\numberline {4.5}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.h File Reference}{18}{section.4.5}%
|
||||
\contentsline {subsection}{\numberline {4.5.1}Detailed Description}{19}{subsection.4.5.1}%
|
||||
\contentsline {section}{\numberline {4.6}DObject.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{19}{section.4.6}%
|
||||
\contentsline {section}{\numberline {4.7}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.h File Reference}{20}{section.4.7}%
|
||||
\contentsline {subsection}{\numberline {4.7.1}Detailed Description}{20}{subsection.4.7.1}%
|
||||
\contentsline {section}{\numberline {4.8}Lockable\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}DObject.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{20}{section.4.8}%
|
||||
\contentsline {section}{\numberline {4.9}src/dobj/public/\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}Metadata.h File Reference}{20}{section.4.9}%
|
||||
\contentsline {subsection}{\numberline {4.9.1}Detailed Description}{21}{subsection.4.9.1}%
|
||||
\contentsline {section}{\numberline {4.10}Metadata.\discretionary {\mbox {\scriptsize $\hookleftarrow $}}{}{}h}{21}{section.4.10}%
|
||||
\contentsline {chapter}{Index}{23}{section*.11}%
|
||||
2557
docs/latex/tabu_doxygen.sty
Normal file
2557
docs/latex/tabu_doxygen.sty
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user