LSST::M1M3::SS::ForceActuatorBumpTestCommand Class Reference

Command to start bump testing of force actuator. More...

#include <ForceActuatorBumpTestCommand.h>

Inheritance diagram for LSST::M1M3::SS::ForceActuatorBumpTestCommand:

Collaboration diagram for LSST::M1M3::SS::ForceActuatorBumpTestCommand:

Public Member Functions
	ForceActuatorBumpTestCommand (int32_t commandID, MTM1M3_command_forceActuatorBumpTestC *data)
MTM1M3_command_forceActuatorBumpTestC *	getData ()
bool	validate () override
	Validates command parameters.
void	execute () override
	Executes the command.
void	ackInProgress (const char *description, double timeout) override
	Acknowledges the command is in progress.
void	ackComplete () override
	Acknowledges the command has completed successfully.
void	ackFailed (std::string reason) override
	Acknowledges the command has failed.
Public Member Functions inherited from LSST::M1M3::SS::Command
	Command (int32_t commandID)
int32_t	getCommandID ()
	Gets the command ID.
virtual double	getDefaultTimeout ()
virtual void	ackInProgress ()

Additional Inherited Members
Protected Attributes inherited from LSST::M1M3::SS::Command
int32_t	_commandID

Detailed Description

Command to start bump testing of force actuator.

See also

BumpTestController

Member Function Documentation

ackComplete()

void ForceActuatorBumpTestCommand::ackComplete ( )

overridevirtual

Acknowledges the command has completed successfully.

Reimplemented from LSST::M1M3::SS::Command.

Here is the call graph for this function:

ackFailed()

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

overridevirtual

Acknowledges the command has failed.

Parameters

[in]

reason

The reason why the command has failed.

Reimplemented from LSST::M1M3::SS::Command.

Here is the call graph for this function:

ackInProgress()

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

overridevirtual

Acknowledges the command is in progress.

Parameters

description	Textual description send with the command.
timeout

Reimplemented from LSST::M1M3::SS::Command.

Here is the call graph for this function:

execute()

void ForceActuatorBumpTestCommand::execute ( )

overridevirtual

Executes the command.

Reimplemented from LSST::M1M3::SS::Command.

Here is the call graph for this function:

validate()

bool ForceActuatorBumpTestCommand::validate ( )

overridevirtual

Validates command parameters.

Return false if actuator ID is invalid, or another bump test is running.

Reimplemented from LSST::M1M3::SS::Command.

---

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

• Commands/ForceActuatorBumpTestCommand.h
• Commands/ForceActuatorBumpTestCommand.cpp