Package jmri.jmrix.acela
Class AcelaTrafficController
java.lang.Object
jmri.jmrix.AbstractMRTrafficController
jmri.jmrix.AbstractMRNodeTrafficController
jmri.jmrix.acela.AcelaTrafficController
- All Implemented Interfaces:
AcelaInterface
public class AcelaTrafficController extends AbstractMRNodeTrafficController implements AcelaInterface
Converts Stream-based I/O to/from Acela messages.
The "SerialInterface" side sends/receives message objects.
The connection to an AcelaPortController is via a pair of Streams, which then carry sequences of characters for transmission. Note that this processing is handled in an independent thread.
This handles the state transitions, based on the necessary state in each message.
Handles initialization, polling, output, and input for multiple Serial Nodes.
- See Also:
AbstractMRNodeTrafficController
-
Nested Class Summary
Nested classes/interfaces inherited from class jmri.jmrix.AbstractMRTrafficController
AbstractMRTrafficController.RcvNotifier, AbstractMRTrafficController.XmtNotifier
-
Field Summary
Fields Modifier and Type Field Description (package private) int
curAcelaNodeIndex
(package private) AcelaSystemConnectionMemo
mMemo
Reference to the system connection memo.(package private) AcelaSensorManager
mSensorManager
(package private) AcelaTurnoutManager
mTurnoutManager
Fields inherited from class jmri.jmrix.AbstractMRNodeTrafficController
curSerialNodeIndex, maxNode, minNode, nodeArray, numNodes
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, WAITMSGREPLYSTATE, WAITREPLYINNORMMODESTATE, WAITREPLYINPROGMODESTATE, waitTimePoll, xmtException, xmtRunnable, xmtThread
-
Constructor Summary
Constructors Constructor Description AcelaTrafficController()
Create a new AcelaTrafficController instance. -
Method Summary
Modifier and Type Method Description void
addAcelaListener(AcelaListener l)
protected boolean
endOfMessage(AbstractMRReply msg)
protected AbstractMRMessage
enterNormalMode()
Sets the system to normal mode during programming while in IDLESTATE.protected AbstractMRMessage
enterProgMode()
Set the system to programming mode.protected void
forwardMessage(AbstractMRListener client, AbstractMRMessage m)
Forward an AcelaMessage to all registered AcelaInterface listeners.protected void
forwardReply(AbstractMRListener client, AbstractMRReply m)
Forward an AcelaReply to all registered AcelaInterface listeners.int
getAcelaSensorInitCount()
boolean
getAcelaSensorsState()
boolean
getAcelaTrafficControllerState()
int
getMaximumNumberOfNodes()
Get maximum number of Acela nodes as set on this TrafficController.int
getMinimumNodeAddress()
Get minimum address of an Acela node as set on this TrafficController.boolean
getNeedToPollNodes()
boolean
getReallyReadyToPoll()
AcelaSystemConnectionMemo
getSystemConnectionMemo()
Get access to the system connection memo associated with this traffic controller.protected void
handleTimeout(AbstractMRMessage m, AbstractMRListener l)
void
incrementAcelaSensorInitCount()
void
initializeAcelaNode(AcelaNode node)
Public method to set up for initialization of an Acela node.protected void
loadChars(AbstractMRReply msg, DataInputStream istream)
Get characters from the input source, and file a message.int
lookupAcelaNodeAddress(int bitAddress, boolean isSensor)
Public method to identify an AcelaNode from its bit address.protected AbstractMRReply
newReply()
protected AbstractMRMessage
pollMessage()
Handle initialization, output and polling for Acela Nodes from within the running thread.protected AbstractMRListener
pollReplyHandler()
void
registerAcelaNode(AcelaNode node)
Public method to register an Acela node.void
removeAcelaListener(AcelaListener l)
void
resetStartingAddresses()
protected void
resetTimeout(AbstractMRMessage m)
void
sendAcelaMessage(AcelaMessage m, AcelaListener reply)
Forward a pre-formatted message to the actual interface.void
setAcelaSensorsState(boolean newstate)
void
setAcelaTrafficControllerState(boolean newstate)
void
setNeedToPollNodes(boolean newstate)
void
setReallyReadyToPoll(boolean newstate)
void
setSensorManager(AcelaSensorManager m)
void
setSystemConnectionMemo(AcelaSystemConnectionMemo m)
Set the system connection memo associated with this traffic controller.void
setTurnoutManager(AcelaTurnoutManager m)
void
updateSensorsFromPoll(AcelaReply r)
For each sensor node call markChanges.protected void
waitForStartOfReply(DataInputStream istream)
Dummy routine, to be filled by protocols that have to skip some start-of-message characters.Methods inherited from class jmri.jmrix.AbstractMRNodeTrafficController
deleteNode, getMustInit, getNode, getNodeFromAddress, getNumNodes, init, registerNode, setMustInit, setMustInit
Methods inherited from class jmri.jmrix.AbstractMRTrafficController
addHeaderToOutput, addListener, addTrailerToOutput, canReceive, connectionWarn, connectPort, disconnectPort, distributeReply, enterProgModeDelayTime, finalize, forwardToPort, getLastSender, getPortName, getSynchronizeRx, handleOneIncomingReply, hasTimeouts, lengthOfByteStream, newRcvNotifier, notifyMessage, notifyReply, portReadyToSend, portWarn, portWarnTCP, programmerIdle, readByteProtected, receiveLoop, recovery, removeListener, reportReceiveLoopException, sendMessage, setAllowUnexpectedReply, setSynchronizeRx, status, terminate, terminateThreads, transmitLoop, transmitWait, unexpectedReplyStateError
-
Field Details
-
curAcelaNodeIndex
-
mMemo
Reference to the system connection memo. -
mSensorManager
-
mTurnoutManager
-
-
Constructor Details
-
AcelaTrafficController
public AcelaTrafficController()Create a new AcelaTrafficController instance.
-
-
Method Details
-
addAcelaListener
- Specified by:
addAcelaListener
in interfaceAcelaInterface
-
removeAcelaListener
- Specified by:
removeAcelaListener
in interfaceAcelaInterface
-
getMinimumNodeAddress
Get minimum address of an Acela node as set on this TrafficController.- Returns:
- minimum node address.
-
getMaximumNumberOfNodes
Get maximum number of Acela nodes as set on this TrafficController.- Returns:
- max number of nodes.
-
getAcelaTrafficControllerState
-
setAcelaTrafficControllerState
-
resetStartingAddresses
-
getAcelaSensorsState
-
setAcelaSensorsState
-
incrementAcelaSensorInitCount
-
getAcelaSensorInitCount
-
getNeedToPollNodes
-
setNeedToPollNodes
-
getReallyReadyToPoll
-
setReallyReadyToPoll
-
getSystemConnectionMemo
Get access to the system connection memo associated with this traffic controller.- Returns:
- associated systemConnectionMemo object
-
setSystemConnectionMemo
Set the system connection memo associated with this traffic controller.- Parameters:
m
- associated systemConnectionMemo object
-
registerAcelaNode
Public method to register an Acela node.- Parameters:
node
- which node to register.
-
initializeAcelaNode
Public method to set up for initialization of an Acela node.- Parameters:
node
- which node to initialize.
-
lookupAcelaNodeAddress
Public method to identify an AcelaNode from its bit address.Note: nodeAddress is numbered from 0
- Parameters:
bitAddress
- address to query.isSensor
- true to use start sensor address, false to use start output address.- Returns:
- '-1' if an AcelaNode with the specified address was not found
-
enterProgMode
Description copied from class:AbstractMRTrafficController
Set the system to programming mode.- Specified by:
enterProgMode
in classAbstractMRTrafficController
- Returns:
- any message that needs to be returned to the Command Station to change modes. If no message is needed, returns null.
- See Also:
AbstractMRTrafficController.enterNormalMode()
-
enterNormalMode
Description copied from class:AbstractMRTrafficController
Sets the system to normal mode during programming while in IDLESTATE. IfAbstractMRTrafficController.programmerIdle()
returns true, enterNormalMode() is called after a timeout.- Specified by:
enterNormalMode
in classAbstractMRTrafficController
- Returns:
- any message that needs to be returned to the Command Station to change modes. If no message is needed, returns null.
- See Also:
AbstractMRTrafficController.enterProgMode()
-
forwardMessage
Forward an AcelaMessage to all registered AcelaInterface listeners. Implement this to forward a specific message type to a protocol-specific listener interface. This puts the casting into the concrete class.- Specified by:
forwardMessage
in classAbstractMRTrafficController
- Parameters:
client
- abstract listener.m
- message to forward.
-
forwardReply
Forward an AcelaReply to all registered AcelaInterface listeners.- Specified by:
forwardReply
in classAbstractMRTrafficController
-
setSensorManager
-
setTurnoutManager
-
pollMessage
Handle initialization, output and polling for Acela Nodes from within the running thread.- Specified by:
pollMessage
in classAbstractMRTrafficController
- Returns:
- Formatted poll message
-
handleTimeout
- Overrides:
handleTimeout
in classAbstractMRTrafficController
-
resetTimeout
- Overrides:
resetTimeout
in classAbstractMRTrafficController
-
pollReplyHandler
- Specified by:
pollReplyHandler
in classAbstractMRTrafficController
-
sendAcelaMessage
Forward a pre-formatted message to the actual interface.- Specified by:
sendAcelaMessage
in interfaceAcelaInterface
-
newReply
- Specified by:
newReply
in classAbstractMRTrafficController
-
endOfMessage
- Specified by:
endOfMessage
in classAbstractMRTrafficController
-
loadChars
Description copied from class:AbstractMRTrafficController
Get characters from the input source, and file a message.Returns only when the message is complete.
Only used in the Receive thread.
Handles timeouts on read by ignoring zero-length reads.
- Overrides:
loadChars
in classAbstractMRTrafficController
- Parameters:
msg
- message to fillistream
- character source.- Throws:
IOException
- when presented by the input source.
-
waitForStartOfReply
Description copied from class:AbstractMRTrafficController
Dummy routine, to be filled by protocols that have to skip some start-of-message characters.- Overrides:
waitForStartOfReply
in classAbstractMRTrafficController
- Parameters:
istream
- input source- Throws:
IOException
- from underlying operations
-
updateSensorsFromPoll
For each sensor node call markChanges.- Parameters:
r
- reply to use in sensor update.
-