TkStateMachine Class Reference

#include <TkStateMachine.h>

Public Types
enum	StatusType { ready = 1, calibrating = 2, updating = 3, stuck = 4 }

Public Member Functions
bool	alreadyCalibrated () const
bool	isCalibrating () const
bool	isReady () const
bool	isStuck () const
bool	isUpdating () const
void	setCalibrating ()
void	setReady ()
void	setStatus (StatusType in)
void	setStuck ()
void	setUpdating ()
StatusType	status () const
std::string	statusName ()

Public Attributes
StatusType	myStatus

Detailed Description

Implement a state machine. Each of the ApvAnalysis component can be

• calibrating: not yet able to give an answer
• ready: can give an answer, the calibration stays as it is.
• calibrating: can give an answer, at the same time the calibration is updated.
• stuck: a serious error happened.

Definition at line 12 of file TkStateMachine.h.

Member Enumeration Documentation

StatusType

enum TkStateMachine::StatusType

Enumerator
ready
calibrating
updating
stuck

Definition at line 14 of file TkStateMachine.h.

{ ready = 1, calibrating = 2, updating = 3, stuck = 4 };

Member Function Documentation

alreadyCalibrated()

bool TkStateMachine::alreadyCalibrated ( ) const

inline

Definition at line 16 of file TkStateMachine.h.

References myStatus, ready, and updating.

{ return (myStatus == updating || myStatus == ready); }

isCalibrating()

bool TkStateMachine::isCalibrating ( ) const

inline

Definition at line 29 of file TkStateMachine.h.

References calibrating, and myStatus.

Referenced by SimpleNoiseCalculator::updateNoise(), TT6NoiseCalculator::updateNoise(), SimplePedestalCalculator::updatePedestal(), TT6PedestalCalculator::updatePedestal(), TT6PedestalCalculator::updateStatus(), SimplePedestalCalculator::updateStatus(), SimpleNoiseCalculator::updateStatus(), and TT6NoiseCalculator::updateStatus().

{ return myStatus == calibrating; }

isReady()

bool TkStateMachine::isReady ( ) const

inline

Definition at line 26 of file TkStateMachine.h.

References myStatus, and ready.

{ return myStatus == ready; }

isStuck()

bool TkStateMachine::isStuck ( ) const

inline

Definition at line 27 of file TkStateMachine.h.

References myStatus, and stuck.

{ return myStatus == stuck; }

isUpdating()

bool TkStateMachine::isUpdating ( ) const

inline

Definition at line 28 of file TkStateMachine.h.

References myStatus, and updating.

Referenced by SimpleNoiseCalculator::updateNoise(), TT6NoiseCalculator::updateNoise(), TT6PedestalCalculator::updatePedestal(), and SimplePedestalCalculator::updatePedestal().

{ return myStatus == updating; }

setCalibrating()

void TkStateMachine::setCalibrating ( )

inline

Definition at line 21 of file TkStateMachine.h.

References calibrating, and myStatus.

Referenced by SimplePedestalCalculator::init(), TT6PedestalCalculator::init(), and TT6NoiseCalculator::init().

{ myStatus = calibrating; }

setReady()

void TkStateMachine::setReady ( )

inline

Definition at line 19 of file TkStateMachine.h.

References myStatus, and ready.

{ myStatus = ready; }

setStatus()

void TkStateMachine::setStatus ( StatusType  in )

inline

Definition at line 24 of file TkStateMachine.h.

References recoMuon::in, and myStatus.

{ myStatus = in; }

setStuck()

void TkStateMachine::setStuck ( )

inline

Definition at line 22 of file TkStateMachine.h.

References myStatus, and stuck.

{ myStatus = stuck; }

setUpdating()

void TkStateMachine::setUpdating ( )

inline

Definition at line 20 of file TkStateMachine.h.

References myStatus, and updating.

Referenced by TT6NTPedestalCalculator::TT6NTPedestalCalculator(), TT6PedestalCalculator::updateStatus(), SimplePedestalCalculator::updateStatus(), TT6NoiseCalculator::updateStatus(), and SimpleNoiseCalculator::updateStatus().

{ myStatus = updating; }

status()

StatusType TkStateMachine::status ( ) const

inline

Definition at line 17 of file TkStateMachine.h.

References myStatus.

{ return myStatus; }

statusName()

std::string TkStateMachine::statusName ( )

inline

Definition at line 31 of file TkStateMachine.h.

References calibrating, myStatus, ready, stuck, and updating.

                         {
    if (myStatus == ready)
      return "Ready";
    if (myStatus == calibrating)
      return "Calibrating";
    if (myStatus == updating)
      return "Updating";
    if (myStatus == stuck)
      return "Stuck";
    return "Unknown Status";
  }

Member Data Documentation

myStatus

StatusType TkStateMachine::myStatus

Definition at line 44 of file TkStateMachine.h.

Referenced by alreadyCalibrated(), isCalibrating(), isReady(), isStuck(), isUpdating(), setCalibrating(), setReady(), setStatus(), setStuck(), setUpdating(), status(), and statusName().