Package jmri.jmrix.openlcb

Class OlcbSignalMast.StateMachine<T>

java.lang.Object

org.openlcb.AbstractConnection

org.openlcb.MessageDecoder

jmri.jmrix.openlcb.OlcbSignalMast.StateMachine<T>

All Implemented Interfaces:

Connection

Enclosing class:

OlcbSignalMast

class OlcbSignalMast.StateMachine<T>
extends MessageDecoder

Implement a general state machine where state transitions are associated with the production and consumption of specific events. There's a one-to-one mapping between transitions and events. EventID storage is via Strings, so that the user-visible eventID string is preserved.

non-static because it references systemMemo from parent class

Nested Class Summary

Nested classes/interfaces inherited from interface org.openlcb.Connection

Connection.ConnectionListener

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Connection	connection
protected final HashMap<EventID,T>	eventToState
(package private) boolean	initizalized
(package private) final NodeID	node
(package private) T	state
protected final HashMap<T,EventID>	stateToEventID
protected final HashMap<T,String>	stateToEventString

Constructor Summary

Constructors

Constructor	Description
StateMachine(Connection connection, NodeID node, T start)

Method Summary

Modifier and Type	Method	Description
EventID	getEventIDForState(T key)
(package private) EventState	getEventIDState(EventID event)	Internal method to determine the EventState for a reply to an Identify* method
String	getEventStringForState(T key)
T	getState()
void	handleConsumerIdentified(ConsumerIdentifiedMessage msg, Connection sender)
void	handleIdentifyConsumers(IdentifyConsumersMessage msg, Connection sender)
void	handleIdentifyEventsAddressed(IdentifyEventsAddressedMessage msg, Connection sender)
void	handleIdentifyEventsGlobal(IdentifyEventsGlobalMessage msg, Connection sender)
void	handleIdentifyProducers(IdentifyProducersMessage msg, Connection sender)
void	handleProducerConsumerEventReport(ProducerConsumerEventReportMessage msg, Connection sender)
void	handleProducerIdentified(ProducerIdentifiedMessage msg, Connection sender)
void	sendAllIdentifiedMessages()	Used at start up to emit the required messages, and in response to a IdentifyEvents message
void	setEventForState(T key, String value)
void	setState(T newState)

Methods inherited from class org.openlcb.MessageDecoder

defaultHandler, handleConsumerRangeIdentified, handleDatagram, handleDatagramAcknowledged, handleDatagramRejected, handleInitializationComplete, handleLearnEvent, handleOptionalIntRejected, handleProducerRangeIdentified, handleProtocolIdentificationReply, handleProtocolIdentificationRequest, handleSimpleNodeIdentInfoReply, handleSimpleNodeIdentInfoRequest, handleStreamDataComplete, handleStreamDataProceed, handleStreamDataSend, handleStreamInitiateReply, handleStreamInitiateRequest, handleTractionControlReply, handleTractionControlRequest, handleTractionProxyReply, handleTractionProxyRequest, handleUnknownMTI, handleVerifiedNodeIDNumber, handleVerifyNodeIDNumberAddressed, handleVerifyNodeIDNumberGlobal, put

Methods inherited from class org.openlcb.AbstractConnection

registerStartNotification

Methods inherited from class java.lang.Object

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

Field Details

connection

final Connection connection

node

final NodeID node

state

T state

initizalized

boolean initizalized

stateToEventString

protected final HashMap<T,String> stateToEventString

stateToEventID

protected final HashMap<T,EventID> stateToEventID

eventToState

protected final HashMap<EventID,T> eventToState

Constructor Details

StateMachine

public StateMachine(@Nonnull
 Connection connection,
 @Nonnull
 NodeID node,
 @Nonnull
 T start)

Method Details

setState

public void setState(@Nonnull
 T newState)

getState

@Nonnull
public T getState()

setEventForState

public void setEventForState(@Nonnull
 T key,
 @Nonnull
 String value)

getEventIDForState

@CheckForNull
public EventID getEventIDForState(@Nonnull
 T key)

getEventStringForState

@CheckForNull
public String getEventStringForState(@Nonnull
 T key)

getEventIDState

EventState getEventIDState(EventID event)

Internal method to determine the EventState for a reply to an Identify* method

Parameters:

event - Method returns the underlying state for this EventID

Returns:

State corresponding to the given EventID

handleProducerConsumerEventReport

public void handleProducerConsumerEventReport(@Nonnull
 ProducerConsumerEventReportMessage msg,
 Connection sender)

Overrides:

handleProducerConsumerEventReport in class MessageDecoder

handleProducerIdentified

public void handleProducerIdentified(@Nonnull
 ProducerIdentifiedMessage msg,
 Connection sender)

Overrides:

handleProducerIdentified in class MessageDecoder

handleConsumerIdentified

public void handleConsumerIdentified(@Nonnull
 ConsumerIdentifiedMessage msg,
 Connection sender)

Overrides:

handleConsumerIdentified in class MessageDecoder

handleIdentifyEventsAddressed

public void handleIdentifyEventsAddressed(@Nonnull
 IdentifyEventsAddressedMessage msg,
 Connection sender)

Overrides:

handleIdentifyEventsAddressed in class MessageDecoder

handleIdentifyEventsGlobal

public void handleIdentifyEventsGlobal(@Nonnull
 IdentifyEventsGlobalMessage msg,
 Connection sender)

Overrides:

handleIdentifyEventsGlobal in class MessageDecoder

sendAllIdentifiedMessages

public void sendAllIdentifiedMessages()

Used at start up to emit the required messages, and in response to a IdentifyEvents message

handleIdentifyProducers

public void handleIdentifyProducers(@Nonnull
 IdentifyProducersMessage msg,
 Connection sender)

Overrides:

handleIdentifyProducers in class MessageDecoder

handleIdentifyConsumers

public void handleIdentifyConsumers(@Nonnull
 IdentifyConsumersMessage msg,
 Connection sender)

Overrides:

handleIdentifyConsumers in class MessageDecoder