\hypertarget{namespacesimplehsm}{
\section{Package simplehsm}
\label{namespacesimplehsm}\index{simplehsm@{simplehsm}}
}
\subsection*{Classes}
\begin{CompactItemize}
\item 
class \hyperlink{classsimplehsm_1_1_state_event}{StateEvent}
\begin{CompactList}\small\item\em \hyperlink{classsimplehsm_1_1_state_event}{StateEvent} class. \item\end{CompactList}\item 
class \hyperlink{classsimplehsm_1_1_simple_hsm}{SimpleHsm}
\begin{CompactList}\small\item\em \hyperlink{classsimplehsm_1_1_simple_hsm}{SimpleHsm} class. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
def \hyperlink{namespacesimplehsm_59182d084c59090c89e303eb3fcd204b}{deep\_\-history}
\begin{CompactList}\small\item\em Add a deep history psuedostate to a composite state. \item\end{CompactList}\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
int \hyperlink{namespacesimplehsm_7622f6140b02bab0258d0ea45dc50503}{SIG\_\-NULL} = 0
\begin{CompactList}\small\item\em Null signal, all state functions should ignore this signal and return their parent state (or None if the top level state). \item\end{CompactList}\item 
int \hyperlink{namespacesimplehsm_efef3a89742e0f0cb8988c2ee8738ded}{SIG\_\-INIT} = 1
\begin{CompactList}\small\item\em Initialisation signal, a state function should transition to a default substate (\hyperlink{classsimplehsm_1_1_simple_hsm_e91280b0ea99849e546bc46509b940b7}{SimpleHsm.InitTransitionState()}) if it has substates. \item\end{CompactList}\item 
int \hyperlink{namespacesimplehsm_bcc2da008baf495ead8ead5ae7a3d158}{SIG\_\-ENTRY} = 2
\begin{CompactList}\small\item\em Entry signal, a state function should perform its entry actions (if any). \item\end{CompactList}\item 
int \hyperlink{namespacesimplehsm_9da0126e34c758effb41944604c7981a}{SIG\_\-EXIT} = 3
\begin{CompactList}\small\item\em Exit signal, a state function should perform its exit actions (if any). \item\end{CompactList}\item 
int \hyperlink{namespacesimplehsm_7811b0a8222965fa3a4ce910363d7774}{SIG\_\-USER} = 4
\begin{CompactList}\small\item\em User signals should start from this index. \item\end{CompactList}\end{CompactItemize}


\subsection{Function Documentation}
\hypertarget{namespacesimplehsm_59182d084c59090c89e303eb3fcd204b}{
\index{simplehsm@{simplehsm}!deep\_\-history@{deep\_\-history}}
\index{deep\_\-history@{deep\_\-history}!simplehsm@{simplehsm}}
\subsubsection[{deep\_\-history}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.deep\_\-history ( {\em state})}}
\label{namespacesimplehsm_59182d084c59090c89e303eb3fcd204b}


Add a deep history psuedostate to a composite state. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]The state to recive a deep history child state \end{description}
\end{Desc}


\subsection{Variable Documentation}
\hypertarget{namespacesimplehsm_bcc2da008baf495ead8ead5ae7a3d158}{
\index{simplehsm@{simplehsm}!SIG\_\-ENTRY@{SIG\_\-ENTRY}}
\index{SIG\_\-ENTRY@{SIG\_\-ENTRY}!simplehsm@{simplehsm}}
\subsubsection[{SIG\_\-ENTRY}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf simplehsm.SIG\_\-ENTRY} = 2}}
\label{namespacesimplehsm_bcc2da008baf495ead8ead5ae7a3d158}


Entry signal, a state function should perform its entry actions (if any). 

\hypertarget{namespacesimplehsm_9da0126e34c758effb41944604c7981a}{
\index{simplehsm@{simplehsm}!SIG\_\-EXIT@{SIG\_\-EXIT}}
\index{SIG\_\-EXIT@{SIG\_\-EXIT}!simplehsm@{simplehsm}}
\subsubsection[{SIG\_\-EXIT}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf simplehsm.SIG\_\-EXIT} = 3}}
\label{namespacesimplehsm_9da0126e34c758effb41944604c7981a}


Exit signal, a state function should perform its exit actions (if any). 

\hypertarget{namespacesimplehsm_efef3a89742e0f0cb8988c2ee8738ded}{
\index{simplehsm@{simplehsm}!SIG\_\-INIT@{SIG\_\-INIT}}
\index{SIG\_\-INIT@{SIG\_\-INIT}!simplehsm@{simplehsm}}
\subsubsection[{SIG\_\-INIT}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf simplehsm.SIG\_\-INIT} = 1}}
\label{namespacesimplehsm_efef3a89742e0f0cb8988c2ee8738ded}


Initialisation signal, a state function should transition to a default substate (\hyperlink{classsimplehsm_1_1_simple_hsm_e91280b0ea99849e546bc46509b940b7}{SimpleHsm.InitTransitionState()}) if it has substates. 

\hypertarget{namespacesimplehsm_7622f6140b02bab0258d0ea45dc50503}{
\index{simplehsm@{simplehsm}!SIG\_\-NULL@{SIG\_\-NULL}}
\index{SIG\_\-NULL@{SIG\_\-NULL}!simplehsm@{simplehsm}}
\subsubsection[{SIG\_\-NULL}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf simplehsm.SIG\_\-NULL} = 0}}
\label{namespacesimplehsm_7622f6140b02bab0258d0ea45dc50503}


Null signal, all state functions should ignore this signal and return their parent state (or None if the top level state). 

\hypertarget{namespacesimplehsm_7811b0a8222965fa3a4ce910363d7774}{
\index{simplehsm@{simplehsm}!SIG\_\-USER@{SIG\_\-USER}}
\index{SIG\_\-USER@{SIG\_\-USER}!simplehsm@{simplehsm}}
\subsubsection[{SIG\_\-USER}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf simplehsm.SIG\_\-USER} = 4}}
\label{namespacesimplehsm_7811b0a8222965fa3a4ce910363d7774}


User signals should start from this index. 

