Cognex Mobile Barcode SDK SDK for supporting communication with Cognex Barcode Reader devices

CMBReadResult.h
Go to the documentation of this file.
1//
2// CMBReadResult.h
3// MX_SDK
4//
5// Created by Gyula Hatalyak on 12/01/17.
6// Copyright © 2017 Gyula Hatalyak. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <UIKit/UIKit.h>
11#import <cmbSDK/CMBSymbology.h>
12
16@interface CMBReadResult : NSObject
17
21@property (readonly) NSString *resultID;
22
27@property (readwrite) BOOL goodRead;
28
33@property (readwrite) NSString * readString;
34
38@property (readwrite) UIImage * image;
39
44@property (readwrite) NSData* imageGraphics;
45
50@property (readwrite) NSData * XML;
51
56@property (readwrite) CMBSymbology symbology;
57
63@property (readwrite) NSString * parsedText;
64
69@property (readwrite) NSString * parsedJSON;
70
75@property (readwrite) BOOL isGS1;
76
80@property (readwrite) NSDictionary<NSString*, NSString*> *resultExtra;
81
82@end
CMBSymbology
CMBSymbology
Enum values for supported barcode symbologies.
Definition: CMBSymbology.h:15
CMBReadResult
Represents a read result.
Definition: CMBReadResult.h:17
CMBReadResult::resultID
NSString * resultID
Returns the identfier for this result.
Definition: CMBReadResult.h:21
CMBReadResult::resultExtra
NSDictionary< NSString *, NSString * > * resultExtra
Dictionary containing extra information about the read result.
Definition: CMBReadResult.h:80
CMBReadResult::parsedJSON
NSString * parsedJSON
Get parsed result as JSON string when a CMBResultParser is enabled, containing general info about par...
Definition: CMBReadResult.h:69
CMBReadResult::readString
NSString * readString
Returns the read string, if available.
Definition: CMBReadResult.h:33
CMBReadResult::goodRead
BOOL goodRead
Success of the read.
Definition: CMBReadResult.h:27
CMBReadResult::parsedText
NSString * parsedText
Get parsed result in form of 'formatted text', mainly suited for demonstration purpose if the result ...
Definition: CMBReadResult.h:63
CMBReadResult::isGS1
BOOL isGS1
GS1 value of the result.
Definition: CMBReadResult.h:75
CMBReadResult::image
UIImage * image
Returns the image for this result.
Definition: CMBReadResult.h:38
CMBReadResult::symbology
CMBSymbology symbology
Returns the code symbology of the result.
Definition: CMBReadResult.h:56
CMBReadResult::XML
NSData * XML
Returns the subresult XML string for this result.
Definition: CMBReadResult.h:50
CMBReadResult::imageGraphics
NSData * imageGraphics
Returns the SVG XML as NSData for this result.
Definition: CMBReadResult.h:44