Kofax Mobile SDK API Reference
kfxKEDBarcodeResult.h
Go to the documentation of this file.
1 // API Reference
2 //
3 // kfxKEDBarcodeResult.h
4 //
5 // KMCEngineData Objects
6 //
7 // Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
8 //
9 
10 #import <Foundation/Foundation.h>
12 
14 typedef enum barcode {
31 
33 typedef enum kedBarcodedirections {
41 
43 typedef enum dataFormat {
49 
51 
70 @interface kfxKEDBarcodeResult : NSObject <NSCoding>
71 
72 // =======================================
74 
78 @property (assign, nonatomic) KEDBarcodeTypes type;
79 
80 // =======================================
82 
91 @property (strong, nonatomic) kfxKEDBoundingTetragon* boundingBox;
92 
93 // =======================================
95 
98 @property (assign, nonatomic) KEDBarcodeDataFormats dataFormat;
99 
100 // =======================================
102 
105 @property (strong, nonatomic) NSString* value; //Bar code value read
106 
107 // =======================================
109 
112 @property (assign, nonatomic) KEDBarcodeDirections direction;
113 
114 // ==========================================================
116 
121 + (NSString*)decodeType:(KEDBarcodeTypes)type;
122 
123 // ==========================================================
125 
130 + (NSString*)decodeDirection:(KEDBarcodeDirections)dir;
131 
132 // ==========================================================
134 
139 + (NSString*)decodeDataFormat:(KEDBarcodeDataFormats)format;
140 
141 @end
KEDBarcodeDirections
enum kedBarcodedirections KEDBarcodeDirections
Direction enum to define the search direction used to find the barcode.
BARCODE_UPC
Definition: kfxKEDBarcodeResult.h:23
BARCODE_CODE128
Definition: kfxKEDBarcodeResult.h:20
DIRECTION_END_OF_VALID_SETTINGS
Definition: kfxKEDBarcodeResult.h:39
DIRECTION_RIGHT_LEFT
Definition: kfxKEDBarcodeResult.h:37
DIRECTION_UNKNOWN
Definition: kfxKEDBarcodeResult.h:34
FORMAT_END_OF_VALID_SETTINGS
Definition: kfxKEDBarcodeResult.h:47
BARCODE_ALL
Definition: kfxKEDBarcodeResult.h:28
BARCODE_CODE39
Definition: kfxKEDBarcodeResult.h:17
DIRECTION_TOP_DOWN
Definition: kfxKEDBarcodeResult.h:36
barcode
barcode
Barcode enum to define barcode types to find, or those found.
Definition: kfxKEDBarcodeResult.h:14
BARCODE_QR
Definition: kfxKEDBarcodeResult.h:18
BARCODE_AZTEC
Definition: kfxKEDBarcodeResult.h:25
KEDBarcodeTypes
enum barcode KEDBarcodeTypes
Barcode enum to define barcode types to find, or those found.
BARCODE_CODABAR
Definition: kfxKEDBarcodeResult.h:24
FORMAT_UNKNOWN
Definition: kfxKEDBarcodeResult.h:44
kfxKEDBarcodeResult
A single barcode found data item.
Definition: kfxKEDBarcodeResult.h:70
BARCODE_DATAMATRIX
Definition: kfxKEDBarcodeResult.h:19
DIRECTION_LEFT_RIGHT
Definition: kfxKEDBarcodeResult.h:35
BARCODE_POSTNET
Definition: kfxKEDBarcodeResult.h:27
BARCODE_CODE93
Definition: kfxKEDBarcodeResult.h:26
dataFormat
dataFormat
Data format enum to define the type of data encoding used for the value found.
Definition: kfxKEDBarcodeResult.h:43
kfxKEDBarcodeResult::value
NSString * value
The barcode data.
Definition: kfxKEDBarcodeResult.h:105
kfxKEDBoundingTetragon
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
DIRECTION_BOTTOM_UP
Definition: kfxKEDBarcodeResult.h:38
kfxKEDBarcodeResult::type
KEDBarcodeTypes type
A single barcode type found.
Definition: kfxKEDBarcodeResult.h:78
kfxKEDBoundingTetragon.h
FORMAT_BASE_64
Definition: kfxKEDBarcodeResult.h:46
BARCODE_CODE25
Definition: kfxKEDBarcodeResult.h:21
KEDBarcodeDataFormats
enum dataFormat KEDBarcodeDataFormats
Data format enum to define the type of data encoding used for the value found.
kedBarcodedirections
kedBarcodedirections
Direction enum to define the search direction used to find the barcode.
Definition: kfxKEDBarcodeResult.h:33
BARCODE_END_OF_VALID_SETTINGS
Definition: kfxKEDBarcodeResult.h:29
kfxKEDBarcodeResult::boundingBox
kfxKEDBoundingTetragon * boundingBox
The barcode bounding tetragon.
Definition: kfxKEDBarcodeResult.h:91
FORMAT_ASCII
Definition: kfxKEDBarcodeResult.h:45
BARCODE_EAN
Definition: kfxKEDBarcodeResult.h:22
kfxKEDBarcodeResult::direction
KEDBarcodeDirections direction
The direction for the found barcode.
Definition: kfxKEDBarcodeResult.h:112
BARCODE_UNKNOWN
Definition: kfxKEDBarcodeResult.h:15
BARCODE_PDF417
Definition: kfxKEDBarcodeResult.h:16
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.