kfxKEDBarcodeResult.h

Go to the documentation of this file.

//  API Reference
//
//  kfxKEDBarcodeResult.h
//
//  KMCEngineData Objects
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//

#import <Foundation/Foundation.h>
#import "kfxKEDBoundingTetragon.h"

typedef enum barcode {
    BARCODE_UNKNOWN = 0,
    BARCODE_PDF417,
    BARCODE_CODE39,
    BARCODE_QR,
    BARCODE_DATAMATRIX,
    BARCODE_CODE128,
    BARCODE_CODE25,
    BARCODE_EAN,
    BARCODE_UPC,
    BARCODE_CODABAR,
    BARCODE_AZTEC,
    BARCODE_CODE93,
    BARCODE_POSTNET,
    BARCODE_ALL,
    BARCODE_END_OF_VALID_SETTINGS
} KEDBarcodeTypes;

typedef enum kedBarcodedirections {
    DIRECTION_UNKNOWN = 0,
    DIRECTION_LEFT_RIGHT,
    DIRECTION_TOP_DOWN,
    DIRECTION_RIGHT_LEFT,
    DIRECTION_BOTTOM_UP,
    DIRECTION_END_OF_VALID_SETTINGS
} KEDBarcodeDirections;

typedef enum dataFormat {
    FORMAT_UNKNOWN = 0,
    FORMAT_ASCII,
    FORMAT_BASE_64,
    FORMAT_END_OF_VALID_SETTINGS
} KEDBarcodeDataFormats;


@interface kfxKEDBarcodeResult : NSObject <NSCoding>

// =======================================

@property (assign, nonatomic) KEDBarcodeTypes type;

// =======================================

@property (strong, nonatomic) kfxKEDBoundingTetragon* boundingBox;

// =======================================

@property (assign, nonatomic) KEDBarcodeDataFormats dataFormat;

// =======================================

@property (strong, nonatomic) NSString* value; //Bar code value read

// =======================================

@property (assign, nonatomic) KEDBarcodeDirections direction;

// ==========================================================

+ (NSString*)decodeType:(KEDBarcodeTypes)type;

// ==========================================================

+ (NSString*)decodeDirection:(KEDBarcodeDirections)dir;

// ==========================================================

+ (NSString*)decodeDataFormat:(KEDBarcodeDataFormats)format;

@end