Package jmri
Interface SignalAppearanceMap
- All Known Implementing Classes:
DefaultSignalAppearanceMap
public interface SignalAppearanceMap
Access to signal appearance information.
Maps to an appearance file in a signal system. This interface does not provide any methods to change the map.
-
Field Summary
Fields Modifier and Type Field Description static int
DANGER
Constant representing the "danger" aspect for a signalstatic int
DARK
Constant representing the "dark" aspect for a signalstatic int
HELD
Constant representing the "held" aspect for a signalstatic int
PERMISSIVE
Constant representing the "permissive" aspect for a signal -
Method Summary
Modifier and Type Method Description boolean
checkAspect(String aspect)
Check if an aspect can be displayed.Enumeration<String>
getAspects()
Get all available aspect names.String
getImageLink(String aspect, String key)
Get an Image Link associated with a specific aspect and typeVector<String>
getImageTypes(String aspect)
Get a list of valid icon sets.String
getProperty(String aspect, String key)
Get a property associated with a specific aspectSignalSystem
getSignalSystem()
Get the associated signal system and the common information it contains.String
getSpecificAppearance(int appearance)
Return the aspect for a specific appearance.String[]
getValidAspectsForAdvancedAspect(String advancedAspect)
Get a list of potential aspects that we could set the SignalMast to, given the state of the advanced signal mast.String
summary()
Provide a multi-line summary of the signal system content, typically for printing.
-
Field Details
-
HELD
Constant representing the "held" aspect for a signal- See Also:
- Constant Field Values
-
PERMISSIVE
Constant representing the "permissive" aspect for a signal- See Also:
- Constant Field Values
-
DANGER
Constant representing the "danger" aspect for a signal- See Also:
- Constant Field Values
-
DARK
Constant representing the "dark" aspect for a signal- See Also:
- Constant Field Values
-
-
Method Details
-
checkAspect
Check if an aspect can be displayed.- Parameters:
aspect
- the aspect to check- Returns:
- true if the aspect can be displayed; false otherwise
-
getAspects
Get all available aspect names.- Returns:
- an enumeration of available aspects
-
getSignalSystem
Get the associated signal system and the common information it contains.- Returns:
- the signal system
-
getProperty
Get a property associated with a specific aspect- Parameters:
aspect
- the aspect containing the propertykey
- the property key- Returns:
- the property value or null if none is defined for key
-
getImageLink
Get an Image Link associated with a specific aspect and type- Parameters:
aspect
- the aspectkey
- the image link key- Returns:
- the image link or an empty String if none is defined
-
getImageTypes
Get a list of valid icon sets.- Parameters:
aspect
- the aspect to get icon sets for- Returns:
- a list of sets or an empty list if none are defined
-
getSpecificAppearance
Return the aspect for a specific appearance.- Parameters:
appearance
- the appearance- Returns:
- the aspect
-
getValidAspectsForAdvancedAspect
Get a list of potential aspects that we could set the SignalMast to, given the state of the advanced signal mast.- Parameters:
advancedAspect
- the aspect- Returns:
- a string array of potential aspects or null if none defined
-
summary
Provide a multi-line summary of the signal system content, typically for printing.Not intended for further parsing, i.e. for persistence, as format likely to differ from type to type, and to change often.
- Returns:
- summary string.
-