COcrParams_interface.h File Reference

Interface for COcrParams wrapper. More...

Go to the source code of this file.

Functions
enum RecognitionType	COcrParams_GetType (const COcrParams argCOcrParams, idrs_exception *pargException)
	GetType returns the recognition type.
enum ThreadingMode	COcrParams_GetThreadingMode (const COcrParams argCOcrParams, idrs_exception *pargException)
	Returns the threading mode that should be used for OCR process.
void	COcrParams_SetThreadingMode (COcrParams argCOcrParams, enum ThreadingMode const evThreadingMode, idrs_exception *pargException)
	Sets the threading mode to use for the OCR process.
OcrThreadingConfig	COcrParams_GetAdvancedThreadingConfig (const COcrParams argCOcrParams, idrs_exception *pargException)
	Gets the threading config used for the ocr process.
void	COcrParams_SetAdvancedThreadingConfig (COcrParams argCOcrParams, const OcrThreadingConfig *stThreadingConfig, idrs_exception *pargException)
	Sets the threading config used for the ocr process.
enum Workdepth	COcrParams_GetWorkdepth (const COcrParams argCOcrParams, idrs_exception *pargException)
	GetWorkdepth returns an indicator specifying how much time should the OCR process spend on recognition.
void	COcrParams_SetWorkdepth (COcrParams argCOcrParams, enum Workdepth const evWorkdepth, idrs_exception *pargException)
	SetWorkdepth sets the OCR work depth.

Detailed Description

Interface for COcrParams wrapper.

Function Documentation

COcrParams_GetAdvancedThreadingConfig()

OcrThreadingConfig COcrParams_GetAdvancedThreadingConfig	(	const COcrParams	argCOcrParams,
		idrs_exception *	pargException
	)

Gets the threading config used for the ocr process.

By default, the threading config is set to no multithreading

Returns

Threading config used for the ocr process

Parameters

argCOcrParams	COcrParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_GetThreadingMode()

enum ThreadingMode COcrParams_GetThreadingMode	(	const COcrParams	argCOcrParams,
		idrs_exception *	pargException
	)

Returns the threading mode that should be used for OCR process.

Please see

See also

ThreadingMode for details about the available threading modes.

Returns

The threading mode to be used

Remarks

Default value is set to ThreadingMode::None

Parameters

argCOcrParams	COcrParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_GetType()

enum RecognitionType COcrParams_GetType	(	const COcrParams	argCOcrParams,
		idrs_exception *	pargException
	)

GetType returns the recognition type.

This parameter is expected to be automatically set by the inheriting classes.

Returns

The recognition type used for this object

Parameters

argCOcrParams	COcrParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_GetWorkdepth()

enum Workdepth COcrParams_GetWorkdepth	(	const COcrParams	argCOcrParams,
		idrs_exception *	pargException
	)

GetWorkdepth returns an indicator specifying how much time should the OCR process spend on recognition.

Please see

See also

Workdepth for details about the available work modes.

Returns

Enumerable specifying the OCR work depth

Parameters

argCOcrParams	COcrParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_SetAdvancedThreadingConfig()

void COcrParams_SetAdvancedThreadingConfig	(	COcrParams	argCOcrParams,
		const OcrThreadingConfig *	stThreadingConfig,
		idrs_exception *	pargException
	)

Sets the threading config used for the ocr process.

Threading config can be altered directly by integrators, or set to recommended values via property ThreadingMode.

Parameters

argCOcrParams	COcrParams handle
stThreadingConfig	Threading config to set
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_SetThreadingMode()

void COcrParams_SetThreadingMode	(	COcrParams	argCOcrParams,
		enum ThreadingMode const	evThreadingMode,
		idrs_exception *	pargException
	)

Sets the threading mode to use for the OCR process.

Please see

See also

ThreadingMode for details about the available threading modes. Calling SetThreadingMode() will set the threading configuration with the default values associated with the mode chosen. This will invalidate any custom change made via property AdvancedThreadingConfig.

Parameters

argCOcrParams	COcrParams handle
evThreadingMode	The threading mode to be used
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrParams_SetWorkdepth()

void COcrParams_SetWorkdepth	(	COcrParams	argCOcrParams,
		enum Workdepth const	evWorkdepth,
		idrs_exception *	pargException
	)

SetWorkdepth sets the OCR work depth.

Please see

See also

Workdepth for details about the available work modes.

Parameters

argCOcrParams	COcrParams handle
evWorkdepth	Enumerable specifying the OCR work depth
pargException	Pointer to exception structure that will be filled if an exception occurs