Package jmri.jmrix.lenz

Class XNetTurnoutManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Turnout>

jmri.managers.AbstractTurnoutManager

jmri.jmrix.lenz.XNetTurnoutManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.beans.VetoableChangeListener, java.util.EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, AbstractMRListener, XNetListener, Manager<Turnout>, NameIncrementingManager, ProvidingManager<Turnout>, TurnoutManager

Direct Known Subclasses:

EliteXNetTurnoutManager, Z21XNetTurnoutManager, ZTC611XNetTurnoutManager

public class XNetTurnoutManager
extends AbstractTurnoutManager
implements XNetListener

Implement turnout manager for Lenz (XpresssNet) connections.

System names are "XTnnn", where X is the user configurable system prefix, nnn is the turnout number without padding.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.Manager

Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity

Field Summary

Fields

Modifier and Type	Field	Description
protected XNetTrafficController	tc

Fields inherited from class jmri.managers.AbstractManager

_beans, _tsys, _tuser, memo, silenceableProperties, silencedProperties

Fields inherited from class jmri.beans.VetoableChangeSupport

vetoableChangeSupport

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Fields inherited from interface jmri.Manager

ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
XNetTurnoutManager(XNetSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(java.lang.String systemName)	Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.
protected Turnout	createNewTurnout(java.lang.String systemName, java.lang.String userName)	Create a new Turnout based on the system name.
protected void	forwardMessageToTurnout(java.lang.String s, XNetReply l)
java.lang.String	getClosedText()	Get text to be used for the Turnout.CLOSED state in user communication.
java.lang.String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
XNetSystemConnectionMemo	getMemo()	Get the system connection for this manager.
java.lang.String	getThrownText()	Get text to be used for the Turnout.THROWN state in user communication.
void	message(XNetMessage l)	Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout.
void	message(XNetReply l)	Listen for turnouts, creating them as needed.
void	notifyTimeout(XNetMessage msg)	Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
java.lang.String	validateSystemNameFormat(java.lang.String name, java.util.Locale locale)	Validate the format of name, returning it unchanged if valid.
Manager.NameValidity	validSystemNameFormat(java.lang.String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractTurnoutManager

askControlType, askNumControlBits, createSystemName, dispose, getBeanTypeHandled, getDefaultClosedSpeed, getDefaultThrownSpeed, getNamedBeanClass, getOutputInterval, getTurnout, getValidOperationTypes, getXMLOrder, isControlTypeSupported, isNumControlBitsSupported, newTurnout, outputIntervalEnds, provideTurnout, setDefaultClosedSpeed, setDefaultThrownSpeed, setOutputInterval, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, deleteBean, deregister, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, vetoableChange

Methods inherited from class jmri.beans.VetoableChangeSupport

addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat

Methods inherited from interface jmri.NameIncrementingManager

getNextValidSystemName

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.TurnoutManager

getBySystemName, getByUserName, provide

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Detail

tc

protected XNetTrafficController tc

Constructor Detail

XNetTurnoutManager

public XNetTurnoutManager(XNetSystemConnectionMemo memo)

Method Detail

getMemo

@Nonnull
public XNetSystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Turnout>

Overrides:

getMemo in class AbstractManager<Turnout>

Returns:

the system connection for this manager

createNewTurnout

@Nonnull
protected Turnout createNewTurnout(@Nonnull
                                   java.lang.String systemName,
                                   java.lang.String userName)
                            throws java.lang.IllegalArgumentException

Create a new Turnout based on the system name. Assumes calling method has checked that a Turnout with this system name does not already exist. Internal method to invoke the factory, after all the logic for returning an existing Turnout has been invoked.

Specified by:

createNewTurnout in class AbstractTurnoutManager

Parameters:

systemName - the system name to use for the new Turnout

userName - the user name to use for the new Turnout

Returns:

the new Turnout or

Throws:

java.lang.IllegalArgumentException - if unsuccessful

message

public void message(XNetReply l)

Listen for turnouts, creating them as needed.

Specified by:

message in interface XNetListener

Parameters:

l - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.

forwardMessageToTurnout

protected void forwardMessageToTurnout(java.lang.String s,
                                       XNetReply l)

getClosedText

@Nonnull
public java.lang.String getClosedText()

Get text to be used for the Turnout.CLOSED state in user communication. Allows text other than "CLOSED" to be use with certain hardware system to represent the Turnout.CLOSED state.

Specified by:

getClosedText in interface TurnoutManager

Overrides:

getClosedText in class AbstractTurnoutManager

Returns:

the textual representation of Turnout.CLOSED

getThrownText

@Nonnull
public java.lang.String getThrownText()

Get text to be used for the Turnout.THROWN state in user communication. Allows text other than "THROWN" to be use with certain hardware system to represent the Turnout.THROWN state.

Specified by:

getThrownText in interface TurnoutManager

Overrides:

getThrownText in class AbstractTurnoutManager

Returns:

the textual representation of Turnout.THROWN

message

public void message(XNetMessage l)

Description copied from interface: XNetListener

Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout. Normally, this function will do nothing.

Specified by:

message in interface XNetListener

Parameters:

l - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.

notifyTimeout

public void notifyTimeout(XNetMessage msg)

Description copied from interface: XNetListener

Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.

Specified by:

notifyTimeout in interface XNetListener

Parameters:

msg - message which has timed out.

validateSystemNameFormat

@Nonnull
public java.lang.String validateSystemNameFormat(@Nonnull
                                                 java.lang.String name,
                                                 @Nonnull
                                                 java.util.Locale locale)

Validate the format of name, returning it unchanged if valid.

Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.

Overriding implementations may rely on Manager.validSystemNameFormat(java.lang.String), however they must provide an actionable message in the thrown exception if that method does not return Manager.NameValidity.VALID. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.

Specified by:

validateSystemNameFormat in interface Manager<Turnout>

Parameters:

name - the system name to validate

locale - the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales

Returns:

the unchanged value of the name parameter

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(@Nonnull
                                                  java.lang.String systemName)

Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user.

Specified by:

validSystemNameFormat in interface Manager<Turnout>

Overrides:

validSystemNameFormat in class AbstractManager<Turnout>

Parameters:

systemName - the system name

Returns:

Manager.NameValidity.INVALID if system name does not start with Manager.getSystemNamePrefix(); Manager.NameValidity.VALID_AS_PREFIX_ONLY if system name equals Manager.getSystemNamePrefix(); otherwise Manager.NameValidity.VALID to allow Managers that do not perform more specific validation to be considered valid.

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull
                                      java.lang.String systemName)

Description copied from interface: NameIncrementingManager

Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.

Default is not providing this service. Systems should override this method if they do provide the service.

Specified by:

allowMultipleAdditions in interface NameIncrementingManager

Parameters:

systemName - the system name to check against; appears to be ignored in all implementations

Returns:

true if possible; false otherwise

getEntryToolTip

public java.lang.String getEntryToolTip()

Get a manager-specific tool tip for adding an entry to the manager.

Specified by:

getEntryToolTip in interface Manager<Turnout>

Overrides:

getEntryToolTip in class AbstractTurnoutManager

Returns:

the tool tip or null to disable the tool tip