Type definitions for actions. More...

Typedefs
typedef enum MVActionType_t	MVActionType_t

typedef struct _MVAction_t *	MVAction_t
	Opaque data type which holds all information related to a single action. More...

typedef struct _MVActionInfo_t *	MVActionInfo_t
	Opaque type holding information on an action after it has been enqueued. More...

Enumerations
enum	MVActionType_t { eMVAction_Null = 0x00, eMVAction_SelectMode = 0x01, eMVAction_PrepareRecipe = 0x02, eMVAction_UnprepareRecipe = 0x03, eMVAction_StartSingleJob = 0x04, eMVAction_StartContinuous = 0x05, eMVAction_Halt = 0x06, eMVAction_Reset = 0x07, eMVAction_Stop = 0x08, eMVAction_Abort = 0x09 }
	Enumeration of the types of actions which may be enqueued by a plug-in. More...

Detailed Description

Type definitions for actions.

Action Reference Table

Action	Parameter	Parameter Type	Semantics
common	MV_PARAM_ACTION_USER_ID	Variant	user action ID
SelectMode	MV_PARAM_MODE_TYPE	UInt32	mode ID
PrepareRecipe	MV_PARAM_RECIPE_ID	String	recipe ID
UnprepareRecipe	MV_PARAM_RECIPE_ID	String
StartSingleJob	MV_PARAM_RECIPE_ID	String	recipe ID
	MV_PARAM_MEAS_ID	String	measurement ID
	MV_PARAM_PART_ID	String	part ID
	MV_PARAM_START_PARAMS	Tuple	misc.
StartContinuous	MV_PARAM_RECIPE_ID	String	recipe ID
	MV_PARAM_MEAS_ID	String	measurement ID
	MV_PARAM_PART_ID	String	part ID
	MV_PARAM_START_PARAMS	Tuple	misc.
Halt
Reset
Stop
Abort

Notation for column "Parameter Type":

Int32: parameter holds a scalar value of type eMVDataType_Int32
Variant: parameter holds a scalar value of arbitrary type
[Int32]: parameter holds an array value of (homogeneous) type eMVDataType_Int32
Tuple: parameter holds a tuple of values

Typedef Documentation

◆ MVAction_t

typedef struct _MVAction_t* MVAction_t

Opaque data type which holds all information related to a single action.

MVAction_t is a pointer to an opaque data structure. The data structure is initialized by MV_Action_Init() and manipulated by MV_Action_SetParameter(). Plug-ins with the "control" access level can construct actions which are enqueued to the vision system using either MV_QueueAction() or MV_QueueAction_WithInfo() which will also clear the memory occupied by the data structure.

◆ MVActionInfo_t

typedef struct _MVActionInfo_t* MVActionInfo_t

Opaque type holding information on an action after it has been enqueued.

When an action of type MVAction_t is enqueued to the vision system using MV_QueueAction_WithInfo(), it is assigned an identifier for the action itself, as well as a job which may result from executing the action. These identifiers are encapsulated by this data structure and may be accessed through MV_ActionInfo_GetParameter().

Enumeration Type Documentation

◆ MVActionType_t

enum MVActionType_t

Enumeration of the types of actions which may be enqueued by a plug-in.

See Available Actions for more information.

Enumerator
eMVAction_Null	Placeholder for an invalid default value.
eMVAction_SelectMode	SelectMode
eMVAction_PrepareRecipe	PrepareRecipe
eMVAction_UnprepareRecipe	UnprepareRecipe
eMVAction_StartSingleJob	StartSingleJob
eMVAction_StartContinuous	StartContinuous
eMVAction_Halt	Halt
eMVAction_Reset	Reset
eMVAction_Stop	Stop
eMVAction_Abort	Abort

Typedefs