\hypertarget{group__group1}{
\section{Scol functions definition}
\label{group__group1}\index{Scol functions definition@{Scol functions definition}}
}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef int \hyperlink{group__group1_ga85711c057e7ad8f65fd0190fc0639f87}{BlocObj}
\begin{DoxyCompactList}\small\item\em Scol \hyperlink{class_bloc}{Bloc} Object It allows simple operations like getting and setting its attributes. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
int \hyperlink{group__group1_gae801504f1f746026f0386ae5705e9008}{\_\-GETblocValue} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-GETblocValue : Get the value of the \hyperlink{class_bloc}{Bloc} object \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_ga72cef6cbca74b4ce6715a387f811e834}{\_\-SETblocValue} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-SETblocValue : Set the value of the bloc \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_ga1eed6bf98129fdd265b5f07ab4743e2a}{\_\-GETblocName} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-GETblocName : Get the name of the bloc \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_gacae00870405f8f406fab2ea9c115c142}{\_\-SETblocName} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-SETblocName : Set the name of the bloc \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_gafe341a6e862309b65cad704011d2824e}{\_\-CRbloc} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-CRbloc : Open, initialize \hyperlink{class_bloc}{Bloc} object \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_gaaad556e6b2a980ee77045edc80b99ee8}{\_\-DSbloc} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-DSbloc : Destroy bloc object \item\end{DoxyCompactList}\item 
int \hyperlink{group__group1_ga00f6dd2878cb03643e937c6eb91bda17}{\_\-CBblocChangeValue} (mmachine m)
\begin{DoxyCompactList}\small\item\em \_\-CBblocChangeValue : This function sets the callback to be executed when \hyperlink{class_bloc}{Bloc} value change event happens \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
User Scol functions definition 

\subsection{Typedef Documentation}
\hypertarget{group__group1_ga85711c057e7ad8f65fd0190fc0639f87}{
\index{group1@{group1}!BlocObj@{BlocObj}}
\index{BlocObj@{BlocObj}!group1@{group1}}
\subsubsection[{BlocObj}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf BlocObj}}}
\label{group__group1_ga85711c057e7ad8f65fd0190fc0639f87}


Scol \hyperlink{class_bloc}{Bloc} Object It allows simple operations like getting and setting its attributes. 

BlocObj is set here as a type (an int) for doxygen documentation 

Definition at line 65 of file template.cpp.



\subsection{Function Documentation}
\hypertarget{group__group1_ga00f6dd2878cb03643e937c6eb91bda17}{
\index{group1@{group1}!\_\-CBblocChangeValue@{\_\-CBblocChangeValue}}
\index{\_\-CBblocChangeValue@{\_\-CBblocChangeValue}!group1@{group1}}
\subsubsection[{\_\-CBblocChangeValue}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-CBblocChangeValue (mmachine {\em m})}}
\label{group__group1_ga00f6dd2878cb03643e937c6eb91bda17}


\_\-CBblocChangeValue : This function sets the callback to be executed when \hyperlink{class_bloc}{Bloc} value change event happens 

{\bfseries Prototype:} fun \mbox{[}BlocObj fun \mbox{[}ObjBloc u0 I S\mbox{]} u1 u0\mbox{]} BlocObj


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: \hyperlink{class_bloc}{Bloc} Object whose value has changed \item[{\em fun}]\mbox{[}ObjBloc u0 I S\mbox{]} u1 : The callback to call when the event occurs.
\begin{DoxyItemize}
\item I : int value of the object
\item S : name value of the object 
\end{DoxyItemize}\item[{\em u0}]: User parameter\end{DoxyParams}
\begin{DoxyReturn}{Returns}
BlocObj : The \hyperlink{class_bloc}{Bloc} object whose value has changed 
\end{DoxyReturn}


Definition at line 354 of file template.cpp.

\hypertarget{group__group1_gafe341a6e862309b65cad704011d2824e}{
\index{group1@{group1}!\_\-CRbloc@{\_\-CRbloc}}
\index{\_\-CRbloc@{\_\-CRbloc}!group1@{group1}}
\subsubsection[{\_\-CRbloc}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-CRbloc (mmachine {\em m})}}
\label{group__group1_gafe341a6e862309b65cad704011d2824e}


\_\-CRbloc : Open, initialize \hyperlink{class_bloc}{Bloc} object 

{\bfseries Prototype:} fun \mbox{[}Chn\mbox{]} BlocObj


\begin{DoxyParams}{Parameters}
\item[{\em Chn}]: current channel\end{DoxyParams}
\begin{DoxyReturn}{Returns}
BlocObj : \hyperlink{class_bloc}{Bloc} object if success, NIL otherwise 
\end{DoxyReturn}


Definition at line 255 of file template.cpp.

\hypertarget{group__group1_gaaad556e6b2a980ee77045edc80b99ee8}{
\index{group1@{group1}!\_\-DSbloc@{\_\-DSbloc}}
\index{\_\-DSbloc@{\_\-DSbloc}!group1@{group1}}
\subsubsection[{\_\-DSbloc}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-DSbloc (mmachine {\em m})}}
\label{group__group1_gaaad556e6b2a980ee77045edc80b99ee8}


\_\-DSbloc : Destroy bloc object 

{\bfseries Prototype:} fun \mbox{[}BlocObj\mbox{]} I


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: \hyperlink{class_bloc}{Bloc} Object to destroy\end{DoxyParams}
\begin{DoxyReturn}{Returns}
I : 0 if success, NIL otherwise 
\end{DoxyReturn}


Definition at line 322 of file template.cpp.

\hypertarget{group__group1_ga1eed6bf98129fdd265b5f07ab4743e2a}{
\index{group1@{group1}!\_\-GETblocName@{\_\-GETblocName}}
\index{\_\-GETblocName@{\_\-GETblocName}!group1@{group1}}
\subsubsection[{\_\-GETblocName}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-GETblocName (mmachine {\em m})}}
\label{group__group1_ga1eed6bf98129fdd265b5f07ab4743e2a}


\_\-GETblocName : Get the name of the bloc 

{\bfseries Prototype:} fun \mbox{[}BlocObj\mbox{]} S


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: bloc object\end{DoxyParams}
\begin{DoxyReturn}{Returns}
S : The name of the bloc if success, NIL otherwise 
\end{DoxyReturn}


Definition at line 150 of file template.cpp.

\hypertarget{group__group1_gae801504f1f746026f0386ae5705e9008}{
\index{group1@{group1}!\_\-GETblocValue@{\_\-GETblocValue}}
\index{\_\-GETblocValue@{\_\-GETblocValue}!group1@{group1}}
\subsubsection[{\_\-GETblocValue}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-GETblocValue (mmachine {\em m})}}
\label{group__group1_gae801504f1f746026f0386ae5705e9008}


\_\-GETblocValue : Get the value of the \hyperlink{class_bloc}{Bloc} object 

{\bfseries Prototype:} fun \mbox{[}BlocObj\mbox{]} I


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: bloc object\end{DoxyParams}
\begin{DoxyReturn}{Returns}
I : return bloc value, nil otherwise 
\end{DoxyReturn}


Definition at line 77 of file template.cpp.

\hypertarget{group__group1_gacae00870405f8f406fab2ea9c115c142}{
\index{group1@{group1}!\_\-SETblocName@{\_\-SETblocName}}
\index{\_\-SETblocName@{\_\-SETblocName}!group1@{group1}}
\subsubsection[{\_\-SETblocName}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-SETblocName (mmachine {\em m})}}
\label{group__group1_gacae00870405f8f406fab2ea9c115c142}


\_\-SETblocName : Set the name of the bloc 

{\bfseries Prototype:} fun \mbox{[}BlocObj S\mbox{]} I


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: bloc object \item[{\em S}]: New name\end{DoxyParams}
\begin{DoxyReturn}{Returns}
I : 0 if success, -\/1 otherwise 
\end{DoxyReturn}


Definition at line 187 of file template.cpp.

\hypertarget{group__group1_ga72cef6cbca74b4ce6715a387f811e834}{
\index{group1@{group1}!\_\-SETblocValue@{\_\-SETblocValue}}
\index{\_\-SETblocValue@{\_\-SETblocValue}!group1@{group1}}
\subsubsection[{\_\-SETblocValue}]{\setlength{\rightskip}{0pt plus 5cm}int \_\-SETblocValue (mmachine {\em m})}}
\label{group__group1_ga72cef6cbca74b4ce6715a387f811e834}


\_\-SETblocValue : Set the value of the bloc 

{\bfseries Prototype:} fun \mbox{[}BlocObj I\mbox{]} I


\begin{DoxyParams}{Parameters}
\item[{\em BlocObj}]: bloc object \item[{\em I}]: New value\end{DoxyParams}
\begin{DoxyReturn}{Returns}
I : 0 if success, -\/1 otherwise 
\end{DoxyReturn}


Definition at line 111 of file template.cpp.