Macro definitions for action and event parameters. More...

Macros
Plug-in configuration parameters
The parameter key in this section can be used with MV_PluginConfig_GetParameter().
#define	MV_PARAM_CONFIG_ACCESS_LEVEL 0x0000000A
	Plug-in instance access level (UInt32 scalar)

Action & event parameters
The parameter keys in this section can each be used with some of the following API functions. Check their respective documentations for details: MV_Action_SetParameter() MV_Action_Tuple_SetParameter() MV_ActionInfo_GetParameter() MV_Event_GetParameter() MV_Event_Tuple_GetParameter() MV_SystemStatus_GetParameter()
#define	MV_PARAM_JOB_ID 0x000003E9
	Job ID (UInt32 scalar)

#define	MV_PARAM_RECIPE_ID 0x000003EA
	Recipe ID (UInt32 scalar)

#define	MV_PARAM_ACTION_USER_ID 0x000003EB
	Action user ID (scalar of arbitrary data type)

#define	MV_PARAM_ACTION_ID 0x000003EC
	Action ID (UInt32 scalar)

#define	MV_PARAM_RESULT_ID 0x000003EE
	Result ID (UInt32 scalar)

#define	MV_PARAM_PLUGIN_ID 0x000003EF
	Plugin ID (UInt32 scalar)

#define	MV_PARAM_CONFIGURATION_ID 0x000003F0
	Reserved for future use.

#define	MV_PARAM_STATE 0x000003F1
	Bit mask representing the current state of the vision state machine (UInt32 scalar). More...

#define	MV_PARAM_IS_CONTINUOUS_JOB 0x000003F2
	Boolean indicating whether the associated job is a single job (false) or a continuous job (true).

#define	MV_PARAM_MEAS_ID 0x000003F3
	Measurement ID (String scalar) More...

#define	MV_PARAM_PART_ID 0x000003F4
	Part ID (String scalar) More...

#define	MV_PARAM_STATE_FROM_STATE 0x00000BB9
	Vision state of origin in a StateChanged event (UInt32 scalar). More...

#define	MV_PARAM_STATE_TO_STATE 0x00000BBA
	Destination vision state in a StateChanged event (UInt32 scalar). More...

#define	MV_PARAM_STATE_ACTION_CAUSE 0x00000BBB
	Action type of the action responsible for the state change (UInt32 scalar). More...

#define	MV_PARAM_START_PARAMS 0x00000FA1
	MVTuple_t whose entries correspond to the recipe's input parameters.

#define	MV_PARAM_MODE_TYPE 0x00001771
	Identifies a substate machine of the "Operational" state. More...

#define	MV_PARAM_ERROR_MESSAGE 0x00001B59
	Human-readable error message (String scalar)

#define	MV_PARAM_ERROR_CODE 0x00001B5A
	Error code (`MV_ERR_*`), see mv_error_def.h (UInt32 scalar)

#define	MV_PARAM_ERROR_CAUSE 0x00001B5B
	Action type of the action responsible for the error (UInt32 scalar). More...

Result parameters
The parameter keys in this section can each be used with some of the following API functions. Check their respective documentations for details: MV_Result_GetParameter() MV_Result_Tuple_GetParameter() MV_Event_GetParameter() MV_Event_Tuple_GetParameter()
#define	MV_PARAM_RESULT_CONTENT 0x000007D1
	MVTuple_t whose entries correspond to the recipe's output parameters.

#define	MV_PARAM_RESULT_TIMESTAMP 0x000007D2
	Creation time of the result, in ISO-8601 / RFC 3339 format (String scalar) More...

#define	MV_PARAM_RESULT_STATE 0x000007D3
	Numeric value according to MVResultState_t (UInt32 scalar)

#define	MV_PARAM_EXEC_START_TIMESTAMP 0x000007D4
	The time when the execution of the recipe which produced the result started (String scalar, ISO-8601 / RFC 3339) More...

#define	MV_PARAM_EXEC_END_TIMESTAMP 0x000007D5
	The time when the execution of the recipe which produced the result ended (String scalar, ISO-8601 / RFC 3339) More...

#define	MV_PARAM_ACQ_DURATION_MILLIS 0x000007D6
	The total duration of the image acquisition for the present execution in milliseconds (Double scalar) More...

#define	MV_PARAM_PROC_DURATION_MILLIS 0x000007D7
	The duration of the data processing to produce the result of the present execution in milliseconds (Double scalar) More...

Recipe parameters
The parameter keys in this section can be used with some of the following API functions. Check their respective documentations for details: MV_Recipe_GetParameter() MV_RecipeParam_GetParameter()
#define	MV_PARAM_RECIPE_IS_PREPARED 0x0000139C
	Indicates if a recipe is currently prepared (Bool scalar)

#define	MV_PARAM_RECIPE_DESCRIPTION 0x0000139D
	Description text associated with the recipe (String scalar)

#define	MV_PARAM_RECIPE_VERSION 0x0000139E
	Reserved for future use.

#define	MV_PARAM_RECIPE_ACQ_SEQ 0x0000139F
	Name of the acquisition sequence that is associated with the recipe (String scalar)

#define	MV_PARAM_RECIPEPARAM_NAME 0x000013A1
	Recipe parameter name (String scalar)

#define	MV_PARAM_RECIPEPARAM_DESCRIPTION 0x000013A2
	Recipe parameter description text (String scalar)

#define	MV_PARAM_RECIPEPARAM_DATATYPE 0x000013A3
	Recipe parameter data type (UInt32). More...

#define	MV_PARAM_RECIPEPARAM_VALUETYPE 0x000013A4
	Recipe parameter value type (UInt32). More...

Recipe list filtering
The parameter keys in this section can be used with MV_RecipeList_SetFilter().
#define	MV_FILTER_RECIPELIST_IS_PREPARED 0x00001389
	Only keep recipes which were prepared when the list was created.

#define	MV_FILTER_RECIPELIST_NOT_PREPARED 0x0000138A
	Only keep recipes which were NOT prepared when the list was created.

#define	MV_FILTER_RECIPELIST_RANGE_IDXS 0x0000138B
	Only keep recipes whose IDs lie in the specified range.

Data parameters
The parameter keys in this section can be used with some of the following API functions. Check their respective documentations for details: MV_DataInfo_GetParameter()
#define	MV_PARAM_DATAINFO_NAME 0x00001772
	Data name (String scalar)

#define	MV_PARAM_DATAINFO_DESCRIPTION 0x00001774
	Data description (String scalar)

Image property parameters
The parameter keys in this section can be used with some of the following API functions. Check their respective documentations for details: MV_DataComponentDescriptor_GetParameter() MV_DataComponentDescriptor_SetParameter()
#define	MV_PARAM_IMAGE_WIDTH 0x00017D8
	Image width (UInt64 scalar)

#define	MV_PARAM_IMAGE_HEIGHT 0x00017D9
	Image height (UInt64 scalar)

#define	MV_PARAM_IMAGE_PNG_COMPRESSION 0x00017DC
	PNG image compression level, an integer between 0 and 9 (UInt8 scalar).

#define	MV_PARAM_IMAGE_JPEG_PROGRESSIVE 0x00017DE
	JPEG image progressive flag (Bool scalar)

#define	MV_PARAM_IMAGE_JPEG_QUALITY 0x00017DF
	JPEG image quality percentage, an integer between 0 and 100 (UInt8 scalar).

Detailed Description

Macro definitions for action and event parameters.

Macro Definition Documentation

◆ MV_PARAM_ACQ_DURATION_MILLIS

#define MV_PARAM_ACQ_DURATION_MILLIS 0x000007D6

The total duration of the image acquisition for the present execution in milliseconds (Double scalar)

This parameter gives the duration of the acquisition phase of the present execution. This encompasses the (potentially parallel or repeated) acquisition from one or more image sources, according to the active configuration, including the time it takes to transfer the images from the camera as well as any waiting times incurred due to hardware-triggered cameras, delays, and synchronization between image sources as prescribed by the acquisition sequence.

In continuous executions, the images themselves may have already been captured prior to the start of the execution, potentially during a previous execution, depending on camera configuration. For this reason, the acquisition duration may be shorter than the actual time spent to capture the image, including the exposure time.

The duration is given in milliseconds with the fractional part indicating submillisecond resolution.

This parameter key can be used in conjunction with results and ResultReady events where it refers to the acquisition duration of the execution that produced the given result, as well as with AcquisitionDone events where it indicates the duration of the acquisition phase that just finished.

◆ MV_PARAM_ERROR_CAUSE

#define MV_PARAM_ERROR_CAUSE 0x00001B5B

Action type of the action responsible for the error (UInt32 scalar).

The numeric value corresponds to MVActionType_t.

◆ MV_PARAM_EXEC_END_TIMESTAMP

#define MV_PARAM_EXEC_END_TIMESTAMP 0x000007D5

The time when the execution of the recipe which produced the result ended (String scalar, ISO-8601 / RFC 3339)

This parameter gives a timestamp for the end of the execution which produced the present result in ISO-8601 / RFC 3339 format.

◆ MV_PARAM_EXEC_START_TIMESTAMP

#define MV_PARAM_EXEC_START_TIMESTAMP 0x000007D4

The time when the execution of the recipe which produced the result started (String scalar, ISO-8601 / RFC 3339)

Within each job, the vision system carries out either exactly one (SingleExecution) or arbitrarily many (ContinuousExecution) individual executions of the recipe, each acquiring images according to the active configuration and processing these to produce exactly one result per execution.

This parameter gives a timestamp for the beginning of the execution which produced the present result in ISO-8601 / RFC 3339 format.

In continuous executions, this marks a rather arbitrary time at which the vision system starts to wait for images to be transferred from the cameras' buffer; the images themselves may have already been captured prior to this point in time, potentially during a previous execution, depending on camera configuration.

◆ MV_PARAM_MEAS_ID

#define MV_PARAM_MEAS_ID 0x000003F3

Measurement ID (String scalar)

A measurement ID can be provided by a plug-in along with a StartSingleJob or StartContinuous action. Measurement IDs identify individual inspections, but are not guaranteed to be unique as they are provided by the caller. It is referenced in the resulting JobStarted and ResultReady events, as well as in results obtained through MV_GetResultById() and MV_GetResultListFiltered().

◆ MV_PARAM_MODE_TYPE

#define MV_PARAM_MODE_TYPE 0x00001771

Identifies a substate machine of the "Operational" state.

The numeric value corresponds to MVModeType_t.

◆ MV_PARAM_PART_ID

#define MV_PARAM_PART_ID 0x000003F4

Part ID (String scalar)

A part ID can be provided by a plug-in along with a StartSingleJob or StartContinuous action. Part IDs should identify the part that is being inspected; hence, when multiple inspections are carried out for the same part, they should share the same part ID but have different associated measurement IDs. The part ID is referenced in the resulting JobStarted and ResultReady events, as well as in results obtained through MV_GetResultById() and MV_GetResultListFiltered().

◆ MV_PARAM_PROC_DURATION_MILLIS

#define MV_PARAM_PROC_DURATION_MILLIS 0x000007D7

The duration of the data processing to produce the result of the present execution in milliseconds (Double scalar)

This parameter gives the duration of the processing phase which produced the present result. This encompasses the image processing according to the recipe, but it does not include the acquisition of the images from image sources according to the active configuration.

The duration is given in milliseconds with the fractional part indicating submillisecond resolution.

◆ MV_PARAM_RECIPEPARAM_DATATYPE

#define MV_PARAM_RECIPEPARAM_DATATYPE 0x000013A3

Recipe parameter data type (UInt32).

The numeric value corresponds to MVDataType_t.

◆ MV_PARAM_RECIPEPARAM_VALUETYPE

#define MV_PARAM_RECIPEPARAM_VALUETYPE 0x000013A4

Recipe parameter value type (UInt32).

The numeric value corresponds to MVValueType_t.

◆ MV_PARAM_RESULT_TIMESTAMP

#define MV_PARAM_RESULT_TIMESTAMP 0x000007D2

Creation time of the result, in ISO-8601 / RFC 3339 format (String scalar)

The concrete pattern used is "Y-m-dTH:M:S.F in strftime notation with the extension that F designates milliseconds with leading zeros. Timestamps are always given in the UTC time zone, independent of locale.

◆ MV_PARAM_STATE

#define MV_PARAM_STATE 0x000003F1

Bit mask representing the current state of the vision state machine (UInt32 scalar).

The numeric value corresponds to either the entries in the enum type MVVisionState_t, or the bitwise conjunction between eMVVisionState_Operational and any of the values in either MVAutomaticModeState_t or MVFrontendAccessModeState_t.

For example, the "Ready" state, a sub-state of "Operational", would be encoded as eMVVisionState_Operational | eMVAutomaticModeState_Ready, or 0x22.

◆ MV_PARAM_STATE_ACTION_CAUSE

#define MV_PARAM_STATE_ACTION_CAUSE 0x00000BBB

Action type of the action responsible for the state change (UInt32 scalar).