Atalasoft MobileImage API Reference
Class Methods | Properties | List of all members
kfxKEDBarcodeResult Class Reference

A single barcode found data item. More...

#import <kfxKEDBarcodeResult.h>

Inheritance diagram for kfxKEDBarcodeResult:

Class Methods

(NSString *) + decodeType:
 Decode the barcode type into a string equivalent. More...
 
(NSString *) + decodeDirection:
 Decode the barcode direction into a string equivalent. More...
 
(NSString *) + decodeDataFormat:
 Decode the barcode data format into a string equivalent. More...
 

Properties

KEDBarcodeTypes type
 A single barcode type found. More...
 
kfxKEDBoundingTetragonboundingBox
 The barcode bounding tetragon. More...
 
KEDBarcodeDataFormats dataFormat
 The barcode data format. More...
 
NSString * value
 The barcode data. More...
 
KEDBarcodeDirections direction
 The direction for the found barcode. More...
 

Detailed Description

A single barcode found data item.

Framework: libKfxEngines
Import suggestion: #import <kfxLibEngines/kfxEngines.h>
An instance of this class contains one possible bar code result from the barcode reader. The result includes the barcode type found, the direction in which the barcode search found the barcode, the location within the image where the engine found the barcode, and the actual data read from the barcode. The results are encoded as normal ASCII text or base64 encoded. Base64 encoding is used for barcode data when the data includes non printable characters, or embedded null characters.

Serialization**

This class adopts the NSCoding protocol so that this object may be archived and unarchived using the iOS standard [NSKeyedArchiver archiveRootObject:<object> toFile: archiveFileName]; approach. Using keyed archive files, you can save this object for later use. The library supports backward compatibility, such that as a new version of an app that uses the API in this SDK, includes a newer versions of the SDK libraries that have data model changes, the older archive can still be read by the newer version. However, it is not a design goal to archive and dearchive with forward compatibility, such as decoding an archive on a newer version of the class, using an older library.

Refer to the kfxKEDImage class description, by expanding the class description, that describes how to archive and unarchive objects in this framework that adopt the NSCoding protocol.
You can create keyed archives using NSKeyedArchiver objects and decoded by NSKeyedUnarchiver objects. The framework design uses keyed archives, which differ from sequential archives, in that every value encoded in a keyed archive is given a Kofax unique key name. When you decode an archive, the underlying implementation can use values by name, allowing the unarchive delegate to request values in any order or not at all.
Please refer to the Apple documentation for more information: https://developer.apple.com/library/ios/documentation/cocoa/reference/foundation/Classes/NSCoder_Class/Reference/NSCoder.html

Keyed Archiving* https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedArchiver_Class/Reference/Reference.html#//apple_ref/occ/cl/NSKeyedArchiver

Keyed Unarchiving* https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedUnarchiver_Class/Reference/Reference.html#//apple_ref/occ/instm/NSKeyedUnarchiver

Method Documentation

+ (NSString*) decodeDataFormat: (KEDBarcodeDataFormats format

Decode the barcode data format into a string equivalent.

Use this class method to convert the actual barcode data format setting into a printable string equivalent.

Parameters
typeis an enum KEDBarcodeDataFormats setting that you want to evauluate.
Returns
A string representing the setting supplied.
+ (NSString*) decodeDirection: (KEDBarcodeDirections dir

Decode the barcode direction into a string equivalent.

Use this class method to convert the actual barcode direction setting into a printable string equivalent.

Parameters
typeis an enum KEDBarcodeDirections setting that you want to evauluate.
Returns
A string representing the setting supplied.
+ (NSString*) decodeType: (KEDBarcodeTypes type

Decode the barcode type into a string equivalent.

Use this class method to convert the actual barcode type setting into a printable string equivalent.

Parameters
typeis an enum KEDBarcodeType setting that you want to evauluate.
Returns
A string representing the setting supplied.

Property Documentation

- (kfxKEDBoundingTetragon*) boundingBox
readwritenonatomicstrong

The barcode bounding tetragon.

The barcode bounding tetragon area where the barcode reader found the barcode within the input image. The library uses tetragon instead of a simple rectangle because the barcode may be skewed in the original image.

A valid bounding box is not guaranteed to be provided with a barcode result. This depends on the SDK object that was used to provide ther result, and can further depend on the symbology matched and the parameters used to find the match. If there is no valid bounding box, this property will return nil instead.

In particular, results returned from the BarcodeCaptureControl only include bounding boxes for the 2D symbologies and PDF417.

Default: nil

- (KEDBarcodeDataFormats) dataFormat
readwritenonatomicassign

The barcode data format.

The actual barcode reader encodes the barcode data in this specified data format. The data will be encoded as base64 if the barcode data contained non-printable characters, or the actual ASCII data otherwise.

- (KEDBarcodeDirections) direction
readwritenonatomicassign

The direction for the found barcode.

The barcode reader found this barcode by reading it in the specified direction. Since barcodes can be sideways or upside down, this direction indicates the orientation of the barcode based on the original image.

- (KEDBarcodeTypes) type
readwritenonatomicassign

A single barcode type found.

The type of barcodefound, such as PDF417, Aztec or Code39. Default: BARCODE_UNKNOWN

- (NSString*) value
readwritenonatomicstrong

The barcode data.

The actual barcode data that the barcode reader decoded from the found barcode. The data will be encoded as base64 if the barcode data contained non-printable characters, or the actual ASCII data otherwise, as specified by the dataFormat property.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.