LSST::M1M3::SS::ExitControlCommand Class Reference

#include <ExitControlCommand.h>

Inheritance diagram for LSST::M1M3::SS::ExitControlCommand:

Collaboration diagram for LSST::M1M3::SS::ExitControlCommand:

Public Member Functions
	ExitControlCommand (int32_t commandID)
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 bool	validate ()
	Validates the command.
virtual void	ackInProgress ()

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

Detailed Description

This command is responsible for transitioning the state machine from the standby state to the offline state. This is an external command and can be issued via SAL. Once this command has been executed the software will stop running.

Member Function Documentation

ackComplete()

void ExitControlCommand::ackComplete ( )

overridevirtual

Acknowledges the command has completed successfully.

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

Here is the call graph for this function:

ackFailed()

void ExitControlCommand::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 ExitControlCommand::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:

Here is the caller graph for this function:

execute()

void ExitControlCommand::execute ( )

overridevirtual

Executes the command.

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

Here is the call graph for this function:

---

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

• Commands/ExitControlCommand.h
• Commands/ExitControlCommand.cpp