ControlAPI::CommunicationCommandPackage Class Reference

Generic Command to communicate with a device. More...

Inheritance diagram for ControlAPI::CommunicationCommandPackage:

Public Attributes
std::vector< uint8_t >	outgoingBuffer

Public Attributes inherited from ControlAPI::DeviceCommandPackage
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

Additional Inherited Members
Public Member Functions inherited from ControlAPI::DeviceCommandPackage
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 inherited from ControlAPI::DeviceCommandPackage
static std::string	staticClassName ()

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

Generic Command to communicate with a device.

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