jmri
Interface SignalAppearanceMap

All Known Implementing Classes:

DefaultSignalAppearanceMap

public interface SignalAppearanceMap

Access to signal apperance information.

Maps to an appearance* file in a signal system. This interface does not provide any methods to change the map.

Author:

Bob Jacobsen Copyright (C) 2010

Field Summary

static int	DANGER Constant representing the "danager" apsect for a signal
static int	DARK Constant representing the "dark" apsect for a signal
static int	HELD Constant representing the "held" apsect for a signal
static int	PERMISSIVE Constant representing the "permissive" apsect for a signal

Method Summary

boolean	checkAspect(String aspect) Check if an aspect can be displayed by this particular Map
Enumeration<String>	getAspects() Get all available aspect names
String	getImageLink(String aspect, String key) Get an Image Link associated with a specific aspect and type
Vector<String>	getImageTypes(String aspect) Return a list of valid icon sets
String	getProperty(String aspect, String key) Get a property associated with a specific aspect
SignalSystem	getSignalSystem() Get the associated signal system and the common information it contains
String	getSpecificAppearance(int appearance) Return an aspect for a specific appearance
String[]	getValidAspectsForAdvancedAspect(String advancedAspect) Returns a list of postential aspects that we could set the signalmast to given the state of the advanced signal mast.
void	setAppearances(String aspect, List<NamedBeanHandle<SignalHead>> heads) Set the associated SignalHeads to the appropriate appearance for a specified aspect.

Field Detail

HELD

static final int HELD

Constant representing the "held" apsect for a signal

See Also:

Constant Field Values

PERMISSIVE

static final int PERMISSIVE

Constant representing the "permissive" apsect for a signal

See Also:

Constant Field Values

DANGER

static final int DANGER

Constant representing the "danager" apsect for a signal

See Also:

Constant Field Values

DARK

static final int DARK

Constant representing the "dark" apsect for a signal

See Also:

Constant Field Values

Method Detail

setAppearances

void setAppearances(String aspect,
                    List<NamedBeanHandle<SignalHead>> heads)

Set the associated SignalHeads to the appropriate appearance for a specified aspect.

Does not change state of map, just of the SignalHeads in the list.

checkAspect

boolean checkAspect(String aspect)

Check if an aspect can be displayed by this particular Map

getAspects

Enumeration<String> getAspects()

Get all available aspect names

getSignalSystem

SignalSystem getSignalSystem()

Get the associated signal system and the common information it contains

getProperty

String getProperty(String aspect,
                   String key)

Get a property associated with a specific aspect

getImageLink

String getImageLink(String aspect,
                    String key)

Get an Image Link associated with a specific aspect and type

getImageTypes

Vector<String> getImageTypes(String aspect)

Return a list of valid icon sets

getSpecificAppearance

String getSpecificAppearance(int appearance)

Return an aspect for a specific appearance

getValidAspectsForAdvancedAspect

String[] getValidAspectsForAdvancedAspect(String advancedAspect)

Returns a list of postential aspects that we could set the signalmast to given the state of the advanced signal mast.