379 lines
27 KiB
TeX
379 lines
27 KiB
TeX
\hypertarget{classeo_value_param}{}\doxysection{eo\+Value\+Param$<$ Value\+Type $>$ Class Template Reference}
|
|
\label{classeo_value_param}\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
|
|
|
|
{\ttfamily \#include $<$eo\+Param.\+h$>$}
|
|
|
|
|
|
|
|
Inheritance diagram for eo\+Value\+Param$<$ Value\+Type $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=348pt]{classeo_value_param__inherit__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
Collaboration diagram for eo\+Value\+Param$<$ Value\+Type $>$\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=238pt]{classeo_value_param__coll__graph}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}{eo\+Value\+Param}} (void)
|
|
\item
|
|
\mbox{\hyperlink{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}{eo\+Value\+Param}} (Value\+Type \+\_\+default\+Value, std\+::string \+\_\+long\+Name, std\+::string \+\_\+description=\char`\"{}No \mbox{\hyperlink{classeo_param_abe1e3e50080a2be2365596ed68d16979}{description}}\char`\"{}, char \+\_\+short\+Hand=0, bool \+\_\+required=false)
|
|
\item
|
|
Value\+Type \& \mbox{\hyperlink{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}{value}} ()
|
|
\item
|
|
const Value\+Type \& \mbox{\hyperlink{classeo_value_param_a844c26d8634d9bf675acace7f80af475}{value}} () const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}{value}} (Value\+Type val)
|
|
\item
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}{get\+Value}} (void) const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Set the value according to the speciied string. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}{eo\+Value\+Param}} (void)
|
|
\item
|
|
\mbox{\hyperlink{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}{eo\+Value\+Param}} (Value\+Type \+\_\+default\+Value, std\+::string \+\_\+long\+Name, std\+::string \+\_\+description=\char`\"{}No \mbox{\hyperlink{classeo_param_abe1e3e50080a2be2365596ed68d16979}{description}}\char`\"{}, char \+\_\+short\+Hand=0, bool \+\_\+required=false)
|
|
\item
|
|
Value\+Type \& \mbox{\hyperlink{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}{value}} ()
|
|
\item
|
|
const Value\+Type \& \mbox{\hyperlink{classeo_value_param_a844c26d8634d9bf675acace7f80af475}{value}} () const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}{value}} (Value\+Type val)
|
|
\item
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}{get\+Value}} (void) const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Set the value according to the speciied string. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classeo_value_param_a010f5eb36f3db7fb002ee7c0aa750da5}{set\+Precision}} (unsigned \+\_\+num\+Of\+Digits)
|
|
\item
|
|
\mbox{\Hypertarget{classeo_value_param_a61623400a0a02888584e9a6d500511b3}\label{classeo_value_param_a61623400a0a02888584e9a6d500511b3}}
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a61623400a0a02888584e9a6d500511b3}{get\+Value}} (void) const
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a std\+::vector of doubles, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}\label{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}}
|
|
void \mbox{\hyperlink{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a std\+::vector of doubles, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}\label{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}}
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}{get\+Value}} (void) const
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a eo\+Minimizing\+Fitness, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}\label{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}}
|
|
void \mbox{\hyperlink{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a eo\+Minimizing\+Fitness, not a T. \end{DoxyCompactList}\item
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}{get\+Value}} (void) const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_a10d23e671927d761ffd258c65338adec}{set\+Value}} (const std\+::string \&)
|
|
\item
|
|
\mbox{\Hypertarget{classeo_value_param_a61623400a0a02888584e9a6d500511b3}\label{classeo_value_param_a61623400a0a02888584e9a6d500511b3}}
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a61623400a0a02888584e9a6d500511b3}{get\+Value}} (void) const
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a std\+::vector of doubles, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}\label{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}}
|
|
void \mbox{\hyperlink{classeo_value_param_a77508eabc34cfd9bb13d61b4e74a6768}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a std\+::vector of doubles, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}\label{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}}
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a70db4c61d85d6cd899f6b91a600bb6dc}{get\+Value}} (void) const
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a eo\+Minimizing\+Fitness, not a T. \end{DoxyCompactList}\item
|
|
\mbox{\Hypertarget{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}\label{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}}
|
|
void \mbox{\hyperlink{classeo_value_param_add1e559669f94542f7c83e0767b6b0eb}{set\+Value}} (const std\+::string \&\+\_\+value)
|
|
\begin{DoxyCompactList}\small\item\em Because M\+S\+VC does not support partial specialization, the std\+::vector is a eo\+Minimizing\+Fitness, not a T. \end{DoxyCompactList}\item
|
|
std\+::string \mbox{\hyperlink{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}{get\+Value}} (void) const
|
|
\item
|
|
void \mbox{\hyperlink{classeo_value_param_a10d23e671927d761ffd258c65338adec}{set\+Value}} (const std\+::string \&)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_value_param_ae212bce69b9b1843dd6bd917ac7ce09b}\label{classeo_value_param_ae212bce69b9b1843dd6bd917ac7ce09b}}
|
|
Value\+Type {\bfseries rep\+Value}
|
|
\item
|
|
\mbox{\Hypertarget{classeo_value_param_acc753e50f1b3c3e0c1dfa038a49bc97f}\label{classeo_value_param_acc753e50f1b3c3e0c1dfa038a49bc97f}}
|
|
unsigned \mbox{\hyperlink{classeo_value_param_acc753e50f1b3c3e0c1dfa038a49bc97f}{num\+Of\+Digits}}
|
|
\begin{DoxyCompactList}\small\item\em precision of the output \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\subsubsection*{template$<$class Value\+Type$>$\newline
|
|
class eo\+Value\+Param$<$ Value\+Type $>$}
|
|
|
|
eo\+Value\+Param$<$\+Value\+Type$>$\+: templatized derivation of \mbox{\hyperlink{classeo_param}{eo\+Param}}. Can be used to contain any scalar value type. It makes use of std\+::strstream to get and set values.
|
|
|
|
\begin{DoxyRefDesc}{Todo}
|
|
\item[\mbox{\hyperlink{todo__todo000015}{Todo}}]This should be changed to std\+::stringstream when that class is available in g++.\end{DoxyRefDesc}
|
|
|
|
|
|
Note also that there is a template specialization for std\+::pair$<$double, double$>$ and for std\+::vector$<$double$>$. These stream their contents delimited with whitespace.
|
|
|
|
eo\+Value\+Param$<$\+Value\+Type$>$\+: templatized derivation of \mbox{\hyperlink{classeo_param}{eo\+Param}}. Can be used to contain any scalar value type. It makes use of std\+::strstream to get and set values.
|
|
|
|
\begin{DoxyRefDesc}{Todo}
|
|
\item[\mbox{\hyperlink{todo__todo000037}{Todo}}]This should be changed to std\+::stringstream when that class is available in g++.\end{DoxyRefDesc}
|
|
|
|
|
|
Note also that there is a template specialization for std\+::pair$<$double, double$>$ and for std\+::vector$<$double$>$. These stream their contents delimited with whitespace.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}\label{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!eoValueParam@{eoValueParam}}
|
|
\index{eoValueParam@{eoValueParam}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoValueParam()}{eoValueParam()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}} (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Construct a Param. \mbox{\Hypertarget{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}\label{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!eoValueParam@{eoValueParam}}
|
|
\index{eoValueParam@{eoValueParam}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoValueParam()}{eoValueParam()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}} (\begin{DoxyParamCaption}\item[{Value\+Type}]{\+\_\+default\+Value, }\item[{std\+::string}]{\+\_\+long\+Name, }\item[{std\+::string}]{\+\_\+description = {\ttfamily \char`\"{}No~\mbox{\hyperlink{classeo_param_abe1e3e50080a2be2365596ed68d16979}{description}}\char`\"{}}, }\item[{char}]{\+\_\+short\+Hand = {\ttfamily 0}, }\item[{bool}]{\+\_\+required = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Construct a Param.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+default\+Value} & The default value \\
|
|
\hline
|
|
{\em \+\_\+long\+Name} & Long name of the argument \\
|
|
\hline
|
|
{\em \+\_\+description} & Description of the parameter. What is useful for. \\
|
|
\hline
|
|
{\em \+\_\+short\+Hand} & Short name of the argument (Optional) \\
|
|
\hline
|
|
{\em \+\_\+required} & If it is a necessary parameter or not \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}\label{classeo_value_param_ac7a185901661b28575660fd6ed3f5291}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!eoValueParam@{eoValueParam}}
|
|
\index{eoValueParam@{eoValueParam}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoValueParam()}{eoValueParam()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}} (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Construct a Param. \mbox{\Hypertarget{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}\label{classeo_value_param_a8584fe7800ca2a6d8a1bcf80c050ebae}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!eoValueParam@{eoValueParam}}
|
|
\index{eoValueParam@{eoValueParam}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{eoValueParam()}{eoValueParam()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::\mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}} (\begin{DoxyParamCaption}\item[{Value\+Type}]{\+\_\+default\+Value, }\item[{std\+::string}]{\+\_\+long\+Name, }\item[{std\+::string}]{\+\_\+description = {\ttfamily \char`\"{}No~\mbox{\hyperlink{classeo_param_abe1e3e50080a2be2365596ed68d16979}{description}}\char`\"{}}, }\item[{char}]{\+\_\+short\+Hand = {\ttfamily 0}, }\item[{bool}]{\+\_\+required = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Construct a Param.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+default\+Value} & The default value \\
|
|
\hline
|
|
{\em \+\_\+long\+Name} & Long name of the argument \\
|
|
\hline
|
|
{\em \+\_\+description} & Description of the parameter. What is useful for. \\
|
|
\hline
|
|
{\em \+\_\+short\+Hand} & Short name of the argument (Optional) \\
|
|
\hline
|
|
{\em \+\_\+required} & If it is a necessary parameter or not \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}\label{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!getValue@{getValue}}
|
|
\index{getValue@{getValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getValue()}{getValue()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
std\+::string \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::get\+Value (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Get the string representation of the value
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a8d5633da64b019d6737c09d17f2ee5e5}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}\label{classeo_value_param_a2eaebe8ad35c0297283d3874522b9672}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!getValue@{getValue}}
|
|
\index{getValue@{getValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getValue()}{getValue()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
std\+::string \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::get\+Value (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Get the string representation of the value
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a8d5633da64b019d6737c09d17f2ee5e5}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}\label{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!getValue@{getValue}}
|
|
\index{getValue@{getValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getValue()}{getValue()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
|
|
{\footnotesize\ttfamily std\+::string \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ std\+::vector$<$ void $\ast$ $>$ $>$\+::get\+Value (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Pure virtual function to get the value out.
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a8d5633da64b019d6737c09d17f2ee5e5}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}\label{classeo_value_param_a1de0a36465f32e96ab16d5b74e282f03}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!getValue@{getValue}}
|
|
\index{getValue@{getValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{getValue()}{getValue()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
|
|
{\footnotesize\ttfamily std\+::string \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ std\+::vector$<$ void $\ast$ $>$ $>$\+::get\+Value (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Pure virtual function to get the value out.
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a8d5633da64b019d6737c09d17f2ee5e5}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a010f5eb36f3db7fb002ee7c0aa750da5}\label{classeo_value_param_a010f5eb36f3db7fb002ee7c0aa750da5}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!setPrecision@{setPrecision}}
|
|
\index{setPrecision@{setPrecision}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setPrecision()}{setPrecision()}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::set\+Precision (\begin{DoxyParamCaption}\item[{unsigned}]{\+\_\+num\+Of\+Digits }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
set the precision of the output
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+num\+Of\+Digits} & the precision of the output \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{classeo_value_param_a10d23e671927d761ffd258c65338adec}\label{classeo_value_param_a10d23e671927d761ffd258c65338adec}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!setValue@{setValue}}
|
|
\index{setValue@{setValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setValue()}{setValue()}\hspace{0.1cm}{\footnotesize\ttfamily [1/4]}}
|
|
{\footnotesize\ttfamily void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ std\+::vector$<$ void $\ast$ $>$ $>$\+::set\+Value (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{\+\_\+value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Pure virtual function to set the value
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a4d5bc11871c72d1d48f80e3330d5b2db}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a10d23e671927d761ffd258c65338adec}\label{classeo_value_param_a10d23e671927d761ffd258c65338adec}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!setValue@{setValue}}
|
|
\index{setValue@{setValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setValue()}{setValue()}\hspace{0.1cm}{\footnotesize\ttfamily [2/4]}}
|
|
{\footnotesize\ttfamily void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ std\+::vector$<$ void $\ast$ $>$ $>$\+::set\+Value (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{\+\_\+value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
Pure virtual function to set the value
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a4d5bc11871c72d1d48f80e3330d5b2db}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}\label{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!setValue@{setValue}}
|
|
\index{setValue@{setValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setValue()}{setValue()}\hspace{0.1cm}{\footnotesize\ttfamily [3/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::set\+Value (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{\+\_\+value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Set the value according to the speciied string.
|
|
|
|
For scalar types the textual represenation is typically quite straigtforward.
|
|
|
|
For vector$<$double$>$ we expect a list of numbers, where the first is an unsigned integer taken as the length ot the vector and then successively the vector elements. Vector elements can be separated by \textquotesingle{},\textquotesingle{}, \textquotesingle{};\textquotesingle{}, or \textquotesingle{} \textquotesingle{}. Note, however, that \mbox{\hyperlink{classeo_parser}{eo\+Parser}} does not deal correctly with parameter values contianing spaces (\textquotesingle{} \textquotesingle{}).
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+value} & Textual representation of the new value \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a4d5bc11871c72d1d48f80e3330d5b2db}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}\label{classeo_value_param_a1c9646b54a6a798055fb13d7fa0ec3bf}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!setValue@{setValue}}
|
|
\index{setValue@{setValue}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{setValue()}{setValue()}\hspace{0.1cm}{\footnotesize\ttfamily [4/4]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::set\+Value (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{\+\_\+value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Set the value according to the speciied string.
|
|
|
|
For scalar types the textual represenation is typically quite straigtforward.
|
|
|
|
For vector$<$double$>$ we expect a list of numbers, where the first is an unsigned integer taken as the length ot the vector and then successively the vector elements. Vector elements can be separated by \textquotesingle{},\textquotesingle{}, \textquotesingle{};\textquotesingle{}, or \textquotesingle{} \textquotesingle{}. Note, however, that \mbox{\hyperlink{classeo_parser}{eo\+Parser}} does not deal correctly with parameter values contianing spaces (\textquotesingle{} \textquotesingle{}).
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em \+\_\+value} & Textual representation of the new value \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
Implements \mbox{\hyperlink{classeo_param_a4d5bc11871c72d1d48f80e3330d5b2db}{eo\+Param}}.
|
|
|
|
\mbox{\Hypertarget{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}\label{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [1/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
Value\+Type\& \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Get a reference on the parameter value
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
parameter value
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}\label{classeo_value_param_ad0e91aa4f66711e52fca9be470ce21b7}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [2/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
Value\+Type\& \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Get a reference on the parameter value
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
parameter value
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classeo_value_param_a844c26d8634d9bf675acace7f80af475}\label{classeo_value_param_a844c26d8634d9bf675acace7f80af475}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [3/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
const Value\+Type\& \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Get a const reference on the parameter value
|
|
|
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
parameter value
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classeo_value_param_a844c26d8634d9bf675acace7f80af475}\label{classeo_value_param_a844c26d8634d9bf675acace7f80af475}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [4/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
const Value\+Type\& \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Get a const reference on the parameter value
|
|
|
|
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
parameter value
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}\label{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [5/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}\item[{Value\+Type}]{val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Change the parameter value \mbox{\Hypertarget{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}\label{classeo_value_param_abd11a7aa7409ac69bf927e7f4edcf545}}
|
|
\index{eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}!value@{value}}
|
|
\index{value@{value}!eoValueParam$<$ ValueType $>$@{eoValueParam$<$ ValueType $>$}}
|
|
\doxysubsubsection{\texorpdfstring{value()}{value()}\hspace{0.1cm}{\footnotesize\ttfamily [6/6]}}
|
|
{\footnotesize\ttfamily template$<$class Value\+Type $>$ \\
|
|
void \mbox{\hyperlink{classeo_value_param}{eo\+Value\+Param}}$<$ Value\+Type $>$\+::value (\begin{DoxyParamCaption}\item[{Value\+Type}]{val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
Change the parameter value
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
deprecated/eo/src/utils/eo\+Param.\+h\end{DoxyCompactItemize}
|