vftr_ef.h File Reference

Core feature-lib for electronic fence. More...

#include "mpi_base_types.h"
#include "mpi_iva.h"

Data Structures
struct	VFTR_EF_VL_ATTR_S
	Structure of virtual line parameters. More...
struct	VFTR_EF_VL_STAT_S
	Structure of virtual line status. More...
struct	VFTR_EF_PARAM_S
	Struct for electronic fence parameter. More...
struct	VFTR_EF_STATUS_S
	Struct for electronic fence status. More...
struct	VFTR_EF_INSTANCE_S
	Struct for electronic fence instance. More...

Macros
#define	VFTR_EF_MAX_FENCE_NUM   (16)
#define	VFTR_EF_VL_MIN_FENCE_ID   (1)
#define	VFTR_EF_VL_MAX_FENCE_ID   (VFTR_EF_MAX_FENCE_NUM)
#define	VFTR_EF_MAX_THR_V_OBJ   (255)
#define	VFTR_EF_MIN_THR_V_OBJ   (0)
#define	VFTR_EF_DIR_NUM   (2)
#define	VFTR_EF_MIN_OBJ_LIFE_TH   (0)
#define	VFTR_EF_MAX_OBJ_LIFE_TH   (MPI_IVA_OD_MAX_LIFE)

Typedefs
typedef UINT8	VFTR_EF_INSTANCE_SP_BF

Enumerations
enum	VFTR_EF_DIR_E { VFTR_EF_DIR_NONE = 0x0, VFTR_EF_DIR_POS = 0x1, VFTR_EF_DIR_NEG = 0x2, VFTR_EF_DIR_BOTH = 0x3 }
	Enumeration of fence direction. More...

Functions
VFTR_EF_INSTANCE_S *	VFTR_EF_newInstance ()
	Create electronic fence instance. More...
INT32	VFTR_EF_deleteInstance (VFTR_EF_INSTANCE_S **instance)
	Delete electronic fence instance. More...
INT32	VFTR_EF_setParam (VFTR_EF_INSTANCE_S *instance, const VFTR_EF_PARAM_S *param)
	Set electronic fence parameters. More...
INT32	VFTR_EF_checkParam (const VFTR_EF_PARAM_S *param, const MPI_SIZE_S *res)
	Check electronic fence parameters is valid or not. More...
INT32	VFTR_EF_getParam (const VFTR_EF_INSTANCE_S *instance, VFTR_EF_PARAM_S *param)
	Get electronic fence parameters. More...
INT32	VFTR_EF_detect (VFTR_EF_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_EF_STATUS_S *status)
	Detect electronic fence. More...
INT32	VFTR_EF_getStat (const VFTR_EF_INSTANCE_S *instance, VFTR_EF_STATUS_S *status)
	Get electronic fence detected result. More...

Detailed Description

Core feature-lib for electronic fence.

Macro Definition Documentation

#define VFTR_EF_DIR_NUM   (2)

Directions: positive and negative.

#define VFTR_EF_MAX_FENCE_NUM   (16)

< __cplusplus Max fence number.

Enumeration Type Documentation

enum VFTR_EF_DIR_E

Enumeration of fence direction.

Enumerator
VFTR_EF_DIR_NONE	no crossing
VFTR_EF_DIR_POS	only positive crossing
VFTR_EF_DIR_NEG	only negative crossing
VFTR_EF_DIR_BOTH	both direction of crossing

Function Documentation

INT32 VFTR_EF_checkParam	(	const VFTR_EF_PARAM_S *	param,
		const MPI_SIZE_S *	res
	)

Check electronic fence parameters is valid or not.

Parameters

[in]	param	Pointer to electronic fence parameters.
[in]	res	Pointer to mpi resolution.

Returns

The execution result.

Return values

0	success.
-EINVAL	electronic fence parameters is invalid.

See also

VFTR_EF_setParam()

VFTR_EF_getParam()

INT32 VFTR_EF_deleteInstance

(

VFTR_EF_INSTANCE_S **

instance

)

Delete electronic fence instance.

Parameters

[in]

instance

Pointer to pointer to electronic fence instance.

Returns

The execution result.

Return values

0	success.
-EFAULT	pointer of electronic fence instance is NULL.

See also

VFTR_EF_newInstance()

INT32 VFTR_EF_detect	(	VFTR_EF_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_EF_STATUS_S *	status
	)

Detect electronic fence.

Parameters

[in]	instance	Pointer to electronic fence instance.
[in]	obj_list	Pointer to object list.
[out]	status	Pointer to electronic fence detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

none

INT32 VFTR_EF_getParam	(	const VFTR_EF_INSTANCE_S *	instance,
		VFTR_EF_PARAM_S *	param
	)

Get electronic fence parameters.

Parameters

[in]	instance	Pointer to electronic fence instance.
[out]	param	Pointer to electronic fence parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_EF_setParam()

VFTR_EF_checkParam()

INT32 VFTR_EF_getStat	(	const VFTR_EF_INSTANCE_S *	instance,
		VFTR_EF_STATUS_S *	status
	)

Get electronic fence detected result.

Parameters

[in]	instance	Pointer to electronic fence instance.
[out]	status	Pointer to electronic fence detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

None.

VFTR_EF_INSTANCE_S* VFTR_EF_newInstance

(

)

Create electronic fence instance.

Returns

The pointer of electronic fence instance.

Return values

NULL	fail to create instance
Not NULL	success to create instance

See also

VFTR_EF_deleteInstance()

INT32 VFTR_EF_setParam	(	VFTR_EF_INSTANCE_S *	instance,
		const VFTR_EF_PARAM_S *	param
	)

Set electronic fence parameters.

Parameters

[in]	instance	Pointer to electronic fence instance.
[in]	param	Pointer to electronic fence parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_EF_checkParam()

VFTR_EF_getParam()