ControlAPI::DeviceCommandPackage Class Reference

Base Class containing command parameters needed to run a command for a device. The package is referenced during command updating. so parameters can be changed during command execution. More...

#include <HC_API.h>

Inheritance diagram for ControlAPI::DeviceCommandPackage:

Public Member Functions

virtual std::string className () override
 
virtual std::shared_ptr< DeviceCommandPackage > createSharedPtr ()
 
virtual void cloneFrom (DeviceCommandPackage *other)
 clone from another device package - should be implemented for custom types. More...
 
virtual DeviceCommandPackage * prepareUpdatePackage ()
 Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. More...
 
void markUpdatePackageReady ()
 signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.
 

Static Public Member Functions

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

Public Attributes

bool continuous = false
 set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.
 
- Public Attributes inherited from ControlAPI::ApiCommandPackage
std::string alias
 user definable unique alias for this command package
 

Friends

class CommandStatus_Internals
 

Detailed Description

Base Class containing command parameters needed to run a command for a device. The package is referenced during command updating. so parameters can be changed during command execution.

Member Function Documentation

◆ cloneFrom()

virtual void ControlAPI::DeviceCommandPackage::cloneFrom (DeviceCommandPackage * other)
 virtual

clone from another device package - should be implemented for custom types.

Parameters
other

Reimplemented in ControlAPI::MovementCommandPackage, ControlAPI::DMXDeviceCommand_RGBColor8Bit, ControlAPI::LiftingColumnCommandMovementPackage, ControlAPI::KinoFloDeviceCommand_RGBColor8Bit, ControlAPI::ThousliteCommand_SetLighting, and ControlAPI::LedLightBoxCommand_Lighting.

◆ prepareUpdatePackage()

virtual DeviceCommandPackage* ControlAPI::DeviceCommandPackage::prepareUpdatePackage ()
 virtual

Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered.

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