Package jmri.implementation

Class SignalSpeedMap

java.lang.Object

jmri.beans.UnboundBean

jmri.beans.Bean

jmri.implementation.SignalSpeedMap

All Implemented Interfaces:

BeanInterface, PropertyChangeFirer, PropertyChangeProvider, InstanceManagerAutoDefault, InstanceManagerAutoInitialize

public class SignalSpeedMap
extends Bean
implements InstanceManagerAutoDefault, InstanceManagerAutoInitialize

Default implementation to map Signal aspects or appearances to speed requirements.

The singleton instance is referenced from the InstanceManager by SignalHeads and SignalMasts

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PERCENT_NORMAL
static final int	PERCENT_THROTTLE
static final int	SPEED_KMPH
static final int	SPEED_MPH

Fields inherited from class jmri.beans.Bean

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
SignalSpeedMap()

Method Summary

Modifier and Type	Method	Description
boolean	checkSpeed(String name)
Enumeration<String>	getAppearanceIterator()
String	getAppearanceSpeed(String name)	Get speed for a given signal head appearance.
String	getAspectExitSpeed(String aspect, SignalSystem system)
String	getAspectSpeed(String aspect, SignalSystem system)
float	getDefaultThrottleFactor()
int	getInterpretation()
float	getLayoutScale()
String	getNamedSpeed(float speed)
float	getSpeed(String name)
Enumeration<String>	getSpeedIterator()
int	getStepDelay()
float	getStepIncrement()
Vector<String>	getValidSpeedNames()
void	initialize()	Perform any initialization that occurs after this object has been constructed and made available by the InstanceManager.
(package private) void	loadMap()
void	loadRoot(org.jdom2.Element root)
void	setAppearances(HashMap<String,String> map)
void	setAppearanceTable(Iterator<Map.Entry<String,String>> iter)
void	setAspects(HashMap<String,Float> map, int interpretation)
void	setAspectTable(Iterator<Map.Entry<String,Float>> iter, int interpretation)
void	setDefaultThrottleFactor(float f)
void	setLayoutScale(float s)
void	setRampParams(float throttleIncr, int msIncrTime)

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

Field Details

PERCENT_NORMAL

public static final int PERCENT_NORMAL

See Also:

• Constant Field Values

PERCENT_THROTTLE

public static final int PERCENT_THROTTLE

See Also:

• Constant Field Values

SPEED_MPH

public static final int SPEED_MPH

See Also:

• Constant Field Values

SPEED_KMPH

public static final int SPEED_KMPH

See Also:

• Constant Field Values

Constructor Details

SignalSpeedMap

public SignalSpeedMap()

Method Details

initialize

public void initialize()

Description copied from interface: InstanceManagerAutoInitialize

Perform any initialization that occurs after this object has been constructed and made available by the InstanceManager.

Specified by:

initialize in interface InstanceManagerAutoInitialize

loadMap

void loadMap()

loadRoot

public void loadRoot(@Nonnull
 org.jdom2.Element root)

checkSpeed

public boolean checkSpeed(String name)

getAspectSpeed

public String getAspectSpeed(@Nonnull
 String aspect,
 @Nonnull
 SignalSystem system)

Parameters:

aspect - appearance (not called head in US) to check

system - system name of head

Returns:

speed from SignalMast Aspect name

getAspectExitSpeed

public String getAspectExitSpeed(@Nonnull
 String aspect,
 @Nonnull
 SignalSystem system)

Parameters:

aspect - appearance (not called head in US) to check

system - system name of head

Returns:

speed2 from SignalMast Aspect name

getAppearanceSpeed

public String getAppearanceSpeed(@Nonnull
 String name)

Get speed for a given signal head appearance.

Parameters:

name - appearance default name

Returns:

speed from SignalHead Appearance name

getAppearanceIterator

public Enumeration<String> getAppearanceIterator()

getSpeedIterator

public Enumeration<String> getSpeedIterator()

getValidSpeedNames

public Vector<String> getValidSpeedNames()

getSpeed

public float getSpeed(@Nonnull
 String name)
               throws IllegalArgumentException

Throws:

IllegalArgumentException

getNamedSpeed

public String getNamedSpeed(float speed)

getInterpretation

public int getInterpretation()

getStepDelay

public int getStepDelay()

getStepIncrement

public float getStepIncrement()

setAspects

public void setAspects(@Nonnull
 HashMap<String,Float> map,
 int interpretation)

setAspectTable

public void setAspectTable(@Nonnull
 Iterator<Map.Entry<String,Float>> iter,
 int interpretation)

setAppearances

public void setAppearances(@Nonnull
 HashMap<String,String> map)

setAppearanceTable

public void setAppearanceTable(@Nonnull
 Iterator<Map.Entry<String,String>> iter)

setRampParams

public void setRampParams(float throttleIncr,
 int msIncrTime)

setDefaultThrottleFactor

public void setDefaultThrottleFactor(float f)

getDefaultThrottleFactor

public float getDefaultThrottleFactor()

setLayoutScale

public void setLayoutScale(float s)

getLayoutScale

public float getLayoutScale()