Package jmri.jmrix.can.adapters.lawicell

Class LawicellTrafficController

java.lang.Object

jmri.jmrix.AbstractMRTrafficController

jmri.jmrix.can.AbstractCanTrafficController

jmri.jmrix.can.TrafficController

jmri.jmrix.can.adapters.lawicell.LawicellTrafficController

All Implemented Interfaces:

CanInterface

public class LawicellTrafficController
extends TrafficController

Traffic controller for the LAWICELL protocol.

Lawicell adapters use messages transmitted as an ASCII string of up to 24 characters of the form: ;ShhhhNd0d1d2d3d4d5d6d7: The S indicates a standard CAN frame hhhh is the two byte header N or R indicates a normal or remote frame d0 - d7 are the (up to) 8 data bytes

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractMRTrafficController

AbstractMRTrafficController.RcvNotifier, AbstractMRTrafficController.XmtNotifier

Field Summary

Fields

Modifier and Type	Field	Description
static int	BOOTMODE
static int	NORMAL

Fields inherited from class jmri.jmrix.can.TrafficController

_canid

Fields inherited from class jmri.jmrix.AbstractMRTrafficController

allowUnexpectedReply, AUTORETRYSTATE, cmdListeners, connectionError, controller, flushReceiveChars, IDLESTATE, istream, listenerQueue, maxRcvExceptionCount, mCurrentMode, mCurrentState, mLastSender, msgQueue, mWaitBeforePoll, NORMALMODE, NOTIFIEDSTATE, OKSENDMSGSTATE, ostream, POLLSTATE, PROGRAMINGMODE, rcvException, rcvThread, replyInDispatch, threadStopRequest, timeoutFlag, timeouts, WAITMSGREPLYSTATE, WAITREPLYINNORMMODESTATE, WAITREPLYINPROGMODESTATE, waitTimePoll, xmtException, xmtRunnable, xmtThread

Constructor Summary

Constructors

Constructor	Description
LawicellTrafficController()

Method Summary

Modifier and Type	Method	Description
protected void	addTrailerToOutput(byte[] msg, int offset, AbstractMRMessage m)	Add trailer to the outgoing byte stream.
CanReply	decodeFromHardware(AbstractMRReply m)	Make a CanReply from a Lawicell-specific reply.
AbstractMRMessage	encodeForHardware(CanMessage m)	Encode a CanMessage into Lawicell format for the hardware.
(package private) boolean	endNormalReply(AbstractMRReply r)
protected boolean	endOfMessage(AbstractMRReply r)	Normal Lawicell replies will end with CR; errors are BELL.
protected void	forwardMessage(AbstractMRListener client, AbstractMRMessage m)	Forward a CanMessage to all registered CanInterface listeners.
protected void	forwardReply(AbstractMRListener client, AbstractMRReply r)	Forward a CanReply to all registered CanInterface listeners.
int	getgcState()
boolean	isBootMode()
protected int	lengthOfByteStream(AbstractMRMessage m)	Determine how much many bytes the entire message will take, including space for header and trailer
protected AbstractMRMessage	newMessage()	Get the correct concrete class for the hardware connection message
protected AbstractMRReply	newReply()
void	sendCanMessage(CanMessage m, CanListener reply)	Forward a preformatted message to the actual interface.
void	sendCanReply(CanReply r, CanListener reply)	Forward a preformatted reply to the actual interface.
void	setgcState(int s)

Methods inherited from class jmri.jmrix.can.TrafficController

getCanid, setCanId

Methods inherited from class jmri.jmrix.can.AbstractCanTrafficController

addCanConsoleListener, addCanListener, distributeOneReply, enterNormalMode, enterProgMode, forwardToPort, handleOneIncomingReply, pollMessage, pollReplyHandler, removeCanListener

Methods inherited from class jmri.jmrix.AbstractMRTrafficController

addConsoleListener, addHeaderToOutput, addListener, canReceive, connectionWarn, connectPort, disconnectPort, distributeReply, enterProgModeDelayTime, getLastSender, getPortName, getSynchronizeRx, handleTimeout, hasTimeouts, loadChars, newRcvNotifier, notifyMessage, notifyReply, portReadyToSend, portWarn, portWarnTCP, programmerIdle, readByteProtected, receiveLoop, recovery, removeListener, reportReceiveLoopException, resetTimeout, sendMessage, setAllowUnexpectedReply, setSynchronizeRx, status, terminate, terminateThreads, transmitLoop, transmitWait, unexpectedReplyStateError, waitForStartOfReply, warnOnTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.can.CanInterface

status

Field Detail

NORMAL

public static final int NORMAL

See Also:

Constant Field Values

BOOTMODE

public static final int BOOTMODE

See Also:

Constant Field Values

Constructor Detail

LawicellTrafficController

public LawicellTrafficController()

Method Detail

forwardMessage

protected void forwardMessage(AbstractMRListener client,
                              AbstractMRMessage m)

Forward a CanMessage to all registered CanInterface listeners.

Specified by:

forwardMessage in class AbstractMRTrafficController

Parameters:

client - abstract listener.

m - message to forward.

forwardReply

protected void forwardReply(AbstractMRListener client,
                            AbstractMRReply r)

Forward a CanReply to all registered CanInterface listeners.

Specified by:

forwardReply in class AbstractMRTrafficController

getgcState

public int getgcState()

setgcState

public void setgcState(int s)

isBootMode

public boolean isBootMode()

sendCanMessage

public void sendCanMessage(CanMessage m,
                           CanListener reply)

Forward a preformatted message to the actual interface. Send a message through the interface.

Parameters:

m - Message to be sent.

reply - Listener to be notified of reply.

sendCanReply

public void sendCanReply(CanReply r,
                         CanListener reply)

Forward a preformatted reply to the actual interface. Send a reply through the interface.

Parameters:

r - Reply to be sent.

reply - Listener to be notified of reply.

addTrailerToOutput

protected void addTrailerToOutput(byte[] msg,
                                  int offset,
                                  AbstractMRMessage m)

Add trailer to the outgoing byte stream.

Overrides:

addTrailerToOutput in class AbstractMRTrafficController

Parameters:

msg - The output byte stream

offset - the first byte not yet used

m - output message to extend

lengthOfByteStream

protected int lengthOfByteStream(AbstractMRMessage m)

Determine how much many bytes the entire message will take, including space for header and trailer

Overrides:

lengthOfByteStream in class AbstractMRTrafficController

Parameters:

m - The message to be sent

Returns:

Number of bytes

newMessage

protected AbstractMRMessage newMessage()

Description copied from class: AbstractCanTrafficController

Get the correct concrete class for the hardware connection message

Specified by:

newMessage in class AbstractCanTrafficController

Returns:

new blank message

decodeFromHardware

public CanReply decodeFromHardware(AbstractMRReply m)

Make a CanReply from a Lawicell-specific reply.

Specified by:

decodeFromHardware in class AbstractCanTrafficController

encodeForHardware

public AbstractMRMessage encodeForHardware(CanMessage m)

Encode a CanMessage into Lawicell format for the hardware.

Specified by:

encodeForHardware in class AbstractCanTrafficController

newReply

protected AbstractMRReply newReply()

Specified by:

newReply in class AbstractMRTrafficController

endOfMessage

protected boolean endOfMessage(AbstractMRReply r)

Normal Lawicell replies will end with CR; errors are BELL.

Specified by:

endOfMessage in class AbstractMRTrafficController

endNormalReply

boolean endNormalReply(AbstractMRReply r)