iDRS™ SDK 16
Loading...
Searching...
No Matches
CBarcode_interface.h
Go to the documentation of this file.
1
7#ifndef CBARCODE_INTERFACE_H
8
9#define CBARCODE_INTERFACE_H
10
11#include "CObjPtr_interface.h"
14#include "ArrayInterface.h"
15
16#include "idrs_common.h"
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
26CBarcode CBarcode_Create(idrs_exception *pargException);
27
39CBarcode CBarcode_Create2(const idrs_string strValue, IDRS_UINT const uiConfidence, enum BarcodeType const evBarcodeType, IDRS_UINT const uiOrientation, const IDRS_RECT* rcBoundingBox, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException);
40
48enum BarcodeType CBarcode_GetBarcodeType(const CBarcode argCBarcode, idrs_exception *pargException);
49
57const idrs_string CBarcode_GetValue(const CBarcode argCBarcode, idrs_exception *pargException);
58
66IDRS_UINT CBarcode_GetOrientation(const CBarcode argCBarcode, idrs_exception *pargException);
67
75IDRS_RECT CBarcode_GetBoundingBox(const CBarcode argCBarcode, idrs_exception *pargException);
76
86IDRS_UINT CBarcode_GetConfidence(const CBarcode argCBarcode, idrs_exception *pargException);
87
95enum BarcodeEngineIdentifier CBarcode_GetEngineIdentifier(const CBarcode argCBarcode, idrs_exception *pargException);
96
104void CBarcode_SetBarcodeType(CBarcode argCBarcode, const enum BarcodeType* const evBarcodeType, idrs_exception *pargException);
105
113void CBarcode_SetValue(CBarcode argCBarcode, const idrs_string strValue, idrs_exception *pargException);
114
122void CBarcode_SetOrientation(CBarcode argCBarcode, IDRS_UINT const uiOrientation, idrs_exception *pargException);
123
131void CBarcode_SetBoundingBox(CBarcode argCBarcode, const IDRS_RECT* rcBoundingBox, idrs_exception *pargException);
132
140void CBarcode_SetConfidence(CBarcode argCBarcode, IDRS_UINT const uiConfidence, idrs_exception *pargException);
141
149void CBarcode_SetEngineIdentifier(CBarcode argCBarcode, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException);
150
158void CBarcode_Destroy(CBarcode argCBarcode, idrs_exception *pargException);
159
168CBarcodeArray ArrayInterface_Create_CBarcodeArray(idrs_exception *pargException);
169
170#ifdef __cplusplus
171}
172#endif /* __cplusplus */
173
174#endif /* CBARCODE_INTERFACE_H */
Interface for TObjPtrArray wrapper.
Interface for BarcodeType wrapper.
BarcodeType
Barcode types recognized by iDRS SDK.
Definition BarcodeType_interface.h:20
IDRS_UINT CBarcode_GetOrientation(const CBarcode argCBarcode, idrs_exception *pargException)
GetOrientation retrieves the barcode orientation.
CBarcode CBarcode_Create2(const idrs_string strValue, IDRS_UINT const uiConfidence, enum BarcodeType const evBarcodeType, IDRS_UINT const uiOrientation, const IDRS_RECT *rcBoundingBox, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException)
Create a new instance and initializes the internal values with the provided values.
IDRS_UINT CBarcode_GetConfidence(const CBarcode argCBarcode, idrs_exception *pargException)
GetConfidence retrieves an indicator specifying how sure is the barcode engine about the detect barco...
void CBarcode_SetOrientation(CBarcode argCBarcode, IDRS_UINT const uiOrientation, idrs_exception *pargException)
Sets the barcode orientation.
void CBarcode_SetBarcodeType(CBarcode argCBarcode, const enum BarcodeType *const evBarcodeType, idrs_exception *pargException)
Sets the barcode type.
void CBarcode_SetBoundingBox(CBarcode argCBarcode, const IDRS_RECT *rcBoundingBox, idrs_exception *pargException)
Sets the bounding box where the barcode can be found.
IDRS_RECT CBarcode_GetBoundingBox(const CBarcode argCBarcode, idrs_exception *pargException)
GetBoundingBox retrieves the bounding box where the barcode can be found.
void CBarcode_SetConfidence(CBarcode argCBarcode, IDRS_UINT const uiConfidence, idrs_exception *pargException)
Sets an indicator specifying how sure is the barcode engine about the detect barcode value.
const idrs_string CBarcode_GetValue(const CBarcode argCBarcode, idrs_exception *pargException)
GetValue retrieves the barcode value.
CBarcodeArray ArrayInterface_Create_CBarcodeArray(idrs_exception *pargException)
Creates a new CBarcodeArray object.
enum BarcodeEngineIdentifier CBarcode_GetEngineIdentifier(const CBarcode argCBarcode, idrs_exception *pargException)
GetEngineIdentifier retrieves the identified of the barcode engine that detected the barcode.
enum BarcodeType CBarcode_GetBarcodeType(const CBarcode argCBarcode, idrs_exception *pargException)
GetBarcodeType retrieves the barcode type.
void CBarcode_SetEngineIdentifier(CBarcode argCBarcode, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException)
Sets the identifier of the barcode engine that detected the barcode.
CBarcode CBarcode_Create(idrs_exception *pargException)
Creates a new instance and initializes the internal values with default values.
void CBarcode_Destroy(CBarcode argCBarcode, idrs_exception *pargException)
Destroys a CBarcode handle.
void CBarcode_SetValue(CBarcode argCBarcode, const idrs_string strValue, idrs_exception *pargException)
Sets the barcode value.
Interface for CObjPtr wrapper.
Interface for EnumDefinitions wrapper.
BarcodeEngineIdentifier
Barcode engines that are shipped with iDRS SDK.
Definition EnumDefinitions_interface.h:3228
CBarcode contains the data associated with a barcode result.
Class that handles a string of characters.
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27
Structure that defines the upper-left and lower-right corners of a rectangle.
Definition idrsstd_interface.h:60