Package jmri.jmrix.openlcb

Class OlcbTurnoutManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Turnout>

jmri.managers.AbstractTurnoutManager

jmri.jmrix.openlcb.OlcbTurnoutManager

All Implemented Interfaces:

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

public class OlcbTurnoutManager
extends AbstractTurnoutManager

OpenLCB implementation of a TurnoutManager.

Turnouts must be manually created.

Since:

2.3.1

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 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, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, 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
OlcbTurnoutManager(CanSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	A temporary method that determines if it is possible to add a range of turnouts in numerical order eg 10 to 30, primarily used to enable/disable the Add range box in the Add new turnout panel.
protected Turnout	createNewTurnout(String systemName, String userName)	Internal method to invoke the factory, after all the logic for returning an existing method has been invoked.
String	createSystemName(String curAddress, String prefix)	Default Turnout ensures a numeric only system name.
void	finishLoad()	This function is invoked after the XML load is complete and all turnouts are instantiated and their feedback type is read in.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
List<NamedBeanPropertyDescriptor<?>>	getKnownBeanProperties()	By default there are no custom properties.
CanSystemConnectionMemo	getMemo()	Get the system connection for this manager.
String	getNextValidAddress(String curAddress, String prefix, boolean ignoreInitialExisting)	Get the Next valid hardware address.
void	startLoad()	This function is invoked before an XML load is started.
String	validateSystemNameFormat(String name, Locale locale)	Validates to OpenLCB format.

Methods inherited from class jmri.managers.AbstractTurnoutManager

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

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, validSystemNameFormat, 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, dispose, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

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, getNextValidAddress, provide

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Details

OlcbTurnoutManager

public OlcbTurnoutManager(CanSystemConnectionMemo memo)

Method Details

getMemo

@Nonnull public CanSystemConnectionMemo 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

getKnownBeanProperties

@Nonnull public List<NamedBeanPropertyDescriptor<?>> getKnownBeanProperties()

Description copied from class: AbstractManager

By default there are no custom properties.

Specified by:

getKnownBeanProperties in interface Manager<Turnout>

Overrides:

getKnownBeanProperties in class AbstractManager<Turnout>

Returns:

empty list

createNewTurnout

protected Turnout createNewTurnout(@Nonnull String systemName, String userName)

Internal method to invoke the factory, after all the logic for returning an existing method 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:

never null

startLoad

public void startLoad()

This function is invoked before an XML load is started. We defer initialization of the newly created turnouts until finishLoad because the feedback type might be changing as we are parsing the XML.

finishLoad

public void finishLoad()

This function is invoked after the XML load is complete and all turnouts are instantiated and their feedback type is read in. We use this hook to finalize the construction of the OpenLCB objects whose instantiation was deferred until the feedback type was known.

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull String systemName)

Description copied from class: AbstractTurnoutManager

A temporary method that determines if it is possible to add a range of turnouts in numerical order eg 10 to 30, primarily used to enable/disable the Add range box in the Add new turnout panel.

Specified by:

allowMultipleAdditions in interface TurnoutManager

Overrides:

allowMultipleAdditions in class AbstractTurnoutManager

Parameters:

systemName - configured system connection name

Returns:

false as default, unless overridden by implementations as supported

createSystemName

public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException

Description copied from class: AbstractTurnoutManager

Default Turnout ensures a numeric only system name. Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.

Specified by:

createSystemName in interface TurnoutManager

Overrides:

createSystemName in class AbstractTurnoutManager

Parameters:

curAddress - hardware address, no system prefix or type letter.

prefix - - just system prefix, not including Type Letter.

Returns:

full system name with system prefix, type letter and hardware address.

Throws:

JmriException - if unable to create a system name.

getNextValidAddress

public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix, boolean ignoreInitialExisting) throws JmriException

Description copied from class: AbstractManager

Get the Next valid hardware address. Used by the Turnout / Sensor / Reporter / Light Manager classes.

System-specific methods may want to override getIncrement() rather than this one.

Specified by:

getNextValidAddress in interface TurnoutManager

Overrides:

getNextValidAddress in class AbstractManager<Turnout>

Parameters:

curAddress - the starting hardware address to get the next valid from.

prefix - system prefix, just system name, not type letter.

ignoreInitialExisting - false to return the starting address if it does not exist, else true to force an increment.

Returns:

the next valid system name not already in use, excluding both system name prefix and type letter.

Throws:

JmriException - if unable to get the current / next address, or more than 10 next addresses in use.

validateSystemNameFormat

@Nonnull public String validateSystemNameFormat(@Nonnull String name, @Nonnull Locale locale) throws NamedBean.BadSystemNameException

Validates to OpenLCB format. 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.

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

Throws:

NamedBean.BadSystemNameException - if provided name is an invalid format

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