jmri.jmrit.vsdecoder.VSDecoderManager

All Implemented Interfaces:: PropertyChangeListener, EventListener

public class VSDecoderManager
extends Object
implements PropertyChangeListener

VSDecoderFactory, builds VSDecoders as needed, handles loading from XML if needed.

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) HashMap<String,VSDecoder>`	`decoderAddressMap`
`(package private) HashMap<Integer,VSDecoder>`	`decoderInBlock`
`(package private) HashMap<String,VSDecoder>`	`decodertable`
`(package private) boolean`	`geofile_ok`
`(package private) boolean`	`is_tunnel`
`protected EventListenerList`	`listenerList`
`(package private) HashMap<String,VSDListener>`	`listenerTable`
`static int`	`max_decoder`
`protected NamedBeanHandleManager`	`nbhm`
`(package private) int`	`num_setups`
`(package private) HashMap<String,String>`	`profiletable`

Constructor Summary

Constructors

Constructor Description

VSDecoderManager()

Method Summary

Modifier and Type	Method	Description
`void`	`addEventListener(VSDManagerListener listener)`
`void`	`blockPropertyChange(PropertyChangeEvent event)`
`void`	`calcNewPosition(VSDecoder d)`
`void`	`deleteDecoder(String address)`	Delete a VSDecoder
`(package private) void`	`fireMyEvent(VSDManagerEvent evt)`
`int`	`getArrayIndex(int number)`	Get index of a decoder.
`ListeningSpot`	`getDefaultListenerLocation()`	Get the VSD listener location.
`String`	`getDefaultListenerName()`	Get the VSD listener system name.
`VSDecoder`	`getDefaultVSDecoder()`	Deprecated. As of 4.23.3, without a replacement
`int`	`getMasterVolume()`	Get the master volume of all VSDecoders.
`int`	`getNumberOfDecoders()`	Deprecated. As of 4.23.3, use `getVSDecoderList()` instead
`String`	`getProfilePath(String profile)`	Retrieve the Path for a given Profile name.
`VSDecoder`	`getVSDecoder(String profile_name, String path)`	Deprecated. As of 4.23.3, use `getVSDecoder(VSDConfig config)` instead
`VSDecoder`	`getVSDecoder(VSDConfig config)`	Provide or build a VSDecoder based on a provided configuration.
`VSDecoder`	`getVSDecoderByAddress(String sa)`	Get a VSDecoder by its address.
`VSDecoder`	`getVSDecoderByID(String id)`	Get a VSDecoder by its Id.
`Collection<VSDecoder>`	`getVSDecoderList()`	Get a list of all VSDecoders.
`VSDecoderPreferences`	`getVSDecoderPreferences()`	Get a reference to the VSD Preferences.
`ArrayList<String>`	`getVSDProfileNames()`	Get a list of all profiles.
`(package private) void`	`initSoundPositionTimer(VSDecoder d)`
`static VSDecoderManager`	`instance()`	Provide the VSdecoderManager instance.
`void`	`loadProfiles(VSDFile vf)`
`void`	`locoInBlockRemove(int numb)`
`void`	`propertyChange(PropertyChangeEvent evt)`
`JmriJFrame`	`provideManagerFrame()`	Get the VSD GUI.
`protected void`	`registerBeanListener(Manager beanManager, String sysName)`
`protected void`	`registerReporterListener(String sysName)`
`protected void`	`registerReporterListeners()`
`void`	`removeEventListener(VSDManagerListener listener)`
`void`	`reporterManagerPropertyChange(PropertyChangeEvent event)`
`void`	`reporterPropertyChange(PropertyChangeEvent event)`
`void`	`reporterPropertyChangeGeo(PropertyChangeEvent event)`
`void`	`setDecoderPositionByAddr(LocoAddress a, PhysicalLocation l)`
`void`	`setDecoderPositionByID(String id, PhysicalLocation p)`
`void`	`setDefaultVSDecoder(VSDecoder d)`	Deprecated. As of 4.23.3, without a replacement
`void`	`setListenerLocation(String id, ListeningSpot sp)`
`void`	`setMasterVolume(int mv)`	Set the master volume for all VSDecoders.
`(package private) void`	`startSoundPositionTimer(VSDecoder d)`
`(package private) void`	`stopSoundPositionTimer(VSDecoder d)`

Methods inherited from class java.lang.Object

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

Field Details
- nbhm
  
  protected NamedBeanHandleManager nbhm
- listenerTable
  
  HashMap<String,VSDListener> listenerTable
- decodertable
  
  HashMap<String,VSDecoder> decodertable
- decoderAddressMap
  
  HashMap<String,VSDecoder> decoderAddressMap
- decoderInBlock
  
  HashMap<Integer,VSDecoder> decoderInBlock
- profiletable
  
  HashMap<String,String> profiletable
- listenerList
  
  protected EventListenerList listenerList
- max_decoder
  
  public static final int max_decoder
  
  See Also:
  
  Constant Field Values
- is_tunnel
  
  boolean is_tunnel
- geofile_ok
  
  boolean geofile_ok
- num_setups
  
  int num_setups
Constructor Details
- VSDecoderManager
  
  public VSDecoderManager()
Method Details
- instance
  
  public static VSDecoderManager instance()
  
  Provide the VSdecoderManager instance.
  
  Returns:
  
  the manager
- getVSDecoderPreferences
  
  public VSDecoderPreferences getVSDecoderPreferences()
  
  Get a reference to the VSD Preferences.
  
  Returns:
  
  the preferences reference
- getMasterVolume
  
  public int getMasterVolume()
  
  Get the master volume of all VSDecoders.
  
  Returns:
  
  the master volume
- setMasterVolume
  
  public void setMasterVolume(int mv)
  
  Set the master volume for all VSDecoders.
  
  Parameters:
  
  mv - The new master volume
- provideManagerFrame
  
  public JmriJFrame provideManagerFrame()
  
  Get the VSD GUI.
  
  Returns:
  
  the VSD frame
- getVSDecoder
  
  @Deprecated public VSDecoder getVSDecoder(String profile_name, String path)
  
  Deprecated.
  As of 4.23.3, use getVSDecoder(VSDConfig config) instead
  
  Get the VSdecoder.
  
  Parameters:
  
  profile_name - the profile name
  
  path - the path
  
  Returns:
  
  the VSdecoder
- getVSDecoder
  
  public VSDecoder getVSDecoder(VSDConfig config)
  
  Provide or build a VSDecoder based on a provided configuration.
  
  Parameters:
  
  config - previous configuration, not null.
  
  Returns:
  
  vsdecoder, or null on error.
- getVSDecoderByID
  
  public VSDecoder getVSDecoderByID(String id)
  
  Get a VSDecoder by its Id.
  
  Parameters:
  
  id - The Id of the VSDecoder
  
  Returns:
  
  vsdecoder, or null on error.
- getVSDecoderByAddress
  
  public VSDecoder getVSDecoderByAddress(String sa)
  
  Get a VSDecoder by its address.
  
  Parameters:
  
  sa - The address of the VSDecoder
  
  Returns:
  
  vsdecoder, or null on error.
- setDefaultVSDecoder
  
  @Deprecated public void setDefaultVSDecoder(VSDecoder d)
  
  Deprecated.
  As of 4.23.3, without a replacement
  
  Set a VSDecoder to be the default.
  
  Parameters:
  
  d - The VSDecoder
- getDefaultVSDecoder
  
  @Deprecated public VSDecoder getDefaultVSDecoder()
  
  Deprecated.
  As of 4.23.3, without a replacement
  
  Get the default VSDecoder.
  
  Returns:
  
  The VSDecoder
- getVSDProfileNames
  
  public ArrayList<String> getVSDProfileNames()
  
  Get a list of all profiles.
  
  Returns:
  
  sl The profiles list.
- getVSDecoderList
  
  public Collection<VSDecoder> getVSDecoderList()
  
  Get a list of all VSDecoders.
  
  Returns:
  
  the VSDecoder list.
- getDefaultListenerName
  
  public String getDefaultListenerName()
  
  Get the VSD listener system name.
  
  Returns:
  
  the system name.
- getDefaultListenerLocation
  
  public ListeningSpot getDefaultListenerLocation()
  
  Get the VSD listener location.
  
  Returns:
  
  the location or null.
- setListenerLocation
  
  public void setListenerLocation(String id, ListeningSpot sp)
- setDecoderPositionByID
  
  public void setDecoderPositionByID(String id, PhysicalLocation p)
- setDecoderPositionByAddr
  
  public void setDecoderPositionByAddr(LocoAddress a, PhysicalLocation l)
- addEventListener
  
  public void addEventListener(VSDManagerListener listener)
- removeEventListener
  
  public void removeEventListener(VSDManagerListener listener)
- fireMyEvent
  
  void fireMyEvent(VSDManagerEvent evt)
- getProfilePath
  
  public String getProfilePath(String profile)
  
  Retrieve the Path for a given Profile name.
  
  Parameters:
  
  profile - the profile to get the path for
  
  Returns:
  
  the path for the profile
- registerReporterListener
  
  protected void registerReporterListener(String sysName)
- registerBeanListener
  
  protected void registerBeanListener(Manager beanManager, String sysName)
- registerReporterListeners
  
  protected void registerReporterListeners()
- deleteDecoder
  
  public void deleteDecoder(String address)
  
  Delete a VSDecoder
  
  Parameters:
  
  address - The DCC address of the VSDecoder
- propertyChange
  
  public void propertyChange(PropertyChangeEvent evt)
  
  Specified by:
  
  propertyChange in interface PropertyChangeListener
- blockPropertyChange
  
  public void blockPropertyChange(PropertyChangeEvent event)
- reporterPropertyChange
  
  public void reporterPropertyChange(PropertyChangeEvent event)
- reporterPropertyChangeGeo
  
  public void reporterPropertyChangeGeo(PropertyChangeEvent event)
- reporterManagerPropertyChange
  
  public void reporterManagerPropertyChange(PropertyChangeEvent event)
- getArrayIndex
  
  public int getArrayIndex(int number)
  
  Get index of a decoder.
  
  Parameters:
  
  number - The loco address number.
  
  Returns:
  
  the index of a decoder's loco address number in the array or the length of the array.
- getNumberOfDecoders
  
  @Deprecated public int getNumberOfDecoders()
  
  Deprecated.
  As of 4.23.3, use getVSDecoderList() instead
  
  Get number of decoders.
  
  Returns:
  
  the number of decoders
- locoInBlockRemove
  
  public void locoInBlockRemove(int numb)
- loadProfiles
  
  public void loadProfiles(VSDFile vf)
- initSoundPositionTimer
  
  void initSoundPositionTimer(VSDecoder d)
- startSoundPositionTimer
  
  void startSoundPositionTimer(VSDecoder d)
- stopSoundPositionTimer
  
  void stopSoundPositionTimer(VSDecoder d)
- calcNewPosition
  
  public void calcNewPosition(VSDecoder d)

Class VSDecoderManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details