public class ATRfidUhfATM extends ATRfidUhf implements com.atid.lib.module.rfid.uhf.module.ATModuleRfidUhf.IModuleRfidUhfEventListener
Constructor and Description |
---|
ATRfidUhfATM(ModuleRfidUhfType type,
com.atid.lib.device.IReader reader)
Create an instance of the ATRfidUhfATM class.
|
Modifier and Type | Method and Description |
---|---|
void |
addEpcMask(EpcMaskParam param)
Add the EPC Mask of the RFID UHF module of the Device.
|
protected void |
assertAction() |
protected void |
assertModule() |
protected ResultCode |
checkError() |
void |
clearEpcMask()
Remove all EPC Mask items from the RFID UHF module of the device.
|
java.lang.String |
getAccessPassword()
When the RFID UHF module of the device communicates with the tag, it returns the Access Password to use.
|
AlgorithmType |
getAlgorithmType()
Returns the algorithm that the RFID UHF module of the appliance uses to perform the inventory.
|
boolean |
getContinuousMode()
Returns whether the RFID UHF module on the device will cause the Inventory to run continuously.
|
int |
getCurrentLinkProfile()
Returns the link profile of the RFID UHF module of the Device. ( Temporarily Type )
|
int |
getDefaultLinkProfile()
Returns the link profile of the RFID UHF module of the Device. ( Permanently Type )
The power of the device must be turned off and on.
|
EpcMaskParam |
getEpcMask(int index)
Returns the EPC Mask of the RFID UHF module of the Device.
|
int |
getEpcMaskCount()
Returns the number of EPC Mask items in the RFID UHF module of the device.
|
boolean |
getEpcMaskMatchMode()
Returns the method of comparing the EPC Mask items of the RFID UHF module of the Device.
|
FreqTableList |
getFreqTable()
The RFID UHF module of the Device returns the frequency table.
|
GlobalBandType |
getGlobalBand()
Returns the national orientation of the RFID UHF module of the instrument.
|
int |
getIdleTime()
The RFID UHF module of the instrument returns the time that the radio waves are not output in the Inventory operation and is resting.
|
int |
getInventoryTagType()
When the RFID UHF module of the device performs an inventory operation, it returns the type of Inventory tags.
|
int |
getInventoryTime()
Returns the time at which radio waves are actually output from the Inventory operation of the RFID UHF module in the instrument.
|
int |
getLimitTagCount()
When the RFID UHF module of the device performs an inventory operation, it returns the number of tags read as the stop condition of Inventory.
|
int |
getMaxQ()
If the algorithm of the RFID UHF module of the device uses Dynamic Q, it returns the maximum Q value.
|
int |
getMinQ()
If the algorithm of the RFID UHF module of the device uses Dynamic Q, it returns the minimum Q value.
|
int |
getOperationTime()
Returns the operating time of the RFID UHF module of the instrument.
|
int |
getPower()
Returns the antenna output of the RFID UHF module of the instrument.
|
PowerRange |
getPowerRange()
Returns the antenna output range of the RFID UHF module of the instrument.
|
int |
getReadTidLength()
Device returns the length of TID memory that can be read along with Tag value at Inventory for TID Inventory when TID Inventory function is supported.
|
boolean |
getReportMode()
Inventory the device as an RFID UHF module and return whether the tag read will send the same tag to the event only once or read each time it is read.
|
boolean |
getReportRssi()
Returns whether the RFID UHF module of the device will pass additional RSSI and Phase to the operation result.
|
int |
getSameTagReportTime()
When the RFID UHF module of the device performs an Inventory operation, it returns the time when the same tag is not recognized again.
|
SelectFlag |
getSelectFlag()
The RFID UHF module of the device returns the status of the Select Flag of the tag to be read by the Inventory operation.
|
SelectMask6cParam |
getSelectMask6c(int index)
Returns the Selection Mask item of the RFID UHF module of the Device.
|
Mask6cAction |
getSelectMask6cAction(int index)
Returns the comparison behavior of the Selection Mask item of the RFID UHF module of the Device.
|
BankType |
getSelectMask6cBank(int index)
The Selection Mask item of the Device's RFID UHF module returns the memory bank to compare.
|
boolean |
getSelectMask6cEnabled(int index)
Returns whether to use the Selection Mask item of the RFID UHF module of the Device.
|
int |
getSelectMask6cOffset(int index)
The Selection Mask item of the RFID UHF module of the Device returns the starting address of the memory to start the comparison.
|
Mask6cPattern |
getSelectMask6cPattern(int index)
Returns the comparison value and length of the Selection Mask item of the RFID UHF module of the Device.
|
Mask6cTarget |
getSelectMask6cTarget(int index)
Returns the Flag of the tag to store the comparison result of Selection Mask item of RFID UHF module of Device.
|
SessionFlag |
getSessionFlag()
The RFID UHF module of the device returns the status of the Session Flag of the tag to be read by the Inventory operation.
|
SessionTarget |
getSessionTarget()
The RFID UHF module of the device returns the Session Flag to check the state of the Session Flag of the tag to be read by the Inventory operation.
|
int |
getStartQ()
If the algorithm of the RFID UHF module of the device is using Dynamic Q, it returns the starting Q value.
|
java.lang.String |
getVersion()
Returns the version of the RFID UHF module.
|
boolean |
initMoudle()
After the Device is connected, it calls to instantiate the ATRfidUhf instance.
|
ResultCode |
inventory6b()
Device instructs to inventory the RFID UHF tag of ISO18000-6c Gen2 standard.
|
ResultCode |
inventory6c()
Device instructs to inventory the RFID UHF tag of ISO18000-6c Gen2 standard.
|
ResultCode |
kill6c(java.lang.String password)
Device instructs the RFID UHF tag of ISO18000-6c Gen2 specification to be no longer available.
|
ResultCode |
lock6b(com.atid.lib.module.rfid.uhf.params.Lock6bParam param,
java.lang.String password)
Instructs the Device to lock or unlock the RFID UHF tag of ISO18000-6b Gen2 specification.
|
ResultCode |
lock6c(Lock6cParam param,
java.lang.String password)
Instructs the Device to lock or unlock the RFID UHF tags of the ISO18000-6c Gen2 standard.
|
void |
onAccessResult(ResultCode code,
ActionType action,
java.lang.String epc,
java.lang.String data,
java.lang.Object params) |
void |
onPowerGainChanged(int power,
java.lang.Object params) |
void |
onReadTag(java.lang.String tag,
java.lang.Object params) |
ResultCode |
permaLock6c(PermaLock6cParam param,
java.lang.String password)
Device instructs the RFID UHF tag of ISO18000-6c Gen2 specification to perform a permanent lock.
|
ResultCode |
readMemory6b(int offset,
int length,
java.lang.String password)
Device instructs to read specific memory of RFID UHF tag of ISO18000-6b Gen2 standard.
|
ResultCode |
readMemory6c(BankType bank,
int offset,
int length,
java.lang.String password)
Device instructs to read specific memory of RFID UHF tag of ISO18000-6c Gen2 standard.
|
void |
setAccessPassword(java.lang.String password)
Set the Access Password to use when the RFID UHF module of the device communicates with the tag.
|
protected void |
setAction(ActionState action,
java.lang.String password) |
void |
setAlgorithmType(AlgorithmType type)
Sets the algorithm that the RFID UHF module of the appliance uses to perform the inventory.
|
void |
setContinuousMode(boolean enabled)
Sets whether or not the RFID UHF module of the device will run the Inventory continuously.
|
void |
setCurrentLinkProfile(int index)
Sets the link profile of the RFID UHF module of the Device. ( Temporarily Type )
|
void |
setDefaultLinkProfile(int index)
Sets the link profile of the RFID UHF module of the Device. ( Permanently Type )
The power of the device must be turned off and on.
|
void |
setEpcMaskMatchMode(boolean enabled)
Set the method of comparing EPC Mask items of the RFID UHF module of the device.
|
protected void |
setException(ATException e) |
void |
setFreqTable(FreqTableList table)
The RFID UHF module of the device sets up the frequency table.
|
void |
setGlobalBand(GlobalBandType band)
Set the national orientation of the RFID UHF module of the instrument.
|
void |
setIdleTime(int time)
The RFID UHF module of the instrument sets the time for which the radio waves are not output in the Inventory operation and the rest of the time.
|
ResultCode |
setInventoryTagType(int type)
When the RFID UHF module of the device performs the inventory operation, it sets the specified type of the tags Inventory.
|
void |
setInventoryTime(int time)
Sets the time at which radio waves are actually output in Inventory operation of the RFID UHF module of the instrument.
|
void |
setLimitTagCount(int count)
When the RFID UHF module of the device performs the inventory operation, it sets the number of tags read as the stop condition of Inventory.
|
void |
setMaxQ(int value)
If the algorithm of the RFID UHF module of the device uses Dynamic Q, set the maximum Q value.
|
void |
setMinQ(int value)
If the algorithm of the RFID UHF module of the device uses Dynamic Q, set the minimum Q value.
|
void |
setOperationTime(int time)
Set the operation time of the RFID UHF module of the device.
|
void |
setPower(int power)
Set the antenna output of the RFID UHF module of the instrument.
|
void |
setReadTidLength(int length)
If the TID Inventory function is supported by the device, set the TID memory length that can be read along with the Tag value at the time of Inventory for TID Inventory.
|
void |
setReportMode(boolean enabled)
Inventory the device as an RFID UHF module and set whether the read tag sends the same tag to the event only once or whenever it reads it.
|
void |
setReportRssi(boolean enabled)
Sets whether the RFID UHF module of the device will pass additional RSSI and Phase to the operation result.
|
com.atid.lib.protocol.Response |
setRfidCarrierWave(boolean enabled)
When the RFID UHF module of the device performs the inventory operation, it sets the specified type of the tags Inventory.
|
void |
setSameTagReportTime(int time)
When the RFID UHF module of the device performs an Inventory operation, set the time at which the same tag is not recognized again.
|
void |
setSelectFlag(SelectFlag flag)
The RFID UHF module of the device sets the status of the Select Flag of the tag to be read by the Inventory operation.
|
void |
setSelectMask6c(int index,
SelectMask6cParam param)
Set the Selection Mask item of the RFID UHF module of the Device.
|
void |
setSelectMask6cAction(int index,
Mask6cAction action)
Set the comparison behavior of the Selection Mask item of the RFID UHF module of the device.
|
void |
setSelectMask6cBank(int index,
BankType bank)
The Selection Mask item of the RFID UHF module of the device sets the memory bank to be compared.
|
void |
setSelectMask6cEnabled(int index,
boolean enabled)
Set whether or not to use the Selection Mask item of the RFID UHF module of the Device.
|
void |
setSelectMask6cOffset(int index,
int offset)
The Selection Mask item of the RFID UHF module of the device sets the start address of the memory to start the comparison.
|
void |
setSelectMask6cPattern(int index,
Mask6cPattern pattern)
Set the comparison value and length of the Selection Mask item of the RFID UHF module of the device.
|
void |
setSelectMask6cTarget(int index,
Mask6cTarget target)
Set the Flag of the tag to save the comparison result of Selection Mask item of the RFID UHF module of the device.
|
void |
setSessionFlag(SessionFlag flag)
Device's RFID UHF module sets the state of Session flag of tag to read by Inventory operation.
|
void |
setSessionTarget(SessionTarget target)
Device's RFID UHF module sets the Session Flag to check the status of the Session Flag of the tag to be read by Inventory operation.
|
void |
setStartQ(int value)
If the algorithm of the RFID UHF module of the device is using Dynamic Q, set the starting Q value.
|
ResultCode |
stop()
Instructs the Device to stop the operation being performed.
|
ResultCode |
writememory6b(int offet,
java.lang.String data,
java.lang.String password)
Device instructs to store data in a specific memory of RFID UHF tag of ISO18000-6b Gen2 standard.
|
ResultCode |
writeMemory6c(BankType bank,
int offset,
java.lang.String data,
java.lang.String password)
Device instructs to store data in a specific memory of RFID UHF tag of ISO18000-6c Gen2 standard.
|
addListener, clearListener, destroy, getType, PumpEvent, removeListener
public ATRfidUhfATM(ModuleRfidUhfType type, com.atid.lib.device.IReader reader)
type
- ModuleRfidUhfType enumeration indicating the type of RFID UHF module.reader
- ATRfidUhfATM An instance of the ATEAReader class that implements the IReader interface that owns the class.public boolean initMoudle()
ATRfidUhf
initMoudle
in class ATRfidUhf
public ResultCode inventory6c()
ATRfidUhf
inventory6c
in class ATRfidUhf
public ResultCode inventory6b()
ATRfidUhf
inventory6b
in class ATRfidUhf
public ResultCode readMemory6c(BankType bank, int offset, int length, java.lang.String password)
ATRfidUhf
readMemory6c
in class ATRfidUhf
bank
- The BankType enumeration that specifies the Bank for reading memory.offset
- An integer specifying the starting address to start reading from the specified bank. Unit is WORD unit.length
- An integer that specifies the length of data to read from the specified start address. Unit is WORD unit.password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode readMemory6b(int offset, int length, java.lang.String password)
ATRfidUhf
readMemory6b
in class ATRfidUhf
offset
- An integer specifying the starting address to start reading from the specified bank. Unit is WORD unit.length
- An integer that specifies the length of data to read from the specified start address. Unit is WORD unit.password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode writeMemory6c(BankType bank, int offset, java.lang.String data, java.lang.String password)
ATRfidUhf
writeMemory6c
in class ATRfidUhf
bank
- The BankType enumeration that specifies the Bank for reading memory.offset
- An integer specifying the starting address to start reading from the specified bank. Unit is WORD unit.data
- An Hex type string that specifies the data to be stored in memory from the specified start address. Data must be specified in WORD units (4 characters).password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode writememory6b(int offet, java.lang.String data, java.lang.String password)
ATRfidUhf
writememory6b
in class ATRfidUhf
offet
- An integer specifying the starting address to start reading from the specified bank. Unit is WORD unit.data
- An Hex type string that specifies the data to be stored in memory from the specified start address. Data must be specified in WORD units (4 characters).password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode lock6c(Lock6cParam param, java.lang.String password)
ATRfidUhf
lock6c
in class ATRfidUhf
param
- An instance of Lock6cParam that specifies the lock area of ​​the tag memory.password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode permaLock6c(PermaLock6cParam param, java.lang.String password)
ATRfidUhf
permaLock6c
in class ATRfidUhf
param
- An instance of PermaLock6cParam that specifies a permanent lock area for tag memory.password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode lock6b(com.atid.lib.module.rfid.uhf.params.Lock6bParam param, java.lang.String password)
ATRfidUhf
lock6b
in class ATRfidUhf
param
- An instance of Lock6bParam that specifies the lock area for the tag memory.password
- If the tag is locked, it is a hex string specifying the Access Password set in the tag. Up to 8 characters (2 words) can be input.public ResultCode kill6c(java.lang.String password)
ATRfidUhf
public ResultCode stop()
ATRfidUhf
public java.lang.String getVersion() throws ATException
ATRfidUhf
getVersion
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public PowerRange getPowerRange() throws ATException
ATRfidUhf
getPowerRange
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getPower() throws ATException
ATRfidUhf
getPower
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setPower(int power) throws ATException
ATRfidUhf
setPower
in class ATRfidUhf
power
- An integer specifying the antenna output of the RFID UHF module. The setting unit is dBm × 10.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public boolean getContinuousMode() throws ATException
ATRfidUhf
getContinuousMode
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setContinuousMode(boolean enabled) throws ATException
ATRfidUhf
setContinuousMode
in class ATRfidUhf
enabled
- A boolean specifying whether the RFID UHF module will continue to perform Inventory operations.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public java.lang.String getAccessPassword() throws ATException
ATRfidUhf
getAccessPassword
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setAccessPassword(java.lang.String password) throws ATException
ATRfidUhf
setAccessPassword
in class ATRfidUhf
password
- A string in hex format that specifies the Access Password. Access password can be up to 8 characters (2 words). If the length of the string is less than 8 characters, fill it with "0" to make the length of the string 8 characters.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public GlobalBandType getGlobalBand() throws ATException
ATRfidUhf
getGlobalBand
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setGlobalBand(GlobalBandType band) throws ATException
ATRfidUhf
setGlobalBand
in class ATRfidUhf
band
- GlobalBandType enumeration that represents the national orientation of the RFID UHF module.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public boolean getReportRssi() throws ATException
ATRfidUhf
getReportRssi
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setReportRssi(boolean enabled) throws ATException
ATRfidUhf
setReportRssi
in class ATRfidUhf
enabled
- A boolean specifying whether to pass additional RSSI and Phase to the result of the operation.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getOperationTime() throws ATException
ATRfidUhf
getOperationTime
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setOperationTime(int time) throws ATException
ATRfidUhf
setOperationTime
in class ATRfidUhf
time
- This is an integer specifying the operation time of the RFID UHF module. The unit of operation time is millisecond (ms).ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getInventoryTime() throws ATException
ATRfidUhf
getInventoryTime
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.
The Inventory Time and Idle Time set in the RFID UHF module can not exceed 400ms in total. ( FCC : 400 ms , ETSI : 4100 ms , JAPN : 4050 ms )
If Inventory Time is set to 300ms, Idle Time should be set to 100ms or less.
If both Inventory Time and Idle Time are set to 0, the RFID UHF module will operate at maximum performance.
If the RFID UHF module operates at maximum performance, it may cause module failure due to the heat of the RFID UHF module itself.
If the frequency of use of RFID UHF module is low, it may be designated as maximum performance.
However, if frequency of use is constant, it is recommended to set proper Inventory Time and Idle Time to adjust performance.public void setInventoryTime(int time) throws ATException
ATRfidUhf
setInventoryTime
in class ATRfidUhf
time
- An integer that specifies the Inventory time ( Tx On ) of the RFID UHF module. Inventory Time ( Tx On ) is in milliseconds (ms).ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getIdleTime() throws ATException
ATRfidUhf
getIdleTime
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setIdleTime(int time) throws ATException
ATRfidUhf
setIdleTime
in class ATRfidUhf
time
- An integer that specifies the Inventory idle time ( Tx Off ) for the RFID UHF module. Idle Time ( Tx Off ) is in milliseconds (ms).ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getLimitTagCount() throws ATException
ATRfidUhf
getLimitTagCount
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setLimitTagCount(int count) throws ATException
ATRfidUhf
setLimitTagCount
in class ATRfidUhf
count
- An integer that specifies the number of tags for which the RFID UHF module will stop Inventory.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getInventoryTagType() throws ATException
ATRfidUhf
getInventoryTagType
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public ResultCode setInventoryTagType(int type) throws ATException
ATRfidUhf
setInventoryTagType
in class ATRfidUhf
type
- An integer that specifies the number of tags for which the RFID UHF module will stop Inventory.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public com.atid.lib.protocol.Response setRfidCarrierWave(boolean enabled) throws ATException
ATRfidUhf
setRfidCarrierWave
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getSameTagReportTime() throws ATException
ATRfidUhf
getSameTagReportTime
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSameTagReportTime(int time) throws ATException
ATRfidUhf
setSameTagReportTime
in class ATRfidUhf
time
- This is an integer specifying the time to not recognize the same tag repeatedly. SameTagReportTime is in milliseconds (ms).ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public boolean getReportMode() throws ATException
ATRfidUhf
getReportMode
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setReportMode(boolean enabled) throws ATException
ATRfidUhf
setReportMode
in class ATRfidUhf
enabled
- A boolean specifying whether to fire the event once for the same data.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getReadTidLength() throws ATException
ATRfidUhf
getReadTidLength
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setReadTidLength(int length) throws ATException
ATRfidUhf
setReadTidLength
in class ATRfidUhf
length
- An integer indicating the length of the TID memory to read with Inventory. Readable length can be set in 2WORD units.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public AlgorithmType getAlgorithmType() throws ATException
ATRfidUhf
getAlgorithmType
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setAlgorithmType(AlgorithmType type) throws ATException
ATRfidUhf
setAlgorithmType
in class ATRfidUhf
type
- An AlgorithmType enumeration specifying the algorithm.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getStartQ() throws ATException
ATRfidUhf
getStartQ
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setStartQ(int value) throws ATException
ATRfidUhf
setStartQ
in class ATRfidUhf
value
- Dynamic Q An integer that specifies the starting Q value of the algorithm. The Q value range can be set from 1 to 15.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getMinQ() throws ATException
ATRfidUhf
getMinQ
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setMinQ(int value) throws ATException
ATRfidUhf
setMinQ
in class ATRfidUhf
value
- Dynamic type that specifies the minimum Q value of the Q algorithm. The Min Q value must be less than the Max Q value.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getMaxQ() throws ATException
ATRfidUhf
getMaxQ
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setMaxQ(int value) throws ATException
ATRfidUhf
setMaxQ
in class ATRfidUhf
value
- Dynamic type that specifies the maximum Q value of the Q algorithm. The Max Q value must be greater than the Min Q value.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public FreqTableList getFreqTable() throws ATException
ATRfidUhf
getFreqTable
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setFreqTable(FreqTableList table) throws ATException
ATRfidUhf
setFreqTable
in class ATRfidUhf
table
- An instance of FreqTableList that specifies the frequency table to use for the RFID UHF module. The FreqTableList instance must use the instance returned in getFreqTable.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public SelectFlag getSelectFlag() throws ATException
ATRfidUhf
getSelectFlag
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectFlag(SelectFlag flag) throws ATException
ATRfidUhf
setSelectFlag
in class ATRfidUhf
flag
- The SelectFlag enumeration type that specifies the state of the Select Flag of the tag that the RFID UHF module will read.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public SessionFlag getSessionFlag() throws ATException
ATRfidUhf
getSessionFlag
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSessionFlag(SessionFlag flag) throws ATException
ATRfidUhf
setSessionFlag
in class ATRfidUhf
flag
- The SessionFlag enumeration type that specifies the state of the Session Flag of the tag to be read by the RFID UHF module.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public SessionTarget getSessionTarget() throws ATException
ATRfidUhf
getSessionTarget
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSessionTarget(SessionTarget target) throws ATException
ATRfidUhf
setSessionTarget
in class ATRfidUhf
target
- The SessionTarget enumeration that specifies the Session Flag of the tag to read from the RFID UHF module.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public boolean getSelectMask6cEnabled(int index) throws ATException
ATRfidUhf
getSelectMask6cEnabled
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cEnabled(int index, boolean enabled) throws ATException
ATRfidUhf
setSelectMask6cEnabled
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.enabled
- Selection Mask A boolean specifying whether to apply the item.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public Mask6cTarget getSelectMask6cTarget(int index) throws ATException
ATRfidUhf
getSelectMask6cTarget
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cTarget(int index, Mask6cTarget target) throws ATException
ATRfidUhf
setSelectMask6cTarget
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.target
- The Mask6cTarget enumeration that specifies the Flag of the tag to store the result of the specified Selection Mask item comparison.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public Mask6cAction getSelectMask6cAction(int index) throws ATException
ATRfidUhf
getSelectMask6cAction
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cAction(int index, Mask6cAction action) throws ATException
ATRfidUhf
setSelectMask6cAction
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.action
- The Mask6cAction enumeration specifying how to compare the specified Selection Mask items.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public BankType getSelectMask6cBank(int index) throws ATException
ATRfidUhf
getSelectMask6cBank
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cBank(int index, BankType bank) throws ATException
ATRfidUhf
setSelectMask6cBank
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.bank
- The BankType enumeration that specifies the memory bank to be compared with the specified Selection Mask item. Reserved bank is not used.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getSelectMask6cOffset(int index) throws ATException
ATRfidUhf
getSelectMask6cOffset
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cOffset(int index, int offset) throws ATException
ATRfidUhf
setSelectMask6cOffset
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.offset
- An integer specifying the starting address at which the specified Selection Mask item will start the comparison. The unit specifying the start address of the Selection Mask is bit.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public Mask6cPattern getSelectMask6cPattern(int index) throws ATException
ATRfidUhf
getSelectMask6cPattern
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6cPattern(int index, Mask6cPattern pattern) throws ATException
ATRfidUhf
setSelectMask6cPattern
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.pattern
- An instance of Mask6cPattern specifying the comparison value and length of the specified Selection Mask item.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public SelectMask6cParam getSelectMask6c(int index) throws ATException
ATRfidUhf
getSelectMask6c
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setSelectMask6c(int index, SelectMask6cParam param) throws ATException
ATRfidUhf
setSelectMask6c
in class ATRfidUhf
index
- Selection Mask Integer specifying the radix of the item item. The Selection Mask has eight Selection Mask items from 0 to 7.param
- An instance of SelectMask6cParam that specifies the specified Selection Mask item.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getEpcMaskCount() throws ATException
ATRfidUhf
getEpcMaskCount
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public boolean getEpcMaskMatchMode() throws ATException
ATRfidUhf
getEpcMaskMatchMode
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setEpcMaskMatchMode(boolean enabled) throws ATException
ATRfidUhf
setEpcMaskMatchMode
in class ATRfidUhf
enabled
- EPC A boolean specifying whether the mask is masked if it does not match or masked if it does not.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void clearEpcMask() throws ATException
ATRfidUhf
clearEpcMask
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void addEpcMask(EpcMaskParam param) throws ATException
ATRfidUhf
addEpcMask
in class ATRfidUhf
param
- An instance of EpcMaskParam that specifies an EPC Mask item.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public EpcMaskParam getEpcMask(int index) throws ATException
ATRfidUhf
getEpcMask
in class ATRfidUhf
index
- EPC Mask Integer specifying the radix of the item.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getCurrentLinkProfile() throws ATException
ATRfidUhf
getCurrentLinkProfile
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setCurrentLinkProfile(int index) throws ATException
ATRfidUhf
setCurrentLinkProfile
in class ATRfidUhf
index
- This is an integer specifying the link profile of the RFID UHF module. The value range can be set from 0 to 3.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public int getDefaultLinkProfile() throws ATException
ATRfidUhf
getDefaultLinkProfile
in class ATRfidUhf
ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void setDefaultLinkProfile(int index) throws ATException
ATRfidUhf
setDefaultLinkProfile
in class ATRfidUhf
index
- This is an integer specifying the link profile of the RFID UHF module. The value range can be set from 0 to 3.ATException
- An ATException exception is thrown if a failure occurs while setting data on the instrument or returning data.public void onReadTag(java.lang.String tag, java.lang.Object params)
onReadTag
in interface com.atid.lib.module.rfid.uhf.module.ATModuleRfidUhf.IModuleRfidUhfEventListener
public void onAccessResult(ResultCode code, ActionType action, java.lang.String epc, java.lang.String data, java.lang.Object params)
onAccessResult
in interface com.atid.lib.module.rfid.uhf.module.ATModuleRfidUhf.IModuleRfidUhfEventListener
public void onPowerGainChanged(int power, java.lang.Object params)
onPowerGainChanged
in interface com.atid.lib.module.rfid.uhf.module.ATModuleRfidUhf.IModuleRfidUhfEventListener
protected void assertModule() throws ATException
ATException
protected void assertAction() throws ATException
ATException
protected void setAction(ActionState action, java.lang.String password) throws ATException
ATException
protected ResultCode checkError()
protected void setException(ATException e)