jmri
Interface SignalSystem

Show UML class diagram

All Superinterfaces:

NamedBean

All Known Implementing Classes:

DefaultSignalSystem

public interface SignalSystem
extends NamedBean

A SignalSystem defines a signaling system by representing the properties of various signal aspects it contains.

At present, the signal aspects are denumerated by Strings, not by specific objects; this table exists to attach properties to those Strings.

Setting or getting the "state" of one of these will throw an error.

You'll have one of these objects for each signaling _system_ on your railroad. In turn, these will be used by 1 to N specific mappings to appearances, see e.g. DefaultSignalAppearanceMap.

Insertion order is preserved when retrieving keys.

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 inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Method Summary

boolean	checkAspect(String aspect) Is this aspect known?
String	getAspect(Object obj, String key)
Enumeration<String>	getAspects() Get all aspects currently defined.
Enumeration<String>	getImageTypeList() Returns a list of the image/icon sets available for use with this signalling system.
Enumeration<String>	getKeys() Get all keys currently defined on any aspect.
float	getMaximumLineSpeed()
Object	getProperty(String aspect, String key)
void	setImageType(String type) Add an image or icon type available for use with this signalling system
void	setProperty(String aspect, String key, Object value)

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, dispose, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyKeys, getState, getSystemName, getUserName, removeProperty, removePropertyChangeListener, setComment, setProperty, setState, setUserName, updateListenerRef

Method Detail

setProperty

void setProperty(String aspect,
                 String key,
                 Object value)

getProperty

Object getProperty(String aspect,
                   String key)

setImageType

void setImageType(String type)

Add an image or icon type available for use with this signalling system

getImageTypeList

Enumeration<String> getImageTypeList()

Returns a list of the image/icon sets available for use with this signalling system. If no specific image types are provided for then an empty list is returned.

getAspects

Enumeration<String> getAspects()

Get all aspects currently defined.

getKeys

Enumeration<String> getKeys()

Get all keys currently defined on any aspect.

Each key only appears once, even if used on more than one aspect.

Note that a given key may or may not appear on a given aspect.

checkAspect

boolean checkAspect(String aspect)

Is this aspect known?

getAspect

String getAspect(Object obj,
                 String key)

getMaximumLineSpeed

float getMaximumLineSpeed()