ControlAPI::CommandStatusControlMethods Class Reference

Base class for implementing methods for CommandStatus objects. More...

#include <HC_API.h>

Inheritance diagram for ControlAPI::CommandStatusControlMethods:

Public Member Functions

virtual std::string className ()
 
virtual bool runFull ()=0
 initializes, and runs the command until it stops (blocking) More...
 
virtual bool runASync ()=0
 initialize and start the command async. More...
 
virtual bool initialize ()=0
 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)=0
 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 ()=0
 Wait until command is ready to begin a update step More...
 
virtual bool waitUpdateReadyOrFinished ()=0
 Wait until command is ready to begin an update step or it is finished. More...
 
virtual void waitFinished ()=0
 Wait for the command to finish. More...
 
virtual void stop ()=0
 End the command (cancel)
 
virtual bool isBusy () const =0
 returns true if the command is currently running
 
virtual bool isUpdateStepReady () const =0
 
virtual bool isFinished () const =0
 returns true if the command has finished. (normally finished or cancelled).
 
virtual bool isCancelled () const =0
 returns true if the command was cancelled.
 
virtual bool isSuccessful () const =0
 

Static Public Member Functions

static std::string staticClassName ()
 

Detailed Description

Base class for implementing methods for CommandStatus objects.

Member Function Documentation

◆ initialize()

virtual bool ControlAPI::CommandStatusControlMethods::initialize ()
 pure virtual

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

Returns

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

◆ runASync()

virtual bool ControlAPI::CommandStatusControlMethods::runASync ()
 pure virtual

initialize and start the command async.

Returns

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

◆ runFull()

virtual bool ControlAPI::CommandStatusControlMethods::runFull ()
 pure virtual

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

Returns

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

◆ update()

virtual bool ControlAPI::CommandStatusControlMethods::update (bool stepped = false)
 pure virtual

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

Implemented in ControlAPI::CommandStatus.

◆ waitFinished()

virtual void ControlAPI::CommandStatusControlMethods::waitFinished ()
 pure virtual

Wait for the command to finish.

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

◆ waitUpdateReady()

virtual bool ControlAPI::CommandStatusControlMethods::waitUpdateReady ()
 pure virtual

Wait until command is ready to begin a update step

Returns

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

◆ waitUpdateReadyOrFinished()

virtual bool ControlAPI::CommandStatusControlMethods::waitUpdateReadyOrFinished ()
 pure virtual

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

Returns

Implemented in ControlAPI::CommandStatus, and ControlAPI::CompositeCommandStatusSet.

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