rfid.api

Class Antennas

java.lang.Object

rfid.api.Antennas

public class Antennas
extends java.lang.Object

This class represents the Antenna of the reader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Antennas.AntennaProperties This class represents the antenna properties of the Reader
class	Antennas.AntennaRfConfig
class	Antennas.Config This class contains required information for configuring the antenna This class contains the information related to receiver sensitivity, transmit power and transmit frequency index.
class	Antennas.PhysicalProperties
class	Antennas.RFMode This class represents the C1G2 RF Mode and the Tari value to use for the inventory operation.
class	Antennas.SingulationControl This class represents the antenna configuration related to singulation control parameters session, Tag Population and the tag transit time

Constructor Summary

Constructors

Constructor and Description
Antennas(int hReaderHandle, int nNumAntenna, API3Abstract api3Abstract)

Method Summary

Modifier and Type	Method and Description
Antennas.AntennaProperties	AntennaProperties(int index) Gets the Antenna properties based on the index
Antennas.Config	getAntennaConfig(int antennaIndex) Gets ths Antenna Configuration
Antennas.AntennaRfConfig	getAntennaRfConfig(int antennaIndex) Gets the Antenna Rf Configuration
short[]	getAvailableAntennas() Gets the available antenna
int	getLength() Returns the number of antenna supported
Antennas.PhysicalProperties	getPhysicalProperties(int antennaIndex) Gets the Physical antenna properties This method gets the antenna physical properties such as whether antenna is enabled or not and the antenna gain
Antennas.RFMode	getRFMode(int antennaIndex) Gets the RF Mode to be used with the inventory operations
Antennas.SingulationControl	getSingulationControl(int antennaIndex) Gets the Singulation Control
void	setAntennaConfig(int antennaIndex, Antennas.Config antennaConfig) Sets the Antenna Configuration
void	setAntennaRfConfig(int antennaIndex, Antennas.AntennaRfConfig antennaRfConfig) Sets the Antenna Rf Configuration
void	setRFMode(int antennaIndex, Antennas.RFMode antennaRFMode) Sets the RF Mode to be used with the inventory operations
void	setSingulationControl(int antennaIndex, Antennas.SingulationControl antennaSingulationControl) Sets the Singulation Control

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Antennas

public Antennas(int hReaderHandle,
                int nNumAntenna,
                API3Abstract api3Abstract)

Method Detail

getLength

public int getLength()

Returns the number of antenna supported

Returns:

getPhysicalProperties

public Antennas.PhysicalProperties getPhysicalProperties(int antennaIndex)
                                                  throws InvalidUsageException,
                                                         OperationFailureException

Gets the Physical antenna properties This method gets the antenna physical properties such as whether antenna is enabled or not and the antenna gain

Parameters:

antennaIndex - Index of the antenna

Returns:

Throws:

InvalidUsageException

OperationFailureException - This exception is thrown when the parameters are invalid

getAntennaConfig

public Antennas.Config getAntennaConfig(int antennaIndex)
                                 throws InvalidUsageException,
                                        OperationFailureException

Gets ths Antenna Configuration

Parameters:

antennaIndex - Index of the antenna

Returns:

Throws:

InvalidUsageException

OperationFailureException - This exception is thrown when the parameter is invalid

setAntennaConfig

public void setAntennaConfig(int antennaIndex,
                             Antennas.Config antennaConfig)
                      throws InvalidUsageException,
                             OperationFailureException

Sets the Antenna Configuration

Parameters:

antennaIndex - Index of the antenna

antennaConfig -

Throws:

InvalidUsageException

OperationFailureException

getAntennaRfConfig

public Antennas.AntennaRfConfig getAntennaRfConfig(int antennaIndex)
                                            throws InvalidUsageException,
                                                   OperationFailureException

Gets the Antenna Rf Configuration

Parameters:

antennaIndex - Index of the antenna

Returns:

Throws:

InvalidUsageException

OperationFailureException - This exception is thrown when the parameter is invalid

setAntennaRfConfig

public void setAntennaRfConfig(int antennaIndex,
                               Antennas.AntennaRfConfig antennaRfConfig)
                        throws InvalidUsageException,
                               OperationFailureException

Sets the Antenna Rf Configuration

Parameters:

antennaIndex - Index of the antenna

antennaRfConfig -

Throws:

InvalidUsageException

OperationFailureException

getSingulationControl

public Antennas.SingulationControl getSingulationControl(int antennaIndex)
                                                  throws InvalidUsageException,
                                                         OperationFailureException

Gets the Singulation Control

Parameters:

antennaIndex - Index of the antenna

Returns:

SingulationControl Instance

Throws:

InvalidUsageException

OperationFailureException

setSingulationControl

public void setSingulationControl(int antennaIndex,
                                  Antennas.SingulationControl antennaSingulationControl)
                           throws InvalidUsageException,
                                  OperationFailureException

Sets the Singulation Control

Parameters:

antennaIndex - Index of the antenna

antennaSingulationControl -

Throws:

InvalidUsageException

OperationFailureException - This exception is thrown when the parameter is invalid

getRFMode

public Antennas.RFMode getRFMode(int antennaIndex)
                          throws InvalidUsageException,
                                 OperationFailureException

Gets the RF Mode to be used with the inventory operations

Parameters:

antennaIndex - Index of the antenna

Returns:

Throws:

InvalidUsageException

OperationFailureException

setRFMode

public void setRFMode(int antennaIndex,
                      Antennas.RFMode antennaRFMode)
               throws InvalidUsageException,
                      OperationFailureException

Sets the RF Mode to be used with the inventory operations

Parameters:

antennaIndex - Index of the antenna

antennaRFMode -

Throws:

InvalidUsageException

OperationFailureException

AntennaProperties

public Antennas.AntennaProperties AntennaProperties(int index)
                                             throws InvalidUsageException

Gets the Antenna properties based on the index

Parameters:

index - Specifies the antenna ID interested

Returns:

This method returns antenna properties object

Throws:

InvalidUsageException - Index out of range exception is thrown when index is out of antenna range

getAvailableAntennas

public short[] getAvailableAntennas()

Gets the available antenna