Package jmri.jmrix.can.cbus

Class CbusLightManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Light>

jmri.managers.AbstractLightManager

jmri.jmrix.can.cbus.CbusLightManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LightManager, Manager<Light>, ProvidingManager<Light>

public class CbusLightManager
extends AbstractLightManager

Implement LightManager for CAN CBUS systems.

System names are "ML+n;-m", where M is the user configurable system prefix, n and m are the events (signed for on/off, separated by ;).

Lights must be explicitly created, they are not polled.

Since:

3.11.7

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
CbusLightManager(CanSystemConnectionMemo memo)	Ctor using a given system connection memo

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	Test if possible to generate multiple lights given a numerical range to complete the system name.
protected Light	createNewLight(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)	Create a System Name from hardware address and system letter prefix.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
protected String	getIncrement(String curAddress, int increment)	Only increments by 1, which is fine for CBUS Lights.
CanSystemConnectionMemo	getMemo()	Get the system connection for this manager.
String	validateSystemNameFormat(String name, Locale locale)	Validate the format of name, returning it unchanged if valid.
boolean	validSystemNameConfig(String systemName)	Test if parameter is a valid system name for current configuration.
Manager.NameValidity	validSystemNameFormat(String systemName)	Test if parameter is a properly formatted system name.

Methods inherited from class jmri.managers.AbstractLightManager

activateAllLights, convertSystemNameToAlternate, getBeanTypeHandled, getLight, getNamedBeanClass, getXMLOrder, newLight, provideLight, supportsVariableLights, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, 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.LightManager

dispose, getBySystemName, getByUserName, getNextValidAddress, provide

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, 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

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.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Details

CbusLightManager

public CbusLightManager(CanSystemConnectionMemo memo)

Ctor using a given system connection memo

Parameters:

memo - System Connection

Method Details

getMemo

@Nonnull public CanSystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Light>

Overrides:

getMemo in class AbstractManager<Light>

Returns:

the system connection for this manager

createNewLight

protected Light createNewLight(@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:

createNewLight in class AbstractLightManager

Parameters:

systemName - the system name to use for this light

userName - the user name to use for this light

Returns:

never null

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull String systemName)

Test if possible to generate multiple lights given a numerical range to complete the system name.

Specified by:

allowMultipleAdditions in interface LightManager

Overrides:

allowMultipleAdditions in class AbstractLightManager

Parameters:

systemName - the system name

Returns:

true if multiple lights can be created at once; false otherwise

validateSystemNameFormat

@Nonnull public String validateSystemNameFormat(@Nonnull String name, @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.

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

Overrides:

validSystemNameFormat in class AbstractManager<Light>

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.

createSystemName

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

Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.

Specified by:

createSystemName in interface LightManager

Overrides:

createSystemName in class AbstractManager<Light>

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.

validSystemNameConfig

public boolean validSystemNameConfig(@Nonnull String systemName)

Test if parameter is a valid system name for current configuration.

Parameters:

systemName - the system name

Returns:

true if valid; false otherwise

getIncrement

@Nonnull protected String getIncrement(String curAddress, int increment) throws JmriException

Only increments by 1, which is fine for CBUS Lights. Increment a hardware address.

Default is to increment only an existing number. Sub-classes may wish to override this.

Overrides:

getIncrement in class AbstractManager<Light>

Parameters:

curAddress - the address to increment, excluding both system name prefix and type letter.

increment - the amount to increment by.

Returns:

incremented address, no system prefix or type letter.

Throws:

JmriException - if unable to increment the address.

getEntryToolTip

public String getEntryToolTip()

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

Specified by:

getEntryToolTip in interface Manager<Light>

Overrides:

getEntryToolTip in class AbstractLightManager

Returns:

the tool tip or null to disable the tool tip