M1M3 Support System
Loading...
Searching...
No Matches
LSST::M1M3::SS::RunMirrorForceProfileCommand Class Reference
Inheritance diagram for LSST::M1M3::SS::RunMirrorForceProfileCommand:
Collaboration diagram for LSST::M1M3::SS::RunMirrorForceProfileCommand:

Public Member Functions

 RunMirrorForceProfileCommand (int32_t commandID, MTM1M3_command_runMirrorForceProfileC *data)
 
MTM1M3_command_runMirrorForceProfileC * getData ()
 
bool validate ()
 Validates the command.
 
void execute ()
 Executes the command.
 
void ackInProgress (const char *description, double timeout)
 Acknowledges the command is in progress.
 
void ackComplete ()
 Acknowledges the command has completed successfully.
 
void ackFailed (std::string reason)
 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
 

Member Function Documentation

◆ ackComplete()

void RunMirrorForceProfileCommand::ackComplete ( )
virtual

Acknowledges the command has completed successfully.

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

Here is the call graph for this function:

◆ ackFailed()

void RunMirrorForceProfileCommand::ackFailed ( std::string reason)
virtual

Acknowledges the command has failed.

Parameters
[in]reasonThe reason why the command has failed.

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

Here is the call graph for this function:

◆ ackInProgress()

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

Acknowledges the command is in progress.

Parameters
descriptionTextual description send with the command.
timeout

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

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

◆ execute()

void RunMirrorForceProfileCommand::execute ( )
virtual

Executes the command.

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

Here is the call graph for this function:

◆ validate()

bool RunMirrorForceProfileCommand::validate ( )
virtual

Validates the command.

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


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