jmri.jmrix.openlcb.OlcbSystemConnectionMemo

All Implemented Interfaces:: BeanInterface, PropertyChangeFirer, PropertyChangeProvider, Disposable, ConfiguringSystemConnectionMemo, SystemConnectionMemo

public class OlcbSystemConnectionMemo
extends CanSystemConnectionMemo

Lightweight class to denote that a system is active, and provide general information.

Objects of specific subtypes are registered in the instance manager to activate their particular system.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) ComponentFactory`	`cf`
`protected org.openlcb.OlcbInterface`	`olcbInterface`
`protected OlcbProgrammerManager`	`programmerManager`
`protected OlcbSensorManager`	`sensorManager`
`protected OlcbThrottleManager`	`throttleManager`
`protected OlcbTurnoutManager`	`turnoutManager`

Fields inherited from class jmri.jmrix.can.CanSystemConnectionMemo

_progModeSwitch, _protocol, _subProtocol, DEFAULT_USERNAME, tm

Fields inherited from class jmri.jmrix.DefaultSystemConnectionMemo

classObjectMap

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Fields inherited from interface jmri.SystemConnectionMemo

DISABLED, INTERVAL, SYSTEM_PREFIX, USER_NAME

Constructor Summary

Constructors

Constructor Description

OlcbSystemConnectionMemo()

Method Summary

Modifier and Type	Method	Description
`static int`	`compareSystemNameSuffix(String suffix1, String suffix2)`	See `NamedBean.compareSystemNameSuffix(java.lang.String, java.lang.String, jmri.NamedBean)` for background.
`void`	`configureManagers()`	Configure the common managers for the connection.
`void`	`dispose()`	Called when disposing of a disposable.
`<T> T`	`get(Class<?> T)`	Get a manager for a specific type.
`protected ResourceBundle`	`getActionModelResourceBundle()`
`org.openlcb.OlcbInterface`	`getInterface()`
`OlcbProgrammerManager`	`getProgrammerManager()`
`OlcbSensorManager`	`getSensorManager()`
`OlcbThrottleManager`	`getThrottleManager()`
`OlcbTurnoutManager`	`getTurnoutManager()`
`boolean`	`provides(Class<?> type)`	Tells which managers this class provides.
`void`	`setInterface(org.openlcb.OlcbInterface iface)`
`void`	`setProgrammerManager(OlcbProgrammerManager p)`

Methods inherited from class jmri.jmrix.can.CanSystemConnectionMemo

getDefaultOutputInterval, getNamedBeanComparator, getProgModeSwitch, getProtocol, getProtocolAllOptions, getProtocolOption, getProtocolsWithOptions, getSubProtocol, getTrafficController, isDirty, isRestartRequired, setProgModeSwitch, setProtocol, setProtocolOption, setSubProtocol, setTrafficController, storeCanMemotoInstance

Methods inherited from class jmri.jmrix.DefaultSystemConnectionMemo

addToActionList, deregister, getActionFactory, getConsistManager, getDisabled, getOutputInterval, getSystemPrefix, getUserName, register, removeFromActionList, setConsistManager, setDisabled, setOutputInterval, setSystemPrefix, setUserName, store

Methods inherited from class jmri.beans.Bean

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

Methods inherited from class jmri.beans.UnboundBean

getIndexedProperty, getProperty, getPropertyNames, hasIndexedProperty, hasProperty, setIndexedProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.SystemConnectionMemo

getActionFactory, getDisabled, getOutputInterval, getSystemPrefix, getUserName, register, setDisabled, setOutputInterval, setSystemPrefix, setUserName

Field Details
- cf
  
  final ComponentFactory cf
- programmerManager
  
  protected OlcbProgrammerManager programmerManager
- turnoutManager
  
  protected OlcbTurnoutManager turnoutManager
- throttleManager
  
  protected OlcbThrottleManager throttleManager
- sensorManager
  
  protected OlcbSensorManager sensorManager
- olcbInterface
  
  protected org.openlcb.OlcbInterface olcbInterface
Constructor Details
- OlcbSystemConnectionMemo
  
  public OlcbSystemConnectionMemo()
Method Details
- provides
  
  public boolean provides(Class<?> type)
  
  Tells which managers this class provides.
  
  Specified by:
  
  provides in interface SystemConnectionMemo
  
  Overrides:
  
  provides in class CanSystemConnectionMemo
  
  Parameters:
  
  type - The class type for the manager to be provided
  
  Returns:
  
  true if the specified manager is provided
  
  See Also:
  
  DefaultSystemConnectionMemo.get(java.lang.Class)
- get
  
  public <T> T get(Class<?> T)
  
  Description copied from class: CanSystemConnectionMemo
  
  Get a manager for a specific type. This method must return a non-null value if DefaultSystemConnectionMemo.provides(java.lang.Class) is true for the type, and must return null if provides() is false for the type.
  
  Specified by:
  
  get in interface SystemConnectionMemo
  
  Overrides:
  
  get in class CanSystemConnectionMemo
  
  Type Parameters:
  
  T - Type of manager to get
  
  Parameters:
  
  T - Type of manager to get
  
  Returns:
  
  The manager or null if provides() is false for T
  
  See Also:
  
  DefaultSystemConnectionMemo.provides(java.lang.Class)
- configureManagers
  
  public void configureManagers()
  
  Configure the common managers for the connection. This puts the common manager config in one place.
  
  Specified by:
  
  configureManagers in interface ConfiguringSystemConnectionMemo
  
  Overrides:
  
  configureManagers in class CanSystemConnectionMemo
- getProgrammerManager
  
  public OlcbProgrammerManager getProgrammerManager()
- setProgrammerManager
  
  public void setProgrammerManager(OlcbProgrammerManager p)
- getTurnoutManager
  
  public OlcbTurnoutManager getTurnoutManager()
- getThrottleManager
  
  public OlcbThrottleManager getThrottleManager()
- getSensorManager
  
  public OlcbSensorManager getSensorManager()
- getInterface
  
  public org.openlcb.OlcbInterface getInterface()
- setInterface
  
  public void setInterface(org.openlcb.OlcbInterface iface)
- getActionModelResourceBundle
  
  protected ResourceBundle getActionModelResourceBundle()
  
  Description copied from class: CanSystemConnectionMemo
  
  Overrides:
  
  getActionModelResourceBundle in class CanSystemConnectionMemo
- dispose
  
  public void dispose()
  
  Description copied from class: CanSystemConnectionMemo
  
  Called when disposing of a disposable.
  Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.
  
  Specified by:
  
  dispose in interface Disposable
  
  Specified by:
  
  dispose in interface SystemConnectionMemo
  
  Overrides:
  
  dispose in class CanSystemConnectionMemo
- compareSystemNameSuffix
  
  @CheckReturnValue public static int compareSystemNameSuffix(@Nonnull String suffix1, @Nonnull String suffix2)
  
  See NamedBean.compareSystemNameSuffix(java.lang.String, java.lang.String, jmri.NamedBean) for background. This is a common implementation for OpenLCB Sensors and Turnouts of the comparison method.
  
  Parameters:
  
  suffix1 - 1st suffix to compare.
  
  suffix2 - 2nd suffix to compare.
  
  Returns:
  
  true if suffixes match, else false.

Class OlcbSystemConnectionMemo