Command Status for the Spectral Sensor More...
#include <SpectralSensor_controller.h>
Inheritance diagram for ControlAPI::SpectralSensorCommandStatus:
Public Member Functions | |
| SpectralSensorUpdateStateInfo * | stateInfo () |
 Public Member Functions inherited from ControlAPI::CommandStatus | |
| virtual std::string | className () override |
| virtual bool | runFull () override |
| initializes, and runs the command until it stops (blocking) More... | |
| virtual bool | runASync () override |
| initialize and start the command async. More... | |
| virtual bool | initialize () override |
| Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated. More... | |
| virtual bool | update (bool stepped=false) override |
| update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished. More... | |
| virtual bool | waitUpdateReady () override |
| Wait until command is ready to begin a update step More... | |
| virtual bool | waitUpdateReadyOrFinished () override |
| Wait until command is ready to begin an update step or it is finished. More... | |
| virtual void | waitFinished () override |
| Wait for the command to finish. More... | |
| virtual void | stop () override |
| End the command (cancel) | |
| virtual bool | isBusy () const override |
| returns true if the command is currently running | |
| virtual bool | isUpdateStepReady () const override |
| virtual bool | isFinished () const override |
| returns true if the command has finished. (normally finished or cancelled). | |
| virtual bool | isCancelled () const override |
| returns true if the command was cancelled. | |
| virtual bool | isSuccessful () const override |
| int | apiId () const |
| int | deviceApiId () const |
| CommandStateInfo * | stateInfo () |
| The command state information associated with the command. More... | |
| DeviceCommandPackage * | commandPackage () |
| The command package associated with the command. More... | |
| ControlSystem * | controlSystem () |
| The control system this command status belongs to. More... | |
| DeviceInfo * | deviceInfo () |
| The device this command status is associated with. More... | |
| DeviceController * | deviceController () |
| The device controller this command status is associated with. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ControlAPI::CommandStatus | |
| static std::string | staticClassName () |
| Static Public Member Functions inherited from ControlAPI::CommandStatusControlMethods | |
| static std::string | staticClassName () |
| Public Attributes inherited from ControlAPI::CommandStatus | |
| std::string | alias |
| The unique alias for this command. | |
Detailed Description
Command Status for the Spectral Sensor
The documentation for this class was generated from the following file:
- SpectralSensor_controller/SpectralSensor_controller.h