ControlAPI::CommandStatus Class Reference

Command Status Object for tracking the current state of a queued or executing command. More...

#include <HC_API.h>

Inheritance diagram for ControlAPI::CommandStatus:

Public Member Functions

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...
 

Static Public Member Functions

static std::string staticClassName ()
 
- Static Public Member Functions inherited from ControlAPI::CommandStatusControlMethods
static std::string staticClassName ()
 

Public Attributes

std::string alias
 The unique alias for this command.
 

Friends

class ControlSystem
 
class ControlSystem_Internals
 
class CommandStatus_Internals
 
class DeviceController
 
class DeviceInfo
 

Detailed Description

Command Status Object for tracking the current state of a queued or executing command.

Member Function Documentation

◆ commandPackage()

DeviceCommandPackage* ControlAPI::CommandStatus::commandPackage ()

The command package associated with the command.

Returns

◆ controlSystem()

ControlSystem* ControlAPI::CommandStatus::controlSystem ()

The control system this command status belongs to.

Returns

◆ deviceController()

DeviceController* ControlAPI::CommandStatus::deviceController ()

The device controller this command status is associated with.

Returns

◆ deviceInfo()

DeviceInfo* ControlAPI::CommandStatus::deviceInfo ()

The device this command status is associated with.

Returns

◆ initialize()

virtual bool ControlAPI::CommandStatus::initialize ()
 overridevirtual

Start the command by internally initializing the thread, binding to the device, and ensuring it is ready to be updated.

Returns

Implements ControlAPI::CommandStatusControlMethods.

◆ runASync()

virtual bool ControlAPI::CommandStatus::runASync ()
 overridevirtual

initialize and start the command async.

Returns

Implements ControlAPI::CommandStatusControlMethods.

◆ runFull()

virtual bool ControlAPI::CommandStatus::runFull ()
 overridevirtual

initializes, and runs the command until it stops (blocking)

Returns

Implements ControlAPI::CommandStatusControlMethods.

◆ stateInfo()

CommandStateInfo* ControlAPI::CommandStatus::stateInfo ()

The command state information associated with the command.

Returns

◆ update()

virtual bool ControlAPI::CommandStatus::update (bool stepped = false)
 overridevirtual

update the command by allowing it to begin. if stepped = true, will begin to perform 1 update. if stepped = false, will update until finished.

Parameters
stepped
Returns

Implements ControlAPI::CommandStatusControlMethods.

◆ waitFinished()

virtual void ControlAPI::CommandStatus::waitFinished ()
 overridevirtual

Wait for the command to finish.

Implements ControlAPI::CommandStatusControlMethods.

◆ waitUpdateReady()

virtual bool ControlAPI::CommandStatus::waitUpdateReady ()
 overridevirtual

Wait until command is ready to begin a update step

Returns

Implements ControlAPI::CommandStatusControlMethods.

◆ waitUpdateReadyOrFinished()

virtual bool ControlAPI::CommandStatus::waitUpdateReadyOrFinished ()
 overridevirtual

Wait until command is ready to begin an update step or it is finished.

Returns

Implements ControlAPI::CommandStatusControlMethods.

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