public class InventoryTagCommand extends AsciiSelfResponderCommandBase implements ICommandParameters, IResponseParameters, IHfLfTransponderReceivedDelegate
LibraryCommandId
Constructor and Description |
---|
InventoryTagCommand() |
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
|
java.lang.String |
getAllowedHFTags()
Gets or sets an 8-character Hex value indicating which HF tags are allowed
|
java.lang.String |
getAllowedLFTags()
Gets or sets an 8-character Hex value indicating which LF tags are allowed
|
TriState |
getIncludeDateTime()
Gets or sets a value indicating whether DateTime stamps appear in reader responses
|
TriState |
getIncludeTagType()
Gets or sets a value indicating whether the Tag Type appears as a two character code preceding the tag ID
and as a description in reader responses
|
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
|
TriState |
getSearchForMultipleISO14443ATags()
Gets or sets a value indicating whether the reader will search for multiple ISO14443A tags
|
TriState |
getTakeNoAction()
Gets or sets a value indicating whether the command primary action should not be performed
(e.g.
|
IHfLfTransponderReceivedDelegate |
getTransponderReceivedDelegate()
The delegate/listener for received transponders
|
TriState |
getUseAlert()
Gets or sets a value indicating whether alerts are enabled for the executing commands
|
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 |
setAllowedHFTags(java.lang.String allowedHFTags) |
void |
setAllowedLFTags(java.lang.String allowedLFTags) |
void |
setIncludeDateTime(TriState value) |
void |
setIncludeTagType(TriState value) |
void |
setReadParameters(TriState value) |
void |
setResetParameters(TriState value) |
void |
setSearchForMultipleIso14443ATags(TriState value) |
void |
setTakeNoAction(TriState value) |
void |
setTransponderReceivedDelegate(IHfLfTransponderReceivedDelegate listener) |
void |
setUseAlert(TriState value) |
static InventoryTagCommand |
synchronousCommand()
Returns a new instance of the command class that will execute synchronously (as its own responder)
|
void |
transponderReceived(HfLfTransponderData 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 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 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 TriState getSearchForMultipleISO14443ATags()
public void setSearchForMultipleIso14443ATags(TriState value)
public TriState getIncludeTagType()
public void setIncludeTagType(TriState value)
public java.lang.String getAllowedHFTags()
public void setAllowedHFTags(java.lang.String allowedHFTags)
public java.lang.String getAllowedLFTags()
public void setAllowedLFTags(java.lang.String allowedLFTags)
public final IHfLfTransponderReceivedDelegate getTransponderReceivedDelegate()
public final void setTransponderReceivedDelegate(IHfLfTransponderReceivedDelegate listener)
public static InventoryTagCommand 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(HfLfTransponderData transponder, boolean moreAvailable)
transponderReceived
in interface IHfLfTransponderReceivedDelegate
transponder
- an HF/LF transponder response from a commandmoreAvailable
- true if there are more transponders