kfxKEDImage.h

Go to the documentation of this file.

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

#import <UIKit/UIKit.h>

#ifndef KFXKEDIMAGE
#define KFXKEDIMAGE 1

#import "kfxKEDImagePerfectionProfile.h"
#import "kfxKEDBasicSettingsProfile.h"
#import "kfxKEDQuickAnalysisFeedback.h"
#import "kfxKUTErrorInfo.h"



typedef enum kedImageRep {
    IMAGE_REP_NONE = 0,
    IMAGE_REP_BITMAP,
    IMAGE_REP_FILE,
    IMAGE_REP_BOTH,
    IMAGE_REP_LAST
} KEDImageRepresentation;


typedef enum kedImageMimetype{
    MIMETYPE_UNKNOWN = 0,
    MIMETYPE_JPG,
    MIMETYPE_PNG,
    MIMETYPE_TIF,
    MIMETYPE_LAST
} KEDImageMimeType;


typedef enum kedFileImageRep {
    FILE_REP_UNKNOWN,
    FILE_STORED,
    FILE_BUFFERED,
    FILE_REP_LAST
} KEDFileRepresentation;


typedef enum
{
    RESTRICTION_NONE,
    RESTRICTION_ANSI_X9
    
} FILE_RESTRICTION;


#define KMC_MIN_DPI   25
#define DEFAULT_ORIENTATION 0 // Right


@interface kfxKEDImage : NSObject <NSCoding>


// ==========================================================
//        R E A D _ O N L Y      P R O P E R T I E S
// ==========================================================

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

@property (readonly,atomic) NSString *imageID; //archived

#ifdef USE_MANAGER
// ==========================================================

@property (readonly,atomic) NSString *friendID;
#endif


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

@property (readonly,atomic) NSString *imageSourceID; // archived


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

@property (atomic, readonly) NSString *imageMetaData; // archived

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

@property (nonatomic, strong) NSString *imageMicrData; // archived


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

@property (atomic, readonly) float imageGPSLat;       // latitude archived

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

@property (atomic, readonly) float imageGPSLon;       // longitude archived


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

@property (atomic, readonly) kfxKEDBasicSettingsProfile *basicSettingsProfileUsed DEPRECATED_ATTRIBUTE;


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

@property (atomic, readonly) kfxKEDImagePerfectionProfile *imagePerfectionProfileUsed DEPRECATED_ATTRIBUTE;


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

@property (atomic, readonly) KEDImageRepresentation imageRepresentation; // archived


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

@property (atomic, readonly) KEDFileRepresentation fileRepresentation; //archived


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

@property (atomic, readonly) int imageFileBufferSize; // archived


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

@property (atomic, readonly) kfxKEDQuickAnalysisFeedback *imageQuickAnalysisFeedback; // archived


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

@property (atomic) int imageHeight; // archived


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

@property (atomic) int imageWidth; // archived


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

@property (readonly) float attitudePitch; // archived


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

@property (readonly) float attitudeRoll; // archived


// ==========================================================
//        W R I T E - R E A D      P R O P E R T I E S
// ==========================================================


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

@property (retain,atomic) NSString *imageTag; // archived


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

@property (assign, atomic) int imageDPI;    // archived


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

@property (assign, atomic) int jpegQuality; // archived


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

@property (assign, atomic) KEDOutputColor imageFileOutputColor; // archived


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

@property (strong,atomic) NSString *imageCreateDateTime; // archived


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

@property (assign, atomic) KEDImageMimeType imageMimeType; // archived


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

@property bool isPositionValid; // archived


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

@property (nonatomic, retain) NSMutableArray* imageBarCodes;            // array of BarCodeResults


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

@property (nonatomic, retain) NSMutableArray* classificationResults DEPRECATED_ATTRIBUTE;

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

@property bool isAttitudeValid; // archived


@property (nonatomic, assign) CGRect targetFrame;

// ==========================================================
//                       M E T H O D S
// ==========================================================

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

- (int) imageWriteToFile;


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

- (int) imageWriteToFile: (FILE_RESTRICTION) restriction;



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

- (int) imageWriteToFileBuffer;


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

- (int) imageWriteToFileBuffer : (FILE_RESTRICTION) restriction;


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

- (long) getImageSize;

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

- (int) imageReadFromFile;


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

- (int) imageReadFromFileBuffer;


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

- (int) deleteFile;


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

- (int) specifyImageBitmap: (UIImage*) image;


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

- (UIImage*) getImageBitmap;


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

- (int) clearImageBitmap;


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

 - (int) clearFileBuffer;


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

- (const char *) getImageFileBuffer;


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

- (bool) isValidDateTime;


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

- (int) specifyImageCreateDateAndtime: (NSString*) dateString;


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

- (int) specifyFilePath: (NSString*) fullFilePath;


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

- (NSString *) getFilePath;


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

- (NSString*) getImageSourceID;


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

- (NSString*) getImageID;
#ifdef USE_MANAGER
- (NSString*) getFriendID;
#endif


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

- (NSString*) getImageMetaData;


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

- (float)     getImageGPSLat;


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

- (float)     getImageGPSLon;


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

- (float)     getAttitudePitch;


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

- (float)     getAttitudeRoll;


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

- (kfxKEDQuickAnalysisFeedback *)  getImageQuickAnalysisFeedback;


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

- (kfxKEDBasicSettingsProfile *)   getBasicSettingsProfileUsed DEPRECATED_ATTRIBUTE;


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

- (kfxKEDImagePerfectionProfile *) getImagePerfectionProfileUsed DEPRECATED_ATTRIBUTE;


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

+(NSString*)simpleDateTimeString:(NSDate*)date;

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

+(NSDate*)dateFromSimpleDateString:(NSString*)s;

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

+(NSString*) ISO8601DateTime;


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

+(NSString *) decodeImageRep: (KEDImageRepresentation) option;


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

+(NSString *) decodeMimetype: (KEDImageMimeType) option;


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

+(NSString *) decodeFileColor: (KEDOutputColor) color;


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

- (id)init;


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

- (id)initWithImage:(UIImage*)image;

@end
#endif