M1M3 Support System
Loading...
Searching...
No Matches
LSST::M1M3::SS::EnabledState Class Reference

Parent class for all enabled sub-states. More...

#include <EnabledState.h>

Inheritance diagram for LSST::M1M3::SS::EnabledState:
Collaboration diagram for LSST::M1M3::SS::EnabledState:

Public Member Functions

 EnabledState (std::string name)
 
States::Type storeTMAAzimuthSample (TMAAzimuthSampleCommand *command) override
 
States::Type storeTMAElevationSample (TMAElevationSampleCommand *command) override
 
- Public Member Functions inherited from LSST::M1M3::SS::State
 State (std::string name)
 
virtual States::Type enterControl (EnterControlCommand *command)
 Executes EnterControlCommand.
 
virtual States::Type start (StartCommand *command)
 
virtual States::Type enable (EnableCommand *command)
 
virtual States::Type disable (DisableCommand *command)
 
virtual States::Type standby (StandbyCommand *command)
 
virtual States::Type exitControl (ExitControlCommand *command)
 
virtual States::Type update (UpdateCommand *command)=0
 Called to retrieve telemetry data.
 
virtual States::Type setSlewFlag (SetSlewFlagCommand *command)
 
virtual States::Type clearSlewFlag (ClearSlewFlagCommand *command)
 
virtual States::Type turnAirOn (TurnAirOnCommand *command)
 
virtual States::Type turnAirOff (TurnAirOffCommand *command)
 
virtual States::Type boosterValveOpen (BoosterValveOpenCommand *command)
 
virtual States::Type boosterValveClose (BoosterValveCloseCommand *command)
 
virtual States::Type applyOffsetForces (ApplyOffsetForcesCommand *command)
 
virtual States::Type clearOffsetForces (ClearOffsetForcesCommand *command)
 
virtual States::Type raiseM1M3 (RaiseM1M3Command *command)
 
virtual States::Type lowerM1M3 (LowerM1M3Command *command)
 
virtual States::Type pauseM1M3RaisingLowering (PauseM1M3RaisingLoweringCommand *command)
 
virtual States::Type resumeM1M3RaisingLowering (ResumeM1M3RaisingLoweringCommand *command)
 
virtual States::Type applyActiveOpticForces (ApplyActiveOpticForcesCommand *command)
 
virtual States::Type clearActiveOpticForces (ClearActiveOpticForcesCommand *command)
 
virtual States::Type enterEngineering (EnterEngineeringCommand *command)
 
virtual States::Type exitEngineering (ExitEngineeringCommand *command)
 
virtual States::Type testHardpoint (TestHardpointCommand *command)
 
virtual States::Type killHardpointTest (KillHardpointTestCommand *command)
 
virtual States::Type moveHardpointActuators (MoveHardpointActuatorsCommand *command)
 
virtual States::Type enableHardpointChase (EnableHardpointChaseCommand *command)
 
virtual States::Type disableHardpointChase (DisableHardpointChaseCommand *command)
 
virtual States::Type abortRaiseM1M3 (AbortRaiseM1M3Command *command)
 
virtual States::Type translateM1M3 (TranslateM1M3Command *command)
 
virtual States::Type stopHardpointMotion (StopHardpointMotionCommand *command)
 
virtual States::Type positionM1M3 (PositionM1M3Command *command)
 
virtual States::Type turnLightsOn (TurnLightsOnCommand *command)
 
virtual States::Type turnLightsOff (TurnLightsOffCommand *command)
 
virtual States::Type turnPowerOn (TurnPowerOnCommand *command)
 
virtual States::Type turnPowerOff (TurnPowerOffCommand *command)
 
virtual States::Type enableHardpointCorrections (EnableHardpointCorrectionsCommand *command)
 
virtual States::Type disableHardpointCorrections (DisableHardpointCorrectionsCommand *command)
 
virtual States::Type runMirrorForceProfile (RunMirrorForceProfileCommand *command)
 
virtual States::Type abortProfile (AbortProfileCommand *command)
 
virtual States::Type applyOffsetForcesByMirrorForce (ApplyOffsetForcesByMirrorForceCommand *command)
 
virtual States::Type updatePID (UpdatePIDCommand *command)
 
virtual States::Type resetPID (ResetPIDCommand *command)
 
virtual States::Type forceActuatorBumpTest (ForceActuatorBumpTestCommand *command)
 
virtual States::Type killForceActuatorBumpTest (KillForceActuatorBumpTestCommand *command)
 
virtual States::Type disableForceActuator (DisableForceActuatorCommand *command)
 
virtual States::Type enableForceActuator (EnableForceActuatorCommand *command)
 
virtual States::Type enableAllForceActuators (EnableAllForceActuatorsCommand *command)
 
virtual States::Type enableDisableForceComponent (EnableDisableForceComponentCommand *command)
 
virtual States::Type setSlewControllerSettings (SetSlewControllerSettingsCommand *command)
 

Protected Member Functions

void runLoop ()
 Actions to be performed during a loop in enabled sub-state.
 
void sendTelemetry ()
 Collects and sends telemetry.
 
bool raiseCompleted ()
 Query mirror raising completion.
 
bool lowerCompleted ()
 Query mirror lowering completion.
 
States::Type disableMirror ()
 
- Protected Member Functions inherited from LSST::M1M3::SS::State
States::Type rejectCommandInvalidState (Command *command, std::string cmd_name)
 

Additional Inherited Members

- Protected Attributes inherited from LSST::M1M3::SS::State
std::string name
 

Detailed Description

Parent class for all enabled sub-states.

Enabled state is defined in SAL, this class provides basic functionality for it. Subclasses needs to implement update method (and shall implement commands methods).

Member Function Documentation

◆ lowerCompleted()

bool LSST::M1M3::SS::EnabledState::lowerCompleted ( )
protected

Query mirror lowering completion.

Returns
true if mirror is lowered
Here is the call graph for this function:
Here is the caller graph for this function:

◆ raiseCompleted()

bool LSST::M1M3::SS::EnabledState::raiseCompleted ( )
protected

Query mirror raising completion.

Returns
true if mirror is raised
Here is the call graph for this function:
Here is the caller graph for this function:

◆ runLoop()

void LSST::M1M3::SS::EnabledState::runLoop ( )
protected

Actions to be performed during a loop in enabled sub-state.

Calculate forces, send updates, collects data needed for telemetry.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ storeTMAAzimuthSample()

States::Type LSST::M1M3::SS::EnabledState::storeTMAAzimuthSample ( TMAAzimuthSampleCommand * command)
overridevirtual

Reimplemented from LSST::M1M3::SS::State.

◆ storeTMAElevationSample()

States::Type LSST::M1M3::SS::EnabledState::storeTMAElevationSample ( TMAElevationSampleCommand * command)
overridevirtual

Reimplemented from LSST::M1M3::SS::State.


The documentation for this class was generated from the following files: