M1M3 Support System: LSST::M1M3::SS::Command Class Reference

M1M3 Support System

Loading...

Searching...

No Matches

LSST
M1M3
SS
Command

Parent class for all commands. More...

#include <Command.h>

Inherited by LSST::M1M3::SS::AbortProfileCommand, LSST::M1M3::SS::AbortRaiseM1M3Command, LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesByMirrorForceCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::BoosterValveCloseCommand, LSST::M1M3::SS::BoosterValveOpenCommand, LSST::M1M3::SS::ClearActiveOpticForcesCommand, LSST::M1M3::SS::ClearOffsetForcesCommand, LSST::M1M3::SS::ClearSlewFlagCommand, LSST::M1M3::SS::DisableCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::DisableHardpointChaseCommand, LSST::M1M3::SS::DisableHardpointCorrectionsCommand, LSST::M1M3::SS::EnableAllForceActuatorsCommand, LSST::M1M3::SS::EnableCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::EnableHardpointChaseCommand, LSST::M1M3::SS::EnableHardpointCorrectionsCommand, LSST::M1M3::SS::EnterControlCommand, LSST::M1M3::SS::EnterEngineeringCommand, LSST::M1M3::SS::ExitControlCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::LowerM1M3Command, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::PauseM1M3RaisingLoweringCommand, LSST::M1M3::SS::PositionM1M3Command, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::RecordRawDCAccelerometersCommand, LSST::M1M3::SS::ReloadConfigurationCommand, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::ResumeM1M3RaisingLoweringCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::SetSlewFlagCommand, LSST::M1M3::SS::StandbyCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::StopHardpointMotionCommand, LSST::M1M3::SS::StopRawDCAccelerometersCommand, LSST::M1M3::SS::TMAAzimuthSampleCommand, LSST::M1M3::SS::TMAElevationSampleCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TranslateM1M3Command, LSST::M1M3::SS::TurnAirOffCommand, LSST::M1M3::SS::TurnAirOnCommand, LSST::M1M3::SS::TurnLightsOffCommand, LSST::M1M3::SS::TurnLightsOnCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, LSST::M1M3::SS::UpdateCommand, and LSST::M1M3::SS::UpdatePIDCommand.

Public Member Functions
	Command (int32_t commandID)

int32_t	getCommandID ()
	Gets the command ID.

virtual double	getDefaultTimeout ()

virtual bool	validate ()
	Validates the command.

virtual void	execute ()
	Executes the command.

virtual void	ackInProgress ()

virtual void	ackInProgress (const char *description, double timeout)
	Acknowledges the command is in progress.

virtual void	ackComplete ()
	Acknowledges the command has completed successfully.

virtual void	ackFailed (std::string reason)
	Acknowledges the command has failed.

Protected Attributes
int32_t	_commandID

Detailed Description

Parent class for all commands.

Follows Command Pattern from Design Patterns. Encapsulates command executed in M1M3 SS. Commands are created from SAL messages by CommandFactory::create() and M1M3SSSubscriber in SubscriberThread::run().

Member Function Documentation

◆ ackComplete()

void Command::ackComplete ( )

virtual

Acknowledges the command has completed successfully.

Reimplemented in LSST::M1M3::SS::AbortProfileCommand, LSST::M1M3::SS::AbortRaiseM1M3Command, LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesByMirrorForceCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::BoosterValveCloseCommand, LSST::M1M3::SS::BoosterValveOpenCommand, LSST::M1M3::SS::ClearActiveOpticForcesCommand, LSST::M1M3::SS::ClearOffsetForcesCommand, LSST::M1M3::SS::ClearSlewFlagCommand, LSST::M1M3::SS::DisableCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::DisableHardpointChaseCommand, LSST::M1M3::SS::DisableHardpointCorrectionsCommand, LSST::M1M3::SS::EnableAllForceActuatorsCommand, LSST::M1M3::SS::EnableCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::EnableHardpointChaseCommand, LSST::M1M3::SS::EnableHardpointCorrectionsCommand, LSST::M1M3::SS::EnterEngineeringCommand, LSST::M1M3::SS::ExitControlCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::LowerM1M3Command, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::PauseM1M3RaisingLoweringCommand, LSST::M1M3::SS::PositionM1M3Command, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::ResumeM1M3RaisingLoweringCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::SetSlewFlagCommand, LSST::M1M3::SS::StandbyCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::StopHardpointMotionCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TranslateM1M3Command, LSST::M1M3::SS::TurnAirOffCommand, LSST::M1M3::SS::TurnAirOnCommand, LSST::M1M3::SS::TurnLightsOffCommand, LSST::M1M3::SS::TurnLightsOnCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, and LSST::M1M3::SS::UpdatePIDCommand.

◆ ackFailed()

void Command::ackFailed ( std::string reason )

virtual

Acknowledges the command has failed.

Parameters

[in] reason The reason why the command has failed.

Reimplemented in LSST::M1M3::SS::AbortProfileCommand, LSST::M1M3::SS::AbortRaiseM1M3Command, LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesByMirrorForceCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::BoosterValveCloseCommand, LSST::M1M3::SS::BoosterValveOpenCommand, LSST::M1M3::SS::ClearActiveOpticForcesCommand, LSST::M1M3::SS::ClearOffsetForcesCommand, LSST::M1M3::SS::ClearSlewFlagCommand, LSST::M1M3::SS::DisableCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::DisableHardpointChaseCommand, LSST::M1M3::SS::DisableHardpointCorrectionsCommand, LSST::M1M3::SS::EnableAllForceActuatorsCommand, LSST::M1M3::SS::EnableCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::EnableHardpointChaseCommand, LSST::M1M3::SS::EnableHardpointCorrectionsCommand, LSST::M1M3::SS::EnterEngineeringCommand, LSST::M1M3::SS::ExitControlCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::LowerM1M3Command, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::PauseM1M3RaisingLoweringCommand, LSST::M1M3::SS::PositionM1M3Command, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::ResumeM1M3RaisingLoweringCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::SetSlewFlagCommand, LSST::M1M3::SS::StandbyCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::StopHardpointMotionCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TranslateM1M3Command, LSST::M1M3::SS::TurnAirOffCommand, LSST::M1M3::SS::TurnAirOnCommand, LSST::M1M3::SS::TurnLightsOffCommand, LSST::M1M3::SS::TurnLightsOnCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, and LSST::M1M3::SS::UpdatePIDCommand.

◆ ackInProgress()

void Command::ackInProgress	(	const char *	description,
		double	timeout )

virtual

Acknowledges the command is in progress.

Parameters

description	Textual description send with the command.
timeout

Reimplemented in LSST::M1M3::SS::AbortProfileCommand, LSST::M1M3::SS::AbortRaiseM1M3Command, LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesByMirrorForceCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::BoosterValveCloseCommand, LSST::M1M3::SS::BoosterValveOpenCommand, LSST::M1M3::SS::ClearActiveOpticForcesCommand, LSST::M1M3::SS::ClearOffsetForcesCommand, LSST::M1M3::SS::ClearSlewFlagCommand, LSST::M1M3::SS::DisableCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::DisableHardpointChaseCommand, LSST::M1M3::SS::DisableHardpointCorrectionsCommand, LSST::M1M3::SS::EnableAllForceActuatorsCommand, LSST::M1M3::SS::EnableCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::EnableHardpointChaseCommand, LSST::M1M3::SS::EnableHardpointCorrectionsCommand, LSST::M1M3::SS::EnterEngineeringCommand, LSST::M1M3::SS::ExitControlCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::LowerM1M3Command, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::PauseM1M3RaisingLoweringCommand, LSST::M1M3::SS::PositionM1M3Command, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::ResumeM1M3RaisingLoweringCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::SetSlewFlagCommand, LSST::M1M3::SS::StandbyCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::StopHardpointMotionCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TranslateM1M3Command, LSST::M1M3::SS::TurnAirOffCommand, LSST::M1M3::SS::TurnAirOnCommand, LSST::M1M3::SS::TurnLightsOffCommand, LSST::M1M3::SS::TurnLightsOnCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, and LSST::M1M3::SS::UpdatePIDCommand.

◆ execute()

void Command::execute ( )

virtual

Executes the command.

Reimplemented in LSST::M1M3::SS::AbortProfileCommand, LSST::M1M3::SS::AbortRaiseM1M3Command, LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesByMirrorForceCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::BoosterValveCloseCommand, LSST::M1M3::SS::BoosterValveOpenCommand, LSST::M1M3::SS::ClearActiveOpticForcesCommand, LSST::M1M3::SS::ClearOffsetForcesCommand, LSST::M1M3::SS::ClearSlewFlagCommand, LSST::M1M3::SS::DisableCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::DisableHardpointChaseCommand, LSST::M1M3::SS::DisableHardpointCorrectionsCommand, LSST::M1M3::SS::EnableAllForceActuatorsCommand, LSST::M1M3::SS::EnableCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::EnableHardpointChaseCommand, LSST::M1M3::SS::EnableHardpointCorrectionsCommand, LSST::M1M3::SS::EnterControlCommand, LSST::M1M3::SS::EnterEngineeringCommand, LSST::M1M3::SS::ExitControlCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::LowerM1M3Command, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::PauseM1M3RaisingLoweringCommand, LSST::M1M3::SS::PositionM1M3Command, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::RecordRawDCAccelerometersCommand, LSST::M1M3::SS::ReloadConfigurationCommand, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::ResumeM1M3RaisingLoweringCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::SetSlewFlagCommand, LSST::M1M3::SS::StandbyCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::StopHardpointMotionCommand, LSST::M1M3::SS::StopRawDCAccelerometersCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TMAAzimuthSampleCommand, LSST::M1M3::SS::TMAElevationSampleCommand, LSST::M1M3::SS::TranslateM1M3Command, LSST::M1M3::SS::TurnAirOffCommand, LSST::M1M3::SS::TurnAirOnCommand, LSST::M1M3::SS::TurnLightsOffCommand, LSST::M1M3::SS::TurnLightsOnCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, LSST::M1M3::SS::UpdateCommand, and LSST::M1M3::SS::UpdatePIDCommand.

◆ validate()

bool Command::validate ( )

virtual

Validates the command.

Reimplemented in LSST::M1M3::SS::ApplyActiveOpticForcesCommand, LSST::M1M3::SS::ApplyOffsetForcesCommand, LSST::M1M3::SS::DisableForceActuatorCommand, LSST::M1M3::SS::EnableDisableForceComponentCommand, LSST::M1M3::SS::EnableForceActuatorCommand, LSST::M1M3::SS::ExitEngineeringCommand, LSST::M1M3::SS::ForceActuatorBumpTestCommand, LSST::M1M3::SS::KillHardpointTestCommand, LSST::M1M3::SS::MoveHardpointActuatorsCommand, LSST::M1M3::SS::PanicCommand, LSST::M1M3::SS::RaiseM1M3Command, LSST::M1M3::SS::ResetPIDCommand, LSST::M1M3::SS::RunMirrorForceProfileCommand, LSST::M1M3::SS::SetSlewControllerSettingsCommand, LSST::M1M3::SS::StartCommand, LSST::M1M3::SS::TestHardpointCommand, LSST::M1M3::SS::TurnPowerOffCommand, LSST::M1M3::SS::TurnPowerOnCommand, and LSST::M1M3::SS::UpdatePIDCommand.

Here is the caller graph for this function:

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

Commands/Command.h
Commands/Command.cpp