LSST::M1M3::SS::State Class Reference

Abstract class for M1M3 state. More...

#include <State.h>

Inheritance diagram for LSST::M1M3::SS::State:

Public Member Functions
	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	storeTMAAzimuthSample (TMAAzimuthSampleCommand *command)
virtual States::Type	storeTMAElevationSample (TMAElevationSampleCommand *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
States::Type	rejectCommandInvalidState (Command *command, std::string cmd_name)

Protected Attributes
std::string	name

Detailed Description

Abstract class for M1M3 state.

Any M1M3 state should inherit this class and implements command functions it executed. Calls to functions not implemented for the state shall be rejected.

Member Function Documentation

enterControl()

States::Type State::enterControl ( EnterControlCommand * command )

virtual

Executes EnterControlCommand.

Parameters

command

EnterControlCommand to execute

Returns

next state if M1M3's state has changed or States::NoStateTransition for no M1M3's state change

Reimplemented in LSST::M1M3::SS::OfflineState.

Here is the caller graph for this function:

update()

virtual States::Type LSST::M1M3::SS::State::update ( UpdateCommand * command )

pure virtual

Called to retrieve telemetry data.

This method is called from OuterLoopClockThread. As every concrete child class must provide update routine, it is pure virtual.

Parameters

command

UpdateCommand, ignored.

Returns

new state, or States::NoStateTransition if state doesn't change

Implemented in LSST::M1M3::SS::ActiveEngineeringState, LSST::M1M3::SS::ActiveState, LSST::M1M3::SS::DisabledState, LSST::M1M3::SS::FaultState, LSST::M1M3::SS::LoweringEngineeringState, LSST::M1M3::SS::LoweringFaultState, LSST::M1M3::SS::LoweringState, LSST::M1M3::SS::OfflineState, LSST::M1M3::SS::ParkedEngineeringState, LSST::M1M3::SS::ParkedState, LSST::M1M3::SS::PausedLoweringEngineeringState, LSST::M1M3::SS::PausedLoweringState, LSST::M1M3::SS::PausedRaisingEngineeringState, LSST::M1M3::SS::PausedRaisingState, LSST::M1M3::SS::ProfileHardpointCorrectionState, LSST::M1M3::SS::RaisingEngineeringState, LSST::M1M3::SS::RaisingState, and LSST::M1M3::SS::StandbyState.

---

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

• States/State.h
• States/State.cpp