GrabbaProxcardData Class Reference

Description

Proxcard data class - encapsulates a proximity/RFID card's type ID and data.

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)

Inheritance diagram for GrabbaProxcardData:

Instance Methods
(instancetype _Nullable)	- init
	Initialise a null (empty) proxcard data object. More...
(instancetype _Nullable)	- initWithType:contents:
	Initialise a proxcard data object with given contents and type ID. More...

Class Methods
(NSString *_Nonnull)	+ contentsStringForData:
	Generate a string representation of a given tag's contents. More...
(instancetype _Nullable)	+ proxcardData
	Allocate and initialise a null (empty) proxcard data object. More...
(instancetype _Nullable)	+ proxcardDataWithType:contents:
	Allocate and initialise a proxcard data object with given contents and type ID. More...
(NSString *_Nonnull)	+ typeStringForID:
	Generate the string representation of a given type ID. More...

Properties
NSData *_Nonnull	contents
	Contents of the card, typically a serial number or other unique identifier. More...
NSString *_Nonnull	contentsString
	String representation of the contents property. More...
GrabbaProxcardTypeID	type
	Type of the proxcard which was read. More...
NSString *_Nonnull	typeString
	String representation of the type name. More...

Method Documentation

contentsStringForData:()

+ (NSString* _Nonnull) contentsStringForData:

(NSData *_Nonnull)

data

Generate a string representation of a given tag's contents.

Tag-specific formatting may be supported in future; at present, the string is simply a hex dump of the tag contents.

Parameters

data

Tag data

Returns

String representation of the supplied tag contents

init()

- (instancetype _Nullable) init

Initialise a null (empty) proxcard data object.

Returns

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

initWithType:contents:()

- (instancetype _Nullable) initWithType:		(GrabbaProxcardTypeID)	type
contents:		(NSData *_Nonnull)	contents

Initialise a proxcard data object with given contents and type ID.

Parameters

type	Type of card which was read, defaulting to Unknown
contents	Contents of the card which was read, or empty NSData if no data was read

Returns

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

proxcardData()

+ (instancetype _Nullable) proxcardData

Allocate and initialise a null (empty) proxcard data object.

Returns

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

proxcardDataWithType:contents:()

+ (instancetype _Nullable) proxcardDataWithType:		(GrabbaProxcardTypeID)	type
contents:		(NSData *_Nonnull)	contents

Allocate and initialise a proxcard data object with given contents and type ID.

Parameters

type	Type of card which was read, defaulting to Unknown
contents	Contents of the card which was read, or empty NSData if no data was read

Returns

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

typeStringForID:()

+ (NSString* _Nonnull) typeStringForID:

(GrabbaProxcardTypeID)

ID

Generate the string representation of a given type ID.

Parameters

ID	Card type for which the string representation is to be generated

Returns

String containing the type ID; these are equivalent to cleaned-up versions of the enumerators in GrabbaProxcardTypeID. Defaults to "Unknown" if an invalid ID is supplied.

Property Documentation

contents

- (NSData* _Nonnull) contents

readwritenonatomiccopy

Contents of the card, typically a serial number or other unique identifier.

contentsString

- (NSString* _Nonnull) contentsString

readnonatomiccopy

String representation of the contents property.

Tag-specific formatting may be supported in future; at present, the string is simply a hex dump of the tag contents.

This value is not directly writeable; updates should use contents instead.

type

- (GrabbaProxcardTypeID) type

readwritenonatomicassign

Type of the proxcard which was read.

typeString

- (NSString* _Nonnull) typeString

readnonatomiccopy

String representation of the type name.

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