public class KillCommand extends AsciiSelfResponderCommandBase implements IAntennaParameters, ICommandParameters, IQAlgorithmParameters, IQueryParameters, IResponseParameters, ISelectControlParameters, ISelectMaskParameters, ITransponderParameters, ITransponderReceivedDelegate
LibraryCommandId
Constructor and Description |
---|
KillCommand()
Initializes a new instance of the InventoryCommand 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
|
java.lang.String |
getAccessPassword()
Gets or sets the password required to access transponders
|
TriState |
getIncludeChecksum()
Gets or sets a value indicating whether to include checksum information in reader responses
|
TriState |
getIncludeDateTime()
Gets or sets a value indicating whether DateTime stamps appear in reader responses
|
TriState |
getIncludeIndex()
Gets or sets a value indicating whether to include index numbers for multiple values in reader responses
|
TriState |
getIncludePC()
Gets or sets a value indicating whether to include the EPC PC value in reader responses
|
TriState |
getIncludeTransponderRssi()
Gets or sets a value indicating whether to include RSSI value in reader responses
|
TriState |
getInventoryOnly() |
java.lang.String |
getKillPassword() |
int |
getOutputPower()
Gets or sets the output power.
|
QAlgorithm |
getQAlgorithm()
Gets or sets the Q algorithm type
|
QuerySelect |
getQuerySelect()
Gets or sets the transponders to include based on the select flag state
|
QuerySession |
getQuerySession()
Gets or sets the transponders to include based on the select flag state
|
QueryTarget |
getQueryTarget()
Gets or sets the session state of the transponders to be included in this operation
|
int |
getQValue()
Gets or sets the Q value for fixed Q operations (0-15)
|
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
|
SelectAction |
getSelectAction()
Gets or sets the action to perform in the Select operation
|
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
|
SelectTarget |
getSelectTarget()
Gets or sets the target flag for the Select operation
|
TriState |
getTakeNoAction()
Gets or sets a value indicating whether the command primary action should not be performed
(e.g.
|
ITransponderReceivedDelegate |
getTransponderReceivedDelegate() |
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 |
setAccessPassword(java.lang.String value) |
void |
setIncludeChecksum(TriState value) |
void |
setIncludeDateTime(TriState value) |
void |
setIncludeIndex(TriState value) |
void |
setIncludePC(TriState value) |
void |
setIncludeTransponderRssi(TriState value) |
void |
setInventoryOnly(TriState value) |
void |
setKillPassword(java.lang.String value) |
void |
setOutputPower(int value) |
void |
setQAlgorithm(QAlgorithm value) |
void |
setQuerySelect(QuerySelect value) |
void |
setQuerySession(QuerySession value) |
void |
setQueryTarget(QueryTarget value) |
void |
setQValue(int value) |
void |
setReadParameters(TriState value) |
void |
setResetParameters(TriState value) |
void |
setSelectAction(SelectAction value) |
void |
setSelectBank(Databank value) |
void |
setSelectData(java.lang.String value) |
void |
setSelectLength(int value) |
void |
setSelectOffset(int value) |
void |
setSelectTarget(SelectTarget value) |
void |
setTakeNoAction(TriState value) |
void |
setTransponderReceivedDelegate(ITransponderReceivedDelegate listener) |
void |
setUseAlert(TriState value) |
static KillCommand |
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 KillCommand()
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 java.lang.String getAccessPassword()
ITransponderParameters
getAccessPassword
in interface ITransponderParameters
public final void setAccessPassword(java.lang.String value)
setAccessPassword
in interface ITransponderParameters
public final TriState getIncludeChecksum()
ITransponderParameters
getIncludeChecksum
in interface ITransponderParameters
public final void setIncludeChecksum(TriState value)
setIncludeChecksum
in interface ITransponderParameters
public final TriState getIncludeIndex()
ITransponderParameters
getIncludeIndex
in interface ITransponderParameters
public final void setIncludeIndex(TriState value)
setIncludeIndex
in interface ITransponderParameters
public final TriState getIncludePC()
ITransponderParameters
getIncludePC
in interface ITransponderParameters
public final void setIncludePC(TriState value)
setIncludePC
in interface ITransponderParameters
public final TriState getIncludeTransponderRssi()
ITransponderParameters
getIncludeTransponderRssi
in interface ITransponderParameters
public final void setIncludeTransponderRssi(TriState value)
setIncludeTransponderRssi
in interface ITransponderParameters
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 QuerySelect getQuerySelect()
IQueryParameters
getQuerySelect
in interface IQueryParameters
public final void setQuerySelect(QuerySelect value)
setQuerySelect
in interface IQueryParameters
public final QuerySession getQuerySession()
IQueryParameters
getQuerySession
in interface IQueryParameters
public final void setQuerySession(QuerySession value)
setQuerySession
in interface IQueryParameters
public final QueryTarget getQueryTarget()
IQueryParameters
getQueryTarget
in interface IQueryParameters
public final void setQueryTarget(QueryTarget value)
setQueryTarget
in interface IQueryParameters
public final QAlgorithm getQAlgorithm()
IQAlgorithmParameters
getQAlgorithm
in interface IQAlgorithmParameters
public final void setQAlgorithm(QAlgorithm value)
setQAlgorithm
in interface IQAlgorithmParameters
public final int getQValue()
IQAlgorithmParameters
getQValue
in interface IQAlgorithmParameters
public final void setQValue(int value)
setQValue
in interface IQAlgorithmParameters
public final TriState getInventoryOnly()
public final void setInventoryOnly(TriState value)
public final SelectAction getSelectAction()
ISelectControlParameters
getSelectAction
in interface ISelectControlParameters
public final void setSelectAction(SelectAction value)
setSelectAction
in interface ISelectControlParameters
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 SelectTarget getSelectTarget()
ISelectControlParameters
getSelectTarget
in interface ISelectControlParameters
public final void setSelectTarget(SelectTarget value)
setSelectTarget
in interface ISelectControlParameters
public final ITransponderReceivedDelegate getTransponderReceivedDelegate()
public final void setTransponderReceivedDelegate(ITransponderReceivedDelegate listener)
public final java.lang.String getKillPassword()
public final void setKillPassword(java.lang.String value)
public static KillCommand synchronousCommand()
public void clearLastResponse()
clearLastResponse
in interface IAsciiCommandResponder
clearLastResponse
in class AsciiCommandResponderBase
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 lineprotected 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, Read or Write commandmoreAvailable
- true if there are more transponders