Package jmri.jmrix.dccpp

Class DCCppTurnoutManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Turnout>

jmri.managers.AbstractTurnoutManager

jmri.jmrix.dccpp.DCCppTurnoutManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, AbstractMRListener, DCCppListener, Manager<Turnout>, NameIncrementingManager, ProvidingManager<Turnout>, TurnoutManager

public class DCCppTurnoutManager
extends AbstractTurnoutManager
implements DCCppListener

Implement TurnoutManager for DCC++ systems.

System names are "DxppTnnn", where Dx is the system prefix and 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 DCCppTrafficController	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, PROPERTY_BEANS, PROPERTY_CAN_DELETE, PROPERTY_DISPLAY_LIST_NAME, PROPERTY_DO_DELETE, PROPERTY_DO_NOT_DELETE, PROPERTY_LENGTH, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Fields inherited from interface jmri.TurnoutManager

PROPERTY_DEFAULT_CLOSED_SPEED, PROPERTY_DEFAULT_THROWN_SPEED

Constructor Summary

Constructors

Constructor	Description
DCCppTurnoutManager(DCCppSystemConnectionMemo memo)	Create a new DCC++ TurnoutManager.

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.
protected Turnout	createNewTurnout(String systemName, String userName)	Internal method to invoke the factory, after all the logic for returning an existing Turnout has been invoked.
int	getBitFromSystemName(String systemName)	Get the bit address from the system name.
String	getClosedText()	Get text to be used for the Turnout.CLOSED state in user communication.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
DCCppSystemConnectionMemo	getMemo()	Get the system connection for this manager.
String	getThrownText()	Get text to be used for the Turnout.THROWN state in user communication.
void	message(DCCppMessage l)	Listen for the outgoing messages (to the command station)
void	message(DCCppReply l)	Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout.
void	notifyTimeout(DCCppMessage msg)	Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
String	validateSystemNameFormat(String systemName, Locale locale)	Validate the format of name, returning it unchanged if valid.
Manager.NameValidity	validSystemNameFormat(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 Details

tc

protected DCCppTrafficController tc

Constructor Details

DCCppTurnoutManager

public DCCppTurnoutManager(DCCppSystemConnectionMemo memo)

Create a new DCC++ TurnoutManager. Has to register for DCC++ events.

Parameters:

memo - the supporting system connection memo

Method Details

getMemo

@Nonnull
public DCCppSystemConnectionMemo 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
 String systemName,
 String userName)
                            throws IllegalArgumentException

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:

IllegalArgumentException - if unsuccessful

message

public void message(DCCppReply l)

Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout. Listen for turnouts, creating them as needed.

Specified by:

message in interface DCCppListener

Parameters:

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

getClosedText

@Nonnull
public 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 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(DCCppMessage l)

Listen for the outgoing messages (to the command station)

Specified by:

message in interface DCCppListener

Parameters:

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

notifyTimeout

public void notifyTimeout(DCCppMessage msg)

Description copied from interface: DCCppListener

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

Specified by:

notifyTimeout in interface DCCppListener

Parameters:

msg - the message that timed out.

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull
 String systemName)

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

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(@Nonnull
 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.

validateSystemNameFormat

@Nonnull
public String validateSystemNameFormat(@Nonnull
 String systemName,
 @Nonnull
 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:

systemName - 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

getBitFromSystemName

public int getBitFromSystemName(String systemName)

Get the bit address from the system name.

Parameters:

systemName - a valid Turnout System Name

Returns:

the turnout number extracted from the system name

getEntryToolTip

public 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