Type definitions for data containers. More...

Typedefs
typedef enum MVDataContainerType_t	MVDataContainerType_t

typedef struct _MVDataContainer_t *	MVDataContainer_t
	Opaque data type which holds any number of data components. More...

typedef struct _MVDataContainerDescriptor_t *	MVDataContainerDescriptor_t
	Opaque data type which describes the contents of a data container. More...

Enumerations
enum	MVDataContainerType_t { eMVDataContainerType_Null = 0, eMVDataContainerType_Structured = 1 }
	Enumeration of the data component types. More...

Detailed Description

Type definitions for data containers.

Typedef Documentation

◆ MVDataContainer_t

typedef struct _MVDataContainer_t* MVDataContainer_t

Opaque data type which holds any number of data components.

MVDataContainer_t is a pointer to an opaque data structure. A data container comprises multiple data components which individually contain binary image data. MV_DataContainer_Next() can be used to iterate over these data components. See mv_data_component_def.h for information on the contained data components.

Data containers can be requested from the vision system by providing a data container descriptor to MV_FetchDataContainer(). They need to be freed after use by calling MV_DataContainer_Clear(). See mv_data_container.h for further details.

◆ MVDataContainerDescriptor_t

typedef struct _MVDataContainerDescriptor_t* MVDataContainerDescriptor_t

Opaque data type which describes the contents of a data container.

MVDataContainerDescriptor_t is a pointer to an opaque data structure. A data container comprises multiple data components; likewise a data container descriptor comprises multiple data component descriptors.

Data container descriptors serve a dual purpose:

When obtained through MV_Event_GetDataContainerDescriptor() or MV_Result_GetDataContainerDescriptor(), respectively, they provide information on the data components which are available as part of the associated result. The type and parameters of the contained data component descriptors reflect the "native" format, image size, etc., in which the data are present in the vision system.
A data container descriptor which is submitted to the vision system through MV_FetchDataContainer() acts as a request for a data container. To customize such a request, the type and parameters of the individual data component descriptors can be overwritten and component descriptors belonging to different results can be recombined into new data container descriptors.

An empty data container descriptor can be initialized by MV_DataContainerDescriptor_Init() or pre-filled data container descriptors can be obtained from results. In either case, they need to be freed by MV_DataContainerDescriptor_Clear(). See mv_data_container.h for further details.

Enumeration Type Documentation

◆ MVDataContainerType_t

enum MVDataContainerType_t

Enumeration of the data component types.

Enumeration of the data container types.

Presently, only one type of valid data containers is supported, the "structured" container. The data components contained in a structured data container can be accessed through the functions provided in mv_data_container.h. Additional types of data containers may be added in the future.

The data container type is not to be confused with the type of the data components. See mv_data_component_def.h for that.

Enumerator
eMVDataContainerType_Null	Placeholder for an invalid default data container type.
eMVDataContainerType_Structured	A structured data container holds any number of data components.