Octane SDK  2.0 Beta
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
Impinj.OctaneSdk.TagData Class Reference

Class used to hold tag data in the raw form in which it is stored on the tag (list of unsigned shorts). More...

Public Member Functions

string ToHexString ()
 Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with no spaces between each word. More...
 
string ToHexWordString ()
 Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with each word separated by a space. More...
 
List< ushort > ToList ()
 Conversion utility that outputs the data of the TagData object as a list. More...
 
override string ToString ()
 Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with each word separated by a space. More...
 
uint ToUnsignedInt ()
 Conversion utility that outputs the data of the TagData object as an unsigned int. This will only work for TagData objects that contain 1 or 2 16-bit words of data. More...
 

Static Public Member Functions

static TagData FromByteArray (byte[] data)
 Constructor that creates a TagData object populated with data from a byte array. More...
 
static TagData FromByteList (List< byte > data)
 Constructor that creates a TagData object populated with data from a list of bytes. More...
 
static TagData FromHexString (string hex)
 Constructor that creates a TagData object populated with data from a Hex string of arbitrary length. More...
 
static TagData FromUnsignedInt (uint data)
 Constructor that creates a TagData object populated with data from an unsigned int. More...
 
static TagData FromWord (ushort data)
 Constructor that creates a TagData object populated with data from a single 16-bit word More...
 
static TagData FromWordArray (ushort[] data)
 Constructor that creates a TagData object populated with data from an array of words More...
 
static TagData FromWordList (List< ushort > data)
 Constructor that creates a TagData object populated with data from a list of words (ushort). More...
 

Properties

int CountBytes [get]
 The size of the tag data, in bytes. More...
 

Detailed Description

Class used to hold tag data in the raw form in which it is stored on the tag (list of unsigned shorts).

Member Function Documentation

static TagData Impinj.OctaneSdk.TagData.FromByteArray ( byte[]  data)
static

Constructor that creates a TagData object populated with data from a byte array.

Parameters
dataPopulated byte array.
Returns
Populated TagData object
Exceptions
OctaneSdkExceptionThrown when a zero length or null byte array is provided.
static TagData Impinj.OctaneSdk.TagData.FromByteList ( List< byte >  data)
static

Constructor that creates a TagData object populated with data from a list of bytes.

Parameters
dataPopulated list of bytes.
Returns
Populated TagData object.
Exceptions
OctaneSdkExceptionThrown when a zero length or null list of bytes is provided.
static TagData Impinj.OctaneSdk.TagData.FromHexString ( string  hex)
static

Constructor that creates a TagData object populated with data from a Hex string of arbitrary length.

Parameters
hexHex number represented as a string.
Returns
Populated TagData object.
Exceptions
OctaneSdkExceptionThrown when a null or non-hex string is provided.
static TagData Impinj.OctaneSdk.TagData.FromUnsignedInt ( uint  data)
static

Constructor that creates a TagData object populated with data from an unsigned int.

Parameters
dataUnsigned int.
Returns
Populated TagData object.
static TagData Impinj.OctaneSdk.TagData.FromWord ( ushort  data)
static

Constructor that creates a TagData object populated with data from a single 16-bit word

Parameters
dataWord to add to the TagData object.
Returns
Populated TagData object.
Exceptions
OctaneSdkExceptionThrown when a null word is provided.
static TagData Impinj.OctaneSdk.TagData.FromWordArray ( ushort[]  data)
static

Constructor that creates a TagData object populated with data from an array of words

Parameters
dataPopulated array of words.
Returns
Populated TagData object.
Exceptions
OctaneSdkExceptionThrown when a null word array is provided.
static TagData Impinj.OctaneSdk.TagData.FromWordList ( List< ushort >  data)
static

Constructor that creates a TagData object populated with data from a list of words (ushort).

Parameters
dataPopulated list of words.
Returns
Populated TagData object
Exceptions
OctaneSdkExceptionThrown when a zero length or null word list is provided.
string Impinj.OctaneSdk.TagData.ToHexString ( )

Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with no spaces between each word.

Returns
Contents of TagData represented as a string.
string Impinj.OctaneSdk.TagData.ToHexWordString ( )

Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with each word separated by a space.

Returns
Contents of TagData represented as a string.
List<ushort> Impinj.OctaneSdk.TagData.ToList ( )

Conversion utility that outputs the data of the TagData object as a list.

Returns
Contents of TagData as a List of words (ushort).
override string Impinj.OctaneSdk.TagData.ToString ( )

Conversion utility that outputs the data of the TagData object as a string in hexadecimal format, with each word separated by a space.

Returns
Contents of TagData represented as a string.
uint Impinj.OctaneSdk.TagData.ToUnsignedInt ( )

Conversion utility that outputs the data of the TagData object as an unsigned int. This will only work for TagData objects that contain 1 or 2 16-bit words of data.

Returns
Up to 2 words of data as an unsigned int.
Exceptions
OctaneSdkExceptionThrown when the TagData object contains more than 32-bits of data.

Property Documentation

int Impinj.OctaneSdk.TagData.CountBytes
get

The size of the tag data, in bytes.