jmri.implementation
Class AbstractSignalHead

java.lang.Object
  jmri.implementation.AbstractNamedBean
      jmri.implementation.AbstractSignalHead

All Implemented Interfaces:

Serializable, NamedBean, SignalHead

Direct Known Subclasses:

DccSignalHead, DefaultSignalHead

public abstract class AbstractSignalHead
extends AbstractNamedBean
implements SignalHead, Serializable

Abstract class providing the basic logic of the SignalHead interface.

Author:

Bob Jacobsen Copyright (C) 2001

See Also:

Serialized Form

Field Summary

protected int	mAppearance
protected boolean	mHeld By default, signals are not held.
protected boolean	mLit By default, signals are lit.
static String[]	validStateNames
static int[]	validStates

Fields inherited from interface jmri.SignalHead

DARK, FLASHGREEN, FLASHLUNAR, FLASHRED, FLASHYELLOW, GREEN, LUNAR, RED, YELLOW

Fields inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Constructor Summary

AbstractSignalHead(String systemName)

AbstractSignalHead(String systemName, String userName)

Method Summary

int	getAppearance() Appearance is a bound parameter.
String	getAppearanceName()
String	getAppearanceName(int appearance)
static String	getDefaultStateName(int appearance)
static String[]	getDefaultValidStateNames()
static int[]	getDefaultValidStates()
boolean	getHeld() "Held" parameter is just tracked and notified.
boolean	getLit() Default behavior for "lit" parameter is to track value and return it.
int	getState() Implement a shorter name for getAppearance.
String[]	getValidStateNames()
int[]	getValidStates()
void	setState(int s) Implement a shorter name for setAppearance.

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, dispose, firePropertyChange, getComment, getDisplayName, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.SignalHead

setAppearance, setHeld, setLit

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, dispose, getComment, getDisplayName, getNumPropertyChangeListeners, getProperty, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName

Field Detail

mAppearance

protected int mAppearance

mLit

protected boolean mLit

By default, signals are lit.

mHeld

protected boolean mHeld

By default, signals are not held.

validStates

public static final int[] validStates

validStateNames

public static final String[] validStateNames

Constructor Detail

AbstractSignalHead

public AbstractSignalHead(String systemName,
                          String userName)

AbstractSignalHead

public AbstractSignalHead(String systemName)

Method Detail

getAppearanceName

public String getAppearanceName(int appearance)

Specified by:

getAppearanceName in interface SignalHead

getAppearanceName

public String getAppearanceName()

Specified by:

getAppearanceName in interface SignalHead

getAppearance

public int getAppearance()

Description copied from interface: SignalHead

Appearance is a bound parameter.

Specified by:

getAppearance in interface SignalHead

getLit

public boolean getLit()

Default behavior for "lit" parameter is to track value and return it.

Specified by:

getLit in interface SignalHead

getHeld

public boolean getHeld()

"Held" parameter is just tracked and notified.

Specified by:

getHeld in interface SignalHead

setState

public void setState(int s)

Implement a shorter name for setAppearance.

This generally shouldn't be used by Java code; use setAppearance instead. The is provided to make Jython script access easier to read.

Specified by:

setState in interface NamedBean

getState

public int getState()

Implement a shorter name for getAppearance.

This generally shouldn't be used by Java code; use getAppearance instead. The is provided to make Jython script access easier to read.

Specified by:

getState in interface NamedBean

getDefaultValidStates

public static int[] getDefaultValidStates()

getDefaultValidStateNames

public static String[] getDefaultValidStateNames()

getDefaultStateName

public static String getDefaultStateName(int appearance)

getValidStates

public int[] getValidStates()

Specified by:

getValidStates in interface SignalHead

getValidStateNames

public String[] getValidStateNames()

Specified by:

getValidStateNames in interface SignalHead