Package com.zebra.rfid.api3
Class Antennas
- java.lang.Object
-
- com.zebra.rfid.api3.Antennas
-
public class Antennas extends java.lang.ObjectThis class represents the Antenna of the reader
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classAntennas.AntennaPropertiesThis class represents the antenna properties of the ReaderclassAntennas.AntennaRfConfigclassAntennas.ConfigOnly transmit power index support in Android RFID SDK This class contains required information for configuring the antenna This class contains the information related to receiver sensitivity, transmit power and transmit frequency index.classAntennas.PhysicalPropertiesclassAntennas.RFModeThis class represents the C1G2 RF Mode and the Tari value to use for the inventory operation.static classAntennas.SingulationControlThis class represents the antenna configuration related to singulation control parameters session, Tag Population and the tag transit time
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Antennas.AntennaPropertiesAntennaProperties(int index)Gets the Antenna properties based on the indexAntennas.ConfiggetAntennaConfig(int antennaIndex)Gets ths Antenna ConfigurationAntennas.AntennaRfConfiggetAntennaRfConfig(int antennaIndex)Gets the Antenna Rf Configurationshort[]getAvailableAntennas()Gets the available antennaintgetLength()Returns the number of antenna supportedAntennas.PhysicalPropertiesgetPhysicalProperties(int antennaIndex)Not supported in Android RFID SDK Gets the Physical antenna properties This method gets the antenna physical properties such as whether antenna is enabled or not and the antenna gainAntennas.RFModegetRFMode(int antennaIndex)Gets the RF Mode to be used with the inventory operationsAntennas.SingulationControlgetSingulationControl(int antennaIndex)Gets the Singulation ControlvoidsetAntennaConfig(int antennaIndex, Antennas.Config antennaConfig)Sets the Antenna ConfigurationvoidsetAntennaRfConfig(int antennaIndex, Antennas.AntennaRfConfig antennaRfConfig)Sets the Antenna Rf ConfigurationvoidsetRFMode(int antennaIndex, Antennas.RFMode antennaRFMode)Sets the RF Mode to be used with the inventory operationsvoidsetSingulationControl(int antennaIndex, Antennas.SingulationControl antennaSingulationControl)Sets the Singulation Control
-
-
-
Method Detail
-
getLength
public int getLength()
Returns the number of antenna supported- Returns:
- Returns the number of antenna supported
-
getPhysicalProperties
public Antennas.PhysicalProperties getPhysicalProperties(int antennaIndex) throws InvalidUsageException, OperationFailureException
Not supported in Android RFID SDK 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:
- Returns the Physical antenna properties
- Throws:
InvalidUsageExceptionOperationFailureException- 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:
- Returns ths Antenna Configuration
- Throws:
InvalidUsageExceptionOperationFailureException- This exception is thrown when the parameter is invalid
-
setAntennaConfig
public void setAntennaConfig(int antennaIndex, Antennas.Config antennaConfig) throws InvalidUsageException, OperationFailureExceptionSets the Antenna Configuration- Parameters:
antennaIndex- Index of the antennaantennaConfig-- Throws:
InvalidUsageExceptionOperationFailureException
-
getAntennaRfConfig
public Antennas.AntennaRfConfig getAntennaRfConfig(int antennaIndex) throws InvalidUsageException, OperationFailureException
Gets the Antenna Rf Configuration- Parameters:
antennaIndex- Index of the antenna- Returns:
- Throws:
InvalidUsageExceptionOperationFailureException- This exception is thrown when the parameter is invalid
-
setAntennaRfConfig
public void setAntennaRfConfig(int antennaIndex, Antennas.AntennaRfConfig antennaRfConfig) throws InvalidUsageException, OperationFailureExceptionSets the Antenna Rf Configuration- Parameters:
antennaIndex- Index of the antennaantennaRfConfig-- Throws:
InvalidUsageExceptionOperationFailureException
-
getSingulationControl
public Antennas.SingulationControl getSingulationControl(int antennaIndex) throws InvalidUsageException, OperationFailureException
Gets the Singulation Control- Parameters:
antennaIndex- Index of the antenna- Returns:
- SingulationControl Instance
- Throws:
InvalidUsageExceptionOperationFailureException
-
setSingulationControl
public void setSingulationControl(int antennaIndex, Antennas.SingulationControl antennaSingulationControl) throws InvalidUsageException, OperationFailureExceptionSets the Singulation Control- Parameters:
antennaIndex- Index of the antennaantennaSingulationControl-- Throws:
InvalidUsageExceptionOperationFailureException- 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:
InvalidUsageExceptionOperationFailureException
-
setRFMode
public void setRFMode(int antennaIndex, Antennas.RFMode antennaRFMode) throws InvalidUsageException, OperationFailureExceptionSets the RF Mode to be used with the inventory operations- Parameters:
antennaIndex- Index of the antennaantennaRFMode-- Throws:
InvalidUsageExceptionOperationFailureException
-
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
-
-