User's Manual

CAEN RFID API – Reference Manual
11
CAENRFID Classes
In .NET (henceforth C#), Java and Android languages, CAENRFID methods are divided into the following classes:
Class
Description
CAENRFIDEventArgs2
This class defines the CAENRFID event arguments.
CAENRFIDException
This class defines the CAEN RFID exceptions.
IDSTagData
This class represents data returned by tags based on IDS Chip
SL900A.
CAENRFIDLogicalSource
The CAENRFIDLogicalSource class is used to create logical source
objects. Logical source objects represent an aggregation of read
points (antennas). Operations on the tags are performed using the
logical source methods. In addition to the methods used to operate
on the tags, the logical source class exports methods to configure the
anticollision algorithm and to configure the composition of the
logical source itself.
CAENRFIDNotify
This class defines the structure of a notification message.
CAENRFIDReader
The CAENRFIDReader class is used to create reader objects which
permit to access to CAEN RFID readers' configuration and control
commands.
CAENRFIDReaderInfo
The CAENRFIDReaderInfo class is used to create reader info objects.
Reader info objects represent the information about the reader
device (model and serial number).
CAENRFIDTag
This class is used to define objects representing the tags. These
objects are used as return value for the inventory methods and as
arguments for many tag access methods.
Tab. 2.1: CAENRFID classes
Each class contains the following methods:
Methods
Description
CAENRFIDEventArgs Class
getData
Returns the event object value.
CAENRFIDException Class
getError
Gets the error string associated to the exception.
CAENRFID IDSTagData Class
getADError
Gets the error status of the A/D.
getRangeLimit
Gets the range limit parameter.
getSensorValue
Gets the value obtained by the sensor.
CAENRFIDLogicalSource Class
AddReadPoint
Adds a read point to the logical source.
BlockWriteTagData
Overloaded. This method can be used to write a portion of the user
memory in an ISO18000-6B tag using blocks of four bytes for each
command.
CustomCommand_EPC_C1G2
Overloaded. This method can be used to issue a generic Custom
command as defined by the EPC Class1 Gen2 protocol specification.
The parameters are used to specify the type of the custom command
and its parameters.
EventInventoryTag
A call to this method will start a sequence of read cycle on each read
point linked to the logical source. The readings will be notified to the
controller via event generation.
GetBufferedData
The function returns all the Tags stored in reader's memory using all
the ReadPoints belonging to the Source.
GetDESB_ISO180006B
This method can be used to retrieve the Data Exchange Status Bit
setting (see ISO18000-6B protocol specification) used by the
anticollision algorithm when called on this logical source.
GetName
Gets a string representing the name of the logical source.
GetQ_EPC_C1G2
This method can be used to retrieve the current setting for the initial Q
value (see EPC Class1 Gen2 protocol specification) used by the
anticollision algorithm when called on this logical source.
2
For the description of this class, see § Event Handling pag.107