mv_tuple.h File Reference

API function definitions for manipulating tuples. More...

#include <mvtec/plugin/mv_decl.h>
#include <mvtec/plugin/mv_types.h>

Functions
MVLibExport MVCode_t	MV_Tuple_Init (size_t size, MVTuple_t *pTuple)
	Initializes a new tuple of a given size. More...
MVLibExport void	MV_Tuple_Clear (MVTuple_t *pTuple)
	Destroys the tuple. More...
MVLibExport size_t	MV_Tuple_GetSize (MVTuple_t tuple)
	Gets the size (i.e. number of elements) of a tuple. More...
MVLibExport MVCode_t	MV_Tuple_Set (MVTuple_t tuple, size_t index, MVValue_t value)
	Copies a value (scalar or array) into the element of a tuple. More...
MVLibExport MVCode_t	MV_Tuple_Get (MVTuple_t tuple, size_t index, MVValue_t *pValue)
	Initializes a new value with a copy of a tuple element. More...

Detailed Description

API function definitions for manipulating tuples.

Function Documentation

MV_Tuple_Clear()

MVLibExport void MV_Tuple_Clear

(

MVTuple_t *

pTuple

)

Destroys the tuple.

Every initialization of a tuple by MV_Tuple_Init() must be balanced by a call to MV_Tuple_Clear().

Parameters

[in,out]

pTuple

points to the handle of the tuple that is destroyed.

MV_Tuple_Get()

MVLibExport MVCode_t MV_Tuple_Get	(	MVTuple_t	tuple,
		size_t	index,
		MVValue_t *	pValue
	)

Initializes a new value with a copy of a tuple element.

Parameters

[in]	tuple	is the handle of the tuple whose element is copied.
[in]	index	is the index of the element that is copied.
[out]	pValue	points to the handle of the value that is initialized.

Returns

• MV_CODE_OK The value was successfully initialized with the tuple element at the specified @index.
• MV_CODE_INV_HANDLE Either tuple or pValue are NULL.
• MV_CODE_OUT_OF_RANGE The index is out of range.

MV_Tuple_GetSize()

MVLibExport size_t MV_Tuple_GetSize

(

MVTuple_t

tuple

)

Gets the size (i.e. number of elements) of a tuple.

Parameters

[in]

tuple

is the handle of the tuple that is queried.

Returns

The number of elements in the tuple.

MV_Tuple_Init()

MVLibExport MVCode_t MV_Tuple_Init	(	size_t	size,
		MVTuple_t *	pTuple
	)

Initializes a new tuple of a given size.

Parameters

[in]	size	is the number of individual values which are held by the new tuple.
[out]	pTuple	points to the handle of the tuple that is initialized.

Returns

• MV_CODE_OK The tuple was successfully initialized.
• MV_CODE_INV_HANDLE The pointer pTuple is NULL. Provide a pointer to a valid variable of type MVTuple_t which is to be initialized.
• MV_CODE_INV_VALUE The provided size is zero. Empty tuples must not be created.

MV_Tuple_Set()

MVLibExport MVCode_t MV_Tuple_Set	(	MVTuple_t	tuple,
		size_t	index,
		MVValue_t	value
	)

Copies a value (scalar or array) into the element of a tuple.

Parameters

[in]	tuple	is the handle of the tuple whose element is to be set.
[in]	index	is the index of the element that is set.
[in]	value	is the handle to the value that is copied.

Returns

• MV_CODE_OK The value was successfully copied into the tuple element at the specified @index.
• MV_CODE_INV_HANDLE Either tuple or value are NULL.
• MV_CODE_OUT_OF_RANGE The index is out of range.