mirror of
https://github.com/anklimov/lighthub
synced 2025-12-06 11:49:51 +03:00
175 lines
8.8 KiB
TeX
175 lines
8.8 KiB
TeX
\hypertarget{classout__pid}{}\doxysection{out\+\_\+pid Class Reference}
|
|
\label{classout__pid}\index{out\_pid@{out\_pid}}
|
|
|
|
|
|
{\ttfamily \#include $<$out\+\_\+pid.\+h$>$}
|
|
|
|
Inheritance diagram for out\+\_\+pid\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=3.000000cm]{classout__pid}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classout__pid_a630e472948038069ab589d6184b92f4d}{out\+\_\+pid}} (\mbox{\hyperlink{class_item}{Item}} $\ast$\+\_\+item)
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_af67c5acd4858a8b694b5083f5c5f97cb}{Setup}} () override
|
|
\begin{DoxyCompactList}\small\item\em Remove?? Now get\+Chan\+Type used instead. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{classout__pid_ac0767dd86a8ab278a410a9241f79d917}{Poll}} (short cause) override
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_a580d905413d92f34ff5248cb0c1854a0}{Stop}} () override
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_aae4f4f1dde85b72a187a29bb25b95f32}{Status}} () override
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_aca01ec18698d8406bbe6964322f8ba2d}{is\+Active}} () override
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_abbc665d20d2adf34bece05b8761aca31}{get\+Chan\+Type}} () override
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_a6555b3173f184d3768e34339d59daa87}{get\+Default\+Storage\+Type}} ()
|
|
\item
|
|
int \mbox{\hyperlink{classout__pid_a9347f14882001bff3d73ca52c1adc700}{Ctrl}} (\mbox{\hyperlink{classitem_cmd}{item\+Cmd}} cmd, char $\ast$sub\+Item=N\+U\+LL, bool to\+Execute=true) override
|
|
\begin{DoxyCompactList}\small\item\em Control unified P\+ID controller item ~\newline
|
|
\end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classout__pid_a1f71e2899811ce2b6ab479fd5950ae2f}{alarm}} (bool)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
bool \mbox{\hyperlink{classout__pid_a2a5740074f5380b9a6122d65eca02f3e}{get\+Config}} ()
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsection*{Protected Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classpid_persistent}{pid\+Persistent}} $\ast$ \mbox{\hyperlink{classout__pid_a4a0ac1daa45fc724f1008d0c35530307}{store}}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{classout__pid_a630e472948038069ab589d6184b92f4d}\label{classout__pid_a630e472948038069ab589d6184b92f4d}}
|
|
\index{out\_pid@{out\_pid}!out\_pid@{out\_pid}}
|
|
\index{out\_pid@{out\_pid}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{out\_pid()}{out\_pid()}}
|
|
{\footnotesize\ttfamily out\+\_\+pid\+::out\+\_\+pid (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_item}{Item}} $\ast$}]{\+\_\+item }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{classout__pid_a1f71e2899811ce2b6ab479fd5950ae2f}\label{classout__pid_a1f71e2899811ce2b6ab479fd5950ae2f}}
|
|
\index{out\_pid@{out\_pid}!alarm@{alarm}}
|
|
\index{alarm@{alarm}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{alarm()}{alarm()}}
|
|
{\footnotesize\ttfamily void out\+\_\+pid\+::alarm (\begin{DoxyParamCaption}\item[{bool}]{state }\end{DoxyParamCaption})}
|
|
|
|
\mbox{\Hypertarget{classout__pid_a9347f14882001bff3d73ca52c1adc700}\label{classout__pid_a9347f14882001bff3d73ca52c1adc700}}
|
|
\index{out\_pid@{out\_pid}!Ctrl@{Ctrl}}
|
|
\index{Ctrl@{Ctrl}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{Ctrl()}{Ctrl()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::\+Ctrl (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classitem_cmd}{item\+Cmd}}}]{cmd, }\item[{char $\ast$}]{sub\+Item = {\ttfamily NULL}, }\item[{bool}]{to\+Execute = {\ttfamily true} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Control unified P\+ID controller item ~\newline
|
|
|
|
|
|
|
|
|
|
Implements \mbox{\hyperlink{classabstract_out_aacaa5ef80fdc683ef96a4dc80d24692a}{abstract\+Out}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_abbc665d20d2adf34bece05b8761aca31}\label{classout__pid_abbc665d20d2adf34bece05b8761aca31}}
|
|
\index{out\_pid@{out\_pid}!getChanType@{getChanType}}
|
|
\index{getChanType@{getChanType}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{getChanType()}{getChanType()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::get\+Chan\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_out_a3f7033b9cda791ad810c4837ed5909f2}{abstract\+Out}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_a2a5740074f5380b9a6122d65eca02f3e}\label{classout__pid_a2a5740074f5380b9a6122d65eca02f3e}}
|
|
\index{out\_pid@{out\_pid}!getConfig@{getConfig}}
|
|
\index{getConfig@{getConfig}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{getConfig()}{getConfig()}}
|
|
{\footnotesize\ttfamily bool out\+\_\+pid\+::get\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
\mbox{\Hypertarget{classout__pid_a6555b3173f184d3768e34339d59daa87}\label{classout__pid_a6555b3173f184d3768e34339d59daa87}}
|
|
\index{out\_pid@{out\_pid}!getDefaultStorageType@{getDefaultStorageType}}
|
|
\index{getDefaultStorageType@{getDefaultStorageType}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{getDefaultStorageType()}{getDefaultStorageType()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::get\+Default\+Storage\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_out_a786157307bd9438b8fbff24421b95330}{abstract\+Out}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_aca01ec18698d8406bbe6964322f8ba2d}\label{classout__pid_aca01ec18698d8406bbe6964322f8ba2d}}
|
|
\index{out\_pid@{out\_pid}!isActive@{isActive}}
|
|
\index{isActive@{isActive}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{isActive()}{isActive()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::is\+Active (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_out_af4d536357ee52043a4d338ce2106350e}{abstract\+Out}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_ac0767dd86a8ab278a410a9241f79d917}\label{classout__pid_ac0767dd86a8ab278a410a9241f79d917}}
|
|
\index{out\_pid@{out\_pid}!Poll@{Poll}}
|
|
\index{Poll@{Poll}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{Poll()}{Poll()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::\+Poll (\begin{DoxyParamCaption}\item[{short}]{cause }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Implements \mbox{\hyperlink{classabstract_ch_a044156a4dc4ca38d3e731b7df23d058a}{abstract\+Ch}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_af67c5acd4858a8b694b5083f5c5f97cb}\label{classout__pid_af67c5acd4858a8b694b5083f5c5f97cb}}
|
|
\index{out\_pid@{out\_pid}!Setup@{Setup}}
|
|
\index{Setup@{Setup}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{Setup()}{Setup()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::\+Setup (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Remove?? Now get\+Chan\+Type used instead.
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_out_ad84ffc96dafea9cbe5c91f35c90ffe3b}{abstract\+Out}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_aae4f4f1dde85b72a187a29bb25b95f32}\label{classout__pid_aae4f4f1dde85b72a187a29bb25b95f32}}
|
|
\index{out\_pid@{out\_pid}!Status@{Status}}
|
|
\index{Status@{Status}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{Status()}{Status()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::\+Status (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_ch_aefb8821172a2e66f49ea0da9b7c205a5}{abstract\+Ch}}.
|
|
|
|
\mbox{\Hypertarget{classout__pid_a580d905413d92f34ff5248cb0c1854a0}\label{classout__pid_a580d905413d92f34ff5248cb0c1854a0}}
|
|
\index{out\_pid@{out\_pid}!Stop@{Stop}}
|
|
\index{Stop@{Stop}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{Stop()}{Stop()}}
|
|
{\footnotesize\ttfamily int out\+\_\+pid\+::\+Stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}
|
|
|
|
|
|
|
|
Reimplemented from \mbox{\hyperlink{classabstract_ch_afb7b6f4586412a13f8f6ac08061e5ae0}{abstract\+Ch}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\mbox{\Hypertarget{classout__pid_a4a0ac1daa45fc724f1008d0c35530307}\label{classout__pid_a4a0ac1daa45fc724f1008d0c35530307}}
|
|
\index{out\_pid@{out\_pid}!store@{store}}
|
|
\index{store@{store}!out\_pid@{out\_pid}}
|
|
\doxysubsubsection{\texorpdfstring{store}{store}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{classpid_persistent}{pid\+Persistent}}$\ast$ out\+\_\+pid\+::store\hspace{0.3cm}{\ttfamily [protected]}}
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
modules/\mbox{\hyperlink{out__pid_8h}{out\+\_\+pid.\+h}}\item
|
|
modules/\mbox{\hyperlink{out__pid_8cpp}{out\+\_\+pid.\+cpp}}\end{DoxyCompactItemize}
|