ControlAPI::MovementCommandPackage Class Reference

Generic Movement Command Supported on moving devices. More...

#include <HC_API.h>

Inheritance diagram for ControlAPI::MovementCommandPackage:

Public Types
enum	Units { Units_Millimeters, Units_Degrees }

Public Member Functions
virtual std::shared_ptr< DeviceCommandPackage >	createSharedPtr () override

virtual std::string	className () override

virtual void	cloneFrom (DeviceCommandPackage *other) override
	clone from another device package - should be implemented for custom types. More...

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

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

Public Attributes
float	disp_target = 0.0f
	Position Target ex: (Millimeters)

float	vel_target = 0.0f
	Vel Target ex: (Millimeters/S)

float	acc_target = 0.0f
	Acc Target ex: (Millimeters/S^2)

bool	disp_absolute = true
	whether position should be global to device or relative to starting position when command starts.

bool	trackDisp = true
	Enable Track Displacement Target.

bool	trackVel = true
	Track Velocity Target (if vel_target is non-zero)

bool	trackAcc = true
	Track Acceleration Target (if acc_target is non-zero)

Units	units
	units

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

Generic Movement Command Supported on moving devices.

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

overridevirtual

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

Parameters

other

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