\hypertarget{classsimplehsm_1_1_simple_hs__}{
\section{simplehsm.SimpleHs\_\- Class Reference}
\label{classsimplehsm_1_1_simple_hs__}\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}}
}
SimpleHsm class.  


\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
def \hyperlink{classsimplehsm_1_1_simple_hs___b9ce2f35df7eb441c8f55ae9c5a43f22}{InitialState}
\begin{CompactList}\small\item\em Initialise a simplehsm state machine. \item\end{CompactList}\item 
def \hyperlink{classsimplehsm_1_1_simple_hs___eba5e36f32f9f8130dfd95c8ede24703}{TransitionState}
\begin{CompactList}\small\item\em Initiate a transition to a new state. \item\end{CompactList}\item 
def \hyperlink{classsimplehsm_1_1_simple_hs___a8898a1ce56e4a7d5bed16cb51cff1ed}{InitTransitionState}
\begin{CompactList}\small\item\em Initiate an initial transition to a new state (this function should only be used from a SIG\_\-INIT state event). \item\end{CompactList}\item 
def \hyperlink{classsimplehsm_1_1_simple_hs___a8a34116b3047d2b1ad1993f703821fc}{SignalCurrentState}
\begin{CompactList}\small\item\em Send a signal to the state machine. \item\end{CompactList}\item 
def \hyperlink{classsimplehsm_1_1_simple_hs___79c7095be6648996d3560ed8c27ec61f}{IsInState}
\begin{CompactList}\small\item\em Check if a state machine is currently in a certain state. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
SimpleHsm class. 

The basic state machine implementation. This class should be subclassed to create a state machine. 

\subsection{Member Function Documentation}
\hypertarget{classsimplehsm_1_1_simple_hs___b9ce2f35df7eb441c8f55ae9c5a43f22}{
\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}!InitialState@{InitialState}}
\index{InitialState@{InitialState}!simplehsm::SimpleHs_@{simplehsm::SimpleHs\_\-}}
\subsubsection[{InitialState}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.SimpleHs\_\-.InitialState ( {\em self}, \/   {\em new\_\-state})}}
\label{classsimplehsm_1_1_simple_hs___b9ce2f35df7eb441c8f55ae9c5a43f22}


Initialise a simplehsm state machine. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em new\_\-state}]The initial or starting state \end{description}
\end{Desc}
\hypertarget{classsimplehsm_1_1_simple_hs___a8898a1ce56e4a7d5bed16cb51cff1ed}{
\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}!InitTransitionState@{InitTransitionState}}
\index{InitTransitionState@{InitTransitionState}!simplehsm::SimpleHs_@{simplehsm::SimpleHs\_\-}}
\subsubsection[{InitTransitionState}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.SimpleHs\_\-.InitTransitionState ( {\em self}, \/   {\em new\_\-state})}}
\label{classsimplehsm_1_1_simple_hs___a8898a1ce56e4a7d5bed16cb51cff1ed}


Initiate an initial transition to a new state (this function should only be used from a SIG\_\-INIT state event). 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em new\_\-state}]The state to transition to \end{description}
\end{Desc}
\hypertarget{classsimplehsm_1_1_simple_hs___79c7095be6648996d3560ed8c27ec61f}{
\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}!IsInState@{IsInState}}
\index{IsInState@{IsInState}!simplehsm::SimpleHs_@{simplehsm::SimpleHs\_\-}}
\subsubsection[{IsInState}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.SimpleHs\_\-.IsInState ( {\em self}, \/   {\em state})}}
\label{classsimplehsm_1_1_simple_hs___79c7095be6648996d3560ed8c27ec61f}


Check if a state machine is currently in a certain state. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state}]The state to check \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if the state machine is currently in the specified state \end{Desc}
\hypertarget{classsimplehsm_1_1_simple_hs___a8a34116b3047d2b1ad1993f703821fc}{
\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}!SignalCurrentState@{SignalCurrentState}}
\index{SignalCurrentState@{SignalCurrentState}!simplehsm::SimpleHs_@{simplehsm::SimpleHs\_\-}}
\subsubsection[{SignalCurrentState}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.SimpleHs\_\-.SignalCurrentState ( {\em self}, \/   {\em state\_\-event})}}
\label{classsimplehsm_1_1_simple_hs___a8a34116b3047d2b1ad1993f703821fc}


Send a signal to the state machine. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em state\_\-event}]The event to send to the state machine \end{description}
\end{Desc}
\hypertarget{classsimplehsm_1_1_simple_hs___eba5e36f32f9f8130dfd95c8ede24703}{
\index{simplehsm::SimpleHs\_\-@{simplehsm::SimpleHs\_\-}!TransitionState@{TransitionState}}
\index{TransitionState@{TransitionState}!simplehsm::SimpleHs_@{simplehsm::SimpleHs\_\-}}
\subsubsection[{TransitionState}]{\setlength{\rightskip}{0pt plus 5cm}def simplehsm.SimpleHs\_\-.TransitionState ( {\em self}, \/   {\em new\_\-state})}}
\label{classsimplehsm_1_1_simple_hs___eba5e36f32f9f8130dfd95c8ede24703}


Initiate a transition to a new state. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em new\_\-state}]The state to transition to \end{description}
\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{simplehsm_8py}{simplehsm.py}\end{CompactItemize}
