mv_result_store_def.h File Reference

Type definitions related to the result store. More...

Typedefs
typedef struct _MVResultList_t *	MVResultList_t
	Opaque data type which holds a list of results. More...
typedef struct _MVResult_t *	MVResult_t
	Opaque data type which holds a single result. More...
typedef struct _MVResultQuery_t *	MVResultQuery_t
	Opaque data type which holds a result query. More...

Detailed Description

Type definitions related to the result store.

Typedef Documentation

MVResult_t

typedef struct _MVResult_t* MVResult_t

Opaque data type which holds a single result.

MVResult_t is a pointer to an opaque data structure. It can be obtained through two ways:

• Calling MV_GetResultById() retrieves a single result from the vision system which needs to be destroyed by calling MV_Recipe_Clear().
• Calling MV_ResultList_Next() either directly or indirectly through the use of the MV_ResultList_foreach() macro merely provides non-owning references to the results contained in the list and calling MV_Result_Clear() on those is an error.

MVResultList_t

typedef struct _MVResultList_t* MVResultList_t

Opaque data type which holds a list of results.

MVResultList_t is a pointer to an opaque data structure. It is obtained through MV_GetResultListFiltered() and can be used to retrieve multiple results from the vision system's result store at once. Which results are included in the list is determined through the filter criteria defined by the MVResultQuery_t which was passed in, as well as by the capacity of the vision system's result store.

MVResultQuery_t

typedef struct _MVResultQuery_t* MVResultQuery_t

Opaque data type which holds a result query.

MVResultQuery_t is a pointer to an opaque data structure. It can be initialized by MV_ResultQuery_Init() and then needs to be destroyed by MV_ResultQuery_Clear(). Result queries are used to provide a description of one or more filtering criteria to a call of MV_GetResultListFiltered().