GrabbaBarcodeData Class Reference

Description

Class containing barcode data plus the associated symbology.

Note

All property values are passed by copy; a new copy of the value will be generated each time a property is read.

Thread safety:

• Concurrent accesses to distinct objects: safe
• Concurrent accesses to the same object: unsafe, unless all accesses are read-only (i.e. property reads)
• Static function calls: safe

Inheritance diagram for GrabbaBarcodeData:

Instance Methods
(instancetype _Nullable)	- init
	Initialise with empty data string and unknown symbology. More...
(instancetype _Nullable)	- initWithData:
	Initialise with given data and unknown symbology. More...
(instancetype _Nullable)	- initWithData:symbology:
	Initialise with given data and symbology ID. More...

Class Methods
(instancetype _Nullable)	+ barcodeData
	Allocate and initialise with empty data string and unknown symbology. More...
(instancetype _Nullable)	+ barcodeDataWithData:
	Allocate and initialise with given data and unknown symbology. More...
(instancetype _Nullable)	+ barcodeDataWithData:symbology:
	Allocate and initialise with given data and symbology ID. More...
(NSString *_Nonnull)	+ symbologyNameForID:
	Obtain a string representation of a given symbology name. More...

Properties
NSString *_Nonnull	barcode
	Contents of the barcode, represented as a string. More...
GrabbaBarcodeSymbology	symbologyID
	Symbology used by the barcode; will be set to GrabbaSymbologyUnknown if it is not yet known or could not be detected. More...
NSString *_Nonnull	symbologyName
	String representation of the symbology name. More...

Method Documentation

barcodeData()

+ (instancetype _Nullable) barcodeData

Allocate and initialise with empty data string and unknown symbology.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

barcodeDataWithData:()

+ (instancetype _Nullable) barcodeDataWithData:

(NSString *_Nonnull)

data

Allocate and initialise with given data and unknown symbology.

Parameters

data	Barcode data, used to populate the barcode property

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

barcodeDataWithData:symbology:()

+ (instancetype _Nullable) barcodeDataWithData:		(NSString *_Nonnull)	data
symbology:		(GrabbaBarcodeSymbology)	symbology

Allocate and initialise with given data and symbology ID.

Parameters

data	Barcode data, used to populate the barcode property
symbology	Barcode symbology, used to populate the symbologyID property

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

init()

- (instancetype _Nullable) init

Initialise with empty data string and unknown symbology.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

initWithData:()

- (instancetype _Nullable) initWithData:

(NSString *_Nonnull)

data

Initialise with given data and unknown symbology.

Parameters

data	Barcode data, used to populate the barcode property

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

initWithData:symbology:()

- (instancetype _Nullable) initWithData:		(NSString *_Nonnull)	data
symbology:		(GrabbaBarcodeSymbology)	symbology

Initialise with given data and symbology ID.

Parameters

data	Barcode data, used to populate the barcode property
symbology	Barcode symbology, used to populate the symbologyID property

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

symbologyNameForID:()

+ (NSString* _Nonnull) symbologyNameForID:

(GrabbaBarcodeSymbology)

symb

Obtain a string representation of a given symbology name.

Parameters

symb	Symbology ID for which the name is to be obtained

Returns

String representation of the given ID - a cleaned-up version of the enumerator identifier

Property Documentation

barcode

- (NSString* _Nonnull) barcode

readwritenonatomiccopy

Contents of the barcode, represented as a string.

symbologyID

- (GrabbaBarcodeSymbology) symbologyID

readwritenonatomicassign

Symbology used by the barcode; will be set to GrabbaSymbologyUnknown if it is not yet known or could not be detected.

symbologyName

- (NSString* _Nonnull) symbologyName

readnonatomiccopy

String representation of the symbology name.

This value is not directly writeable; updates should use symbologyID instead