public class FindTagCommand extends AsciiSelfResponderCommandBase implements IAntennaParameters, ICommandParameters, IResponseParameters, ISelectMaskParameters, ITransponderReceivedDelegate
LibraryCommandId
Constructor and Description |
---|
FindTagCommand()
Initializes a new instance of the BlockPermalockTransponderCommand class
|
Modifier and Type | Method and Description |
---|---|
protected void |
buildCommandLine(java.lang.StringBuilder line)
Builds the command line to send to the reader to execute the command
|
void |
clearLastResponse()
Clears the response ready to receive a new one
|
TriState |
getIncludeDateTime()
Gets or sets a value indicating whether DateTime stamps appear in reader responses
|
TriState |
getIncludeEpc() |
TriState |
getIncludeTransponderRssi() |
TriState |
getIncludeTransponderRssiPercent() |
TriState |
getMatchExact() |
int |
getOutputPower()
Gets or sets the output power.
|
TriState |
getReadParameters()
Gets or sets a value indicating whether the command should include a list of supported parameters and their current values
|
TriState |
getResetParameters()
Gets or sets a value indicating whether the command should reset all its parameters to default values
|
Databank |
getSelectBank()
Gets or sets the Bank to use for the select mask
|
java.lang.String |
getSelectData()
Gets or sets the select mask data in 2 character ASCII Hex pairs padded to ensure full bytes
|
int |
getSelectLength()
Gets or sets the length in bits of the select mask
|
int |
getSelectOffset()
Gets or sets the number of bits from the start of the block to the start of the select mask
|
int |
getSoundPercentageThresholdOne() |
int |
getSoundPercentageThresholdThree() |
int |
getSoundPercentageThresholdTwo() |
TriState |
getTakeNoAction()
Gets or sets a value indicating whether the command primary action should not be performed
(e.g.
|
ITransponderReceivedDelegate |
getTransponderReceivedDelegate() |
StartStop |
getTriggerOverride() |
TriState |
getUseAlert()
Gets or sets a value indicating whether alerts are enabled for the executing commands
|
TriState |
getUseVariableToneFrequency() |
TriState |
getUseVisualFeedback() |
VolumeLevel |
getVolumeLevel() |
boolean |
implementsReadParameters()
Gets a value indicating whether the implementing command uses the ReadParameters property
|
boolean |
implementsResetParameters()
Gets a value indicating whether the implementing command uses the ResetParameters property
|
boolean |
implementsTakeNoAction()
Gets a value indicating whether the implementing command uses the TakeNoAction property
|
protected boolean |
processReceivedLine(java.lang.String fullLine,
java.lang.String header,
java.lang.String value,
boolean moreAvailable)
Each correctly terminated line from the device is passed to this method for processing
|
protected void |
responseDidFinish(boolean async)
The is called when the responder received a line with an OK: or an ER: header.
|
protected boolean |
responseDidReceiveParameter(java.lang.String parameter)
This method is called for each parameter in the parameters (PR:) list.
|
void |
setIncludeDateTime(TriState value) |
void |
setIncludeEpc(TriState value) |
void |
setIncludeTransponderRssi(TriState value) |
void |
setIncludeTransponderRssiPercent(TriState value) |
void |
setMatchExact(TriState value) |
void |
setOutputPower(int value) |
void |
setReadParameters(TriState value) |
void |
setResetParameters(TriState value) |
void |
setSelectBank(Databank value) |
void |
setSelectData(java.lang.String value) |
void |
setSelectLength(int value) |
void |
setSelectOffset(int value) |
void |
setSoundPercentageThresholdOne(int value) |
void |
setSoundPercentageThresholdThree(int value) |
void |
setSoundPercentageThresholdTwo(int value) |
void |
setTakeNoAction(TriState value) |
void |
setTransponderReceivedDelegate(ITransponderReceivedDelegate listener) |
void |
setTriggerOverride(StartStop value) |
void |
setUseAlert(TriState value) |
void |
setUseVariableToneFrequency(TriState value) |
void |
setUseVisualFeedback(TriState value) |
void |
setVolumeLevel(VolumeLevel value) |
static FindTagCommand |
synchronousCommand()
Returns a new instance of the command class that will execute synchronously (as its own responder)
|
void |
transponderReceived(TransponderData transponder,
boolean moreAvailable)
Called for each transponder received in the response
Note: Invoked on a non-UI thread
|
getMaxSynchronousWaitTime, getSynchronousCommandResponder, setMaxSynchronousWaitTime, setSynchronousCommandResponder
captureNonLibraryResponses, setCaptureNonLibraryResponses
getCommandLine, getCommandName, getResponseLifecycleDelegate, getResponseStarted, isResponseFinished, parseParameters, processReceivedLine, responseDidStart, setCommandName, setResponseLifecycleDelegate, setResponseStarted, splitParameters
appendToMessages, appendToParameters, appendToResponse, getErrorCode, getMessages, getParameters, getResponse, isSuccessful, setErrorCode, setIsSuccessful, setResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCommandLine, getCommandName
public FindTagCommand()
public final boolean implementsReadParameters()
implementsReadParameters
in interface ICommandParameters
public final boolean implementsResetParameters()
implementsResetParameters
in interface ICommandParameters
public final boolean implementsTakeNoAction()
implementsTakeNoAction
in interface ICommandParameters
public final TriState getReadParameters()
ICommandParameters
getReadParameters
in interface ICommandParameters
public final void setReadParameters(TriState value)
setReadParameters
in interface ICommandParameters
public final TriState getResetParameters()
ICommandParameters
getResetParameters
in interface ICommandParameters
public final void setResetParameters(TriState value)
setResetParameters
in interface ICommandParameters
public final TriState getTakeNoAction()
ICommandParameters
getTakeNoAction
in interface ICommandParameters
public final void setTakeNoAction(TriState value)
setTakeNoAction
in interface ICommandParameters
public final int getOutputPower()
IAntennaParameters
getOutputPower
in interface IAntennaParameters
public final void setOutputPower(int value)
setOutputPower
in interface IAntennaParameters
public final TriState getIncludeTransponderRssiPercent()
public final void setIncludeTransponderRssiPercent(TriState value)
public final TriState getIncludeTransponderRssi()
public final void setIncludeTransponderRssi(TriState value)
public final TriState getIncludeEpc()
public final void setIncludeEpc(TriState value)
public final TriState getIncludeDateTime()
IResponseParameters
getIncludeDateTime
in interface IResponseParameters
public final void setIncludeDateTime(TriState value)
setIncludeDateTime
in interface IResponseParameters
public final TriState getUseAlert()
IResponseParameters
getUseAlert
in interface IResponseParameters
public final void setUseAlert(TriState value)
setUseAlert
in interface IResponseParameters
public final Databank getSelectBank()
ISelectMaskParameters
getSelectBank
in interface ISelectMaskParameters
public final void setSelectBank(Databank value)
setSelectBank
in interface ISelectMaskParameters
public final java.lang.String getSelectData()
ISelectMaskParameters
getSelectData
in interface ISelectMaskParameters
public final void setSelectData(java.lang.String value)
setSelectData
in interface ISelectMaskParameters
public final int getSelectLength()
ISelectMaskParameters
getSelectLength
in interface ISelectMaskParameters
public final void setSelectLength(int value)
setSelectLength
in interface ISelectMaskParameters
public final int getSelectOffset()
ISelectMaskParameters
getSelectOffset
in interface ISelectMaskParameters
public final void setSelectOffset(int value)
setSelectOffset
in interface ISelectMaskParameters
public final VolumeLevel getVolumeLevel()
public final void setVolumeLevel(VolumeLevel value)
public final StartStop getTriggerOverride()
public final void setTriggerOverride(StartStop value)
public final TriState getMatchExact()
public final void setMatchExact(TriState value)
public final TriState getUseVisualFeedback()
public final void setUseVisualFeedback(TriState value)
public final TriState getUseVariableToneFrequency()
public final void setUseVariableToneFrequency(TriState value)
public final int getSoundPercentageThresholdOne()
public final void setSoundPercentageThresholdOne(int value)
public final int getSoundPercentageThresholdTwo()
public final void setSoundPercentageThresholdTwo(int value)
public final int getSoundPercentageThresholdThree()
public final void setSoundPercentageThresholdThree(int value)
public final ITransponderReceivedDelegate getTransponderReceivedDelegate()
public final void setTransponderReceivedDelegate(ITransponderReceivedDelegate listener)
public static FindTagCommand synchronousCommand()
protected void buildCommandLine(java.lang.StringBuilder line)
buildCommandLine
in class AsciiSelfResponderCommandBase
line
- The command line to append to
When overriding this method call the base class to construct the command line as known to the base class and
then append the additional parameters to the end of the linepublic void clearLastResponse()
clearLastResponse
in interface IAsciiCommandResponder
clearLastResponse
in class AsciiCommandResponderBase
protected void responseDidFinish(boolean async)
responseDidFinish
in class AsciiCommandResponderBase
async
- True if the command finished asynchronouslyprotected boolean responseDidReceiveParameter(java.lang.String parameter)
responseDidReceiveParameter
in class AsciiCommandResponderBase
parameter
- A single parameter extracted from the PR: response, excluding the '-' and trimmed of leading and trailing whitespaceprotected boolean processReceivedLine(java.lang.String fullLine, java.lang.String header, java.lang.String value, boolean moreAvailable) throws java.lang.Exception
processReceivedLine
in class AsciiCommandLibraryResponderBase
fullLine
- The line to be processedheader
- The response line header excluding the colon e.g. 'CS' for a command started responsevalue
- The response line following the colon e.g. '.iv'moreAvailable
- When true indicates there are additional lines to be processed (and will also be passed to this method)java.lang.Exception
public void transponderReceived(TransponderData transponder, boolean moreAvailable)
transponderReceived
in interface ITransponderReceivedDelegate
transponder
- a transponder response from an Inventory, Lock, Kill, Read or Write commandmoreAvailable
- true if there are more transponders