jmri.jmrix.rfid
Class RfidMessage

java.lang.Object
  jmri.jmrix.AbstractMessage
      jmri.jmrix.AbstractMRMessage
          jmri.jmrix.rfid.RfidMessage

All Implemented Interfaces:

Message

Direct Known Subclasses:

SpecificMessage, SpecificMessage

public abstract class RfidMessage
extends AbstractMRMessage

Contains the data payload of a serial packet.

The transmission protocol can come in one of several forms:

• If the interlocked parameter is false (default), the packet is just sent. If the response length is not zero, a reply of that length is expected.
• If the interlocked parameter is true, the transmission will require a CRC interlock, which will be automatically added. (Design note: this is done to make sure that the messages remain atomic)

Since:

2.11.4

Author:

Bob Jacobsen Copyright (C) 2001,2003, 2006, 2007, 2008, Matthew Harris Copyright (C) 2011

Field Summary

Fields inherited from class jmri.jmrix.AbstractMRMessage

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.jmrix.AbstractMessage

_dataChars, _nDataChars

Constructor Summary

protected	RfidMessage() Suppress the default ctor, as the length must always be specified
	RfidMessage(byte[] a, int l) This ctor interprets the byte array as a sequence of characters to send.
	RfidMessage(int l)
	RfidMessage(String m, int l) This ctor interprets the String as the exact sequence to send, byte-for-byte.

Method Summary

boolean	getInterlocked()
int	getResponseLength()
void	setInterlocked(boolean v)
void	setResponseLength(int l)
abstract String	toMonitorString()

Methods inherited from class jmri.jmrix.AbstractMRMessage

addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setOpCode, setRetries, setTimeout, toString

Methods inherited from class jmri.jmrix.AbstractMessage

getElement, getNumDataElements, setElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RfidMessage

protected RfidMessage()

Suppress the default ctor, as the length must always be specified

RfidMessage

public RfidMessage(int l)

RfidMessage

public RfidMessage(String m,
                   int l)

This ctor interprets the String as the exact sequence to send, byte-for-byte.

Parameters:

m -

RfidMessage

public RfidMessage(byte[] a,
                   int l)

This ctor interprets the byte array as a sequence of characters to send.

Parameters:

a - Array of bytes to send

Method Detail

setInterlocked

public void setInterlocked(boolean v)

getInterlocked

public boolean getInterlocked()

setResponseLength

public final void setResponseLength(int l)

getResponseLength

public int getResponseLength()

toMonitorString

public abstract String toMonitorString()