BXResult Class Reference

Interface that defines a result returned by the iOS Barcode Xpress SDK. More...

#import <BarcodeXpressIOS.h>

Inheritance diagram for BXResult:

Instance Methods
(void)	- getPoints::::
	Convenience routine to extract all four points of the rectangle that surrounds the location where the barcode was identified. More...

Properties
NSString *	m_value
	The decoded value of the recognized barcode, encoded as a string. More...
NSData *	m_valueData
	The decoded value of the recognized barcode, saved as raw bytes. More...
NSNumber *	m_valueLength
	The length, in bytes, of the decoded value raw data. More...
NSValue *	m_P1
	The upper-left coordinate of a rectangle surrounding the barcode where it was located in the image.
NSValue *	m_P2
	The upper-right coordinate of a rectangle surrounding the barcode where it was located in the image.
NSValue *	m_P3
	The lower-right coordinate of a rectangle surrounding the barcode where it was located in the image.
NSValue *	m_P4
	The lower-left coordinate of a rectangle surrounding the barcode where it was located in the image.
NSNumber *	m_decodingTime
	The time (in millseconds) spent in the library code while decoding an image. More...
NSNumber *	m_binarizationTime
	The time (in millseconds) spent in the library code while reducing the input image to a black/white 1 bit per pixel image. More...
NSNumber *	m_type
	The type of the recognized barcode.
NSNumber *	m_confidence
	The confidence (0..100) that the value is correct. More...
NSNumber *	m_status
	The status value returned by the recognition library. More...

Detailed Description

Interface that defines a result returned by the iOS Barcode Xpress SDK.

Defines a class that holds the results of image recognition and barcode decoding by the Accusoft Barcode Xpress Software Development Kit.

Method Documentation

- (void) :		(CGPoint*)	P1
:		(CGPoint*)	P2
:		(CGPoint*)	P3
:		(CGPoint*)	P4

Convenience routine to extract all four points of the rectangle that surrounds the location where the barcode was identified.

Convenience method to return the four points that define a rectangle inside the image that surround the location where this decoded barcode was found.

The values of each CGPoint will be set with values extracted from the NSValue* m_P1, m_P2, m_P3, m_P4 members of the BXResult.

Parameters

P1	Upper left coordinate
P2	Upper right coordinate
P3	Lower right coordinate
P4	Lower left coordinate
P1	Address of a CGPoint that will be set to the upper-left rectangle coordinate.
P2	Address of a CGPoint that will be set to the upper-right rectangle coordinate.
P3	Address of a CGPoint that will be set to the lower-right rectangle coordinate.
P4	Address of a CGPoint that will be set to the lower-left rectangle coordinate.

Property Documentation

- (NSNumber *) m_binarizationTime

readwritenonatomicstrong

The time (in millseconds) spent in the library code while reducing the input image to a black/white 1 bit per pixel image.

Will be zero unless the library was compiled in debug mode.

- (NSNumber *) m_confidence

readwritenonatomicstrong

The confidence (0..100) that the value is correct.

- (NSNumber *) m_decodingTime

readwritenonatomicstrong

The time (in millseconds) spent in the library code while decoding an image.

Will be zero unless the library was compiled in debug mode.

- (NSNumber *) m_status

readwritenonatomicstrong

The status value returned by the recognition library.

Anything other than StatusOK or StatusNoBarcodesFound denotes an error condition.

- (NSString *) m_value

readwritenonatomicstrong

The decoded value of the recognized barcode, encoded as a string.

The decoded value of the recognized barcode.

- (NSData *) m_valueData

readwritenonatomicstrong

The decoded value of the recognized barcode, saved as raw bytes.

- (NSNumber *) m_valueLength

readwritenonatomicstrong

The length, in bytes, of the decoded value raw data.

The length, in bytes, of the decoded value.