CBarcodeEngineConfig_interface.h File Reference

Interface for CBarcodeEngineConfig wrapper. More...

Go to the source code of this file.

Functions
CBarcodeEngineConfig	CBarcodeEngineConfig_Create (const IBarcodeEngine pBarcodeEngine, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
IBarcodeEngine	CBarcodeEngineConfig_GetBarcodeEngine (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the associated barcode engine.
IDRS_BOOL	CBarcodeEngineConfig_GetEnabled (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the flag that specifies if the associated barcode engine is enabled or not.
void	CBarcodeEngineConfig_SetEnabled (CBarcodeEngineConfig argCBarcodeEngineConfig, IDRS_BOOL const bEnabled, idrs_exception *pargException)
	Sets the flag that specifies if the associated barcode engine is enabled or not.
enum Workdepth	CBarcodeEngineConfig_GetWorkdepthRangeMinimum (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the minimum value of the workdepth range where the associated barcode engine will run.
void	CBarcodeEngineConfig_SetWorkdepthRangeMinimum (CBarcodeEngineConfig argCBarcodeEngineConfig, enum Workdepth const evWorkdepth, idrs_exception *pargException)
	Sets the minimum value of the workdepth range where the associated barcode engine will run.
enum Workdepth	CBarcodeEngineConfig_GetWorkdepthRangeMaximum (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the maximum value of the workdepth range where the associated barcode engine will run.
void	CBarcodeEngineConfig_SetWorkdepthRangeMaximum (CBarcodeEngineConfig argCBarcodeEngineConfig, enum Workdepth const evWorkdepth, idrs_exception *pargException)
	Sets the maximum value of the workdepth range where the associated barcode engine will run.
IDRS_UINT	CBarcodeEngineConfig_GetTimeout (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the time interval in milliseconds after which the associated barcode engine will stop barcode detection.
void	CBarcodeEngineConfig_SetTimeout (CBarcodeEngineConfig argCBarcodeEngineConfig, IDRS_UINT const uiTimeout, idrs_exception *pargException)
	Sets the time interval in milliseconds after which the associated barcode engine will stop barcode detection.
CBarcodeValidationCriteriaArray	CBarcodeEngineConfig_GetValidationCriteria (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the array of barcode validations that will be used when running the associated barcode engine.
void	CBarcodeEngineConfig_SetValidationCriteria (CBarcodeEngineConfig argCBarcodeEngineConfig, const CBarcodeValidationCriteriaArray xValidationCriterias, idrs_exception *pargException)
	Sets the array of barcode validations that will be used when running the associated barcode engine.
CBarcodeEnginePreprocessArray	CBarcodeEngineConfig_GetPreprocessOperations (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the array of preprocessing operations that will be applied to the input image before the barcode detection process.
void	CBarcodeEngineConfig_SetPreprocessOperations (CBarcodeEngineConfig argCBarcodeEngineConfig, const CBarcodeEnginePreprocessArray xPreprocessOperations, idrs_exception *pargException)
	Sets the array of preprocessing operations that will be applied to the input image before the barcode detection process.
CBarcodeEnginePostprocessArray	CBarcodeEngineConfig_GetPostprocessOperations (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the array of postprocessing operations that will be applied to the barcode results obtained during the barcode detection process.
void	CBarcodeEngineConfig_SetPostprocessOperations (CBarcodeEngineConfig argCBarcodeEngineConfig, const CBarcodeEnginePostprocessArray xPostprocessOperations, idrs_exception *pargException)
	Sets the array of postprocessing operations that will be applied to the barcode results obtained during the barcode detection process.
CBarcodeSpecificOptionsArray	CBarcodeEngineConfig_GetSpecificOptions (const CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Gets the array of barcode specific options.
void	CBarcodeEngineConfig_SetSpecificOptions (CBarcodeEngineConfig argCBarcodeEngineConfig, const CBarcodeSpecificOptionsArray xSpecificOptions, idrs_exception *pargException)
	Sets the array of barcode specific options.
void	CBarcodeEngineConfig_Destroy (CBarcodeEngineConfig argCBarcodeEngineConfig, idrs_exception *pargException)
	Destroys a CBarcodeEngineConfig handle.
CBarcodeEngineConfigArray	ArrayInterface_Create_CBarcodeEngineConfigArray (idrs_exception *pargException)
	Creates a new CBarcodeEngineConfigArray object.

Detailed Description

Interface for CBarcodeEngineConfig wrapper.

Function Documentation

ArrayInterface_Create_CBarcodeEngineConfigArray()

CBarcodeEngineConfigArray ArrayInterface_Create_CBarcodeEngineConfigArray

(

idrs_exception *

pargException

)

Creates a new CBarcodeEngineConfigArray object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CBarcodeEngineConfigArray

CBarcodeEngineConfig_Create()

CBarcodeEngineConfig CBarcodeEngineConfig_Create	(	const IBarcodeEngine	pBarcodeEngine,
		idrs_exception *	pargException
	)

Creates a new instance of this class and associates the provided.

See also

IBarcodeEngine to it.

Parameters

pBarcodeEngine

Instance of a barcode engine that will be used with the current

See also

CBarcodeEngineConfig.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_Destroy()

void CBarcodeEngineConfig_Destroy	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Destroys a CBarcodeEngineConfig handle.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetBarcodeEngine()

IBarcodeEngine CBarcodeEngineConfig_GetBarcodeEngine	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the associated barcode engine.

Returns

Associated barcode engine

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetEnabled()

IDRS_BOOL CBarcodeEngineConfig_GetEnabled	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the flag that specifies if the associated barcode engine is enabled or not.

If this flag is set to IDRS_FALSE, the associated barcode engine will not be used during barcode detection

Returns

Boolean flag indicating whether the barcode engine should be used or not.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetPostprocessOperations()

CBarcodeEnginePostprocessArray CBarcodeEngineConfig_GetPostprocessOperations	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the array of postprocessing operations that will be applied to the barcode results obtained during the barcode detection process.

The postprocessing operations will be applied to all results of barcode detection.

The postprocessing operations will be applied in the order they appear in the

See also

CBarcodeEnginePreprocessArray

Returns

Array containing the postprocessing operations

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetPreprocessOperations()

CBarcodeEnginePreprocessArray CBarcodeEngineConfig_GetPreprocessOperations	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the array of preprocessing operations that will be applied to the input image before the barcode detection process.

The preprocessing operations will be applied on a copy of the input image. The original image will remain unchanged, while the associated barcode engine will receive a cloned image, on which all the preprocessing oprations are applied.

The preprocessing operations will be applied in the order they appear in the

See also

CBarcodeEnginePreprocessArray

Returns

Array containing the preprocessing operations

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetSpecificOptions()

CBarcodeSpecificOptionsArray CBarcodeEngineConfig_GetSpecificOptions	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the array of barcode specific options.

Returns

Array containing the barcode specific options

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetTimeout()

IDRS_UINT CBarcodeEngineConfig_GetTimeout	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the time interval in milliseconds after which the associated barcode engine will stop barcode detection.

The default timeout value is set to 5000 milliseconds.

Returns

Time interval in milliseconds that the associated barcode engine will run barcode detection.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetValidationCriteria()

CBarcodeValidationCriteriaArray CBarcodeEngineConfig_GetValidationCriteria	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the array of barcode validations that will be used when running the associated barcode engine.

Returns

Array containing the validation criteria for the associated barcode engine

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetWorkdepthRangeMaximum()

enum Workdepth CBarcodeEngineConfig_GetWorkdepthRangeMaximum	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the maximum value of the workdepth range where the associated barcode engine will run.

When the barcode detection process is executed, this value will be checked against the Workdepth value in

See also

CBarcodeParams. If the Workdepth value defined in

CBarcodeParams is greater or equal than Workdepth minimum range and smaller or equal than the workdepth maximum range, then the barcode engine will be used during the barcode detection process.

Returns

Maximum workdepth value for which the associated barcode engine will be run

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_GetWorkdepthRangeMinimum()

enum Workdepth CBarcodeEngineConfig_GetWorkdepthRangeMinimum	(	const CBarcodeEngineConfig	argCBarcodeEngineConfig,
		idrs_exception *	pargException
	)

Gets the minimum value of the workdepth range where the associated barcode engine will run.

When the barcode detection process is executed, this value will be checked against the Workdepth value in

See also

CBarcodeParams. If the Workdepth value defined in

CBarcodeParams is greater or equal than Workdepth minimum range and smaller or equal than the workdepth maximum range, then the barcode engine will be used during the barcode detection process.

Returns

Minimum workdepth value for which the associated barcode engine will be run

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetEnabled()

void CBarcodeEngineConfig_SetEnabled	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		IDRS_BOOL const	bEnabled,
		idrs_exception *	pargException
	)

Sets the flag that specifies if the associated barcode engine is enabled or not.

If this flag is set to IDRS_TRUE, the associated barcode engine will be used during barcode detection with the settings defined in this class. If this flag is set to IDRS_FALSE, the associated barcode engine will not be used during barcode detection

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
bEnabled	Boolean flag indicating whether the barcode engine should be used or not.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetPostprocessOperations()

void CBarcodeEngineConfig_SetPostprocessOperations	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		const CBarcodeEnginePostprocessArray	xPostprocessOperations,
		idrs_exception *	pargException
	)

Sets the array of postprocessing operations that will be applied to the barcode results obtained during the barcode detection process.

The postprocessing operations will be applied to all results of barcode detection.

The postprocessing operations will be applied in the order they appear in the

See also

CBarcodeEnginePreprocessArray

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
xPostprocessOperations	Array containing the postprocessing operations
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetPreprocessOperations()

void CBarcodeEngineConfig_SetPreprocessOperations	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		const CBarcodeEnginePreprocessArray	xPreprocessOperations,
		idrs_exception *	pargException
	)

Sets the array of preprocessing operations that will be applied to the input image before the barcode detection process.

The preprocessing operations will be applied on a copy of the input image. The original image will remain unchanged, while the associated barcode engine will receive a cloned image, on which all the preprocessing oprations are applied.

The preprocessing operations will be applied in the order they appear in the

See also

CBarcodeEnginePreprocessArray

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
xPreprocessOperations	Array containing the preprocessing operations
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetSpecificOptions()

void CBarcodeEngineConfig_SetSpecificOptions	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		const CBarcodeSpecificOptionsArray	xSpecificOptions,
		idrs_exception *	pargException
	)

Sets the array of barcode specific options.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
xSpecificOptions	Array containing the barcode specific options
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetTimeout()

void CBarcodeEngineConfig_SetTimeout	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		IDRS_UINT const	uiTimeout,
		idrs_exception *	pargException
	)

Sets the time interval in milliseconds after which the associated barcode engine will stop barcode detection.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
uiTimeout	Time interval in milliseconds that the associated barcode engine will run barcode detection.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetValidationCriteria()

void CBarcodeEngineConfig_SetValidationCriteria	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		const CBarcodeValidationCriteriaArray	xValidationCriterias,
		idrs_exception *	pargException
	)

Sets the array of barcode validations that will be used when running the associated barcode engine.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
xValidationCriterias	Array containing the validation criteria for the associated barcode engine
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetWorkdepthRangeMaximum()

void CBarcodeEngineConfig_SetWorkdepthRangeMaximum	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		enum Workdepth const	evWorkdepth,
		idrs_exception *	pargException
	)

Sets the maximum value of the workdepth range where the associated barcode engine will run.

When the barcode detection process is executed, this value will be checked against the Workdepth value in

See also

CBarcodeParams. If the Workdepth value defined in

CBarcodeParams is greater or equal than Workdepth minimum range and smaller or equal than the workdepth maximum range, then the barcode engine will be used during the barcode detection process.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
evWorkdepth	Maximum workdepth value for which the associated barcode engine will be run
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeEngineConfig_SetWorkdepthRangeMinimum()

void CBarcodeEngineConfig_SetWorkdepthRangeMinimum	(	CBarcodeEngineConfig	argCBarcodeEngineConfig,
		enum Workdepth const	evWorkdepth,
		idrs_exception *	pargException
	)

Sets the minimum value of the workdepth range where the associated barcode engine will run.

When the barcode detection process is executed, this value will be checked against the Workdepth value in

See also

CBarcodeParams. If the Workdepth value defined in

CBarcodeParams is greater or equal than Workdepth minimum range and smaller or equal than the workdepth maximum range, then the barcode engine will be used during the barcode detection process.

Parameters

argCBarcodeEngineConfig	CBarcodeEngineConfig handle
evWorkdepth	Minimum workdepth value for which the associated barcode engine will be run
pargException	Pointer to exception structure that will be filled if an exception occurs