Package jmri.implementation

Class DefaultCabSignal

java.lang.Object

jmri.implementation.DefaultCabSignal

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, CabSignal

Direct Known Subclasses:

CbusCabSignal, LnCabSignal

public class DefaultCabSignal
extends java.lang.Object
implements CabSignal, java.beans.PropertyChangeListener

Default implementation of a Cab Signal Object, describing the state of the track ahead relative to a locomotive with a given address. This is effectively a mobile signal mast.

Constructor Summary

Constructors

Constructor	Description
DefaultCabSignal(LocoAddress address)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)	Add a listener for consist events
void	dispose()	A method for cleaning up the cab signal
protected void	firePropertyChange(java.lang.String p, java.lang.Object old, java.lang.Object n)
protected void	forwardAspectToLayout()	Forward the command to the layout that sets the displayed signal aspect for this address
void	forwardCabSignalToLayout()	Forward the current cab signal value to the layout.
Block	getBlock()	Get the Block position of the locomotive associated with the cab signal.
java.util.List<Block>	getBlockList()	Get Block List to the end of Path or Signal Mast Stop, whichever first.
LocoAddress	getCabSignalAddress()	Get the LocoAddress associated with the consist
Block	getNextBlock()	Get the Next Block the locomotive is expected to enter.
SignalMast	getNextMast()	Get the Next Signal Mast the locomotive is expected to pass.
boolean	isCabSignalActive()
void	propertyChange(java.beans.PropertyChangeEvent event)
void	removePropertyChangeListener(java.beans.PropertyChangeListener l)	Remove a listener for cab signal events
protected void	resetLayoutCabSignal()	Forward the command to the layout that clears any displayed signal for this address
void	setBlock()	Set the Block of the locomotive by searching the block list.
void	setBlock(Block position)	Set the Block of the locomotive
void	setCabSignalActive(boolean active)
void	setMasterCabSigPauseActive(boolean active)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCabSignal

public DefaultCabSignal(LocoAddress address)

Method Detail

dispose

@OverridingMethodsMustInvokeSuper
public void dispose()

A method for cleaning up the cab signal

Specified by:

dispose in interface CabSignal

getCabSignalAddress

public LocoAddress getCabSignalAddress()

Get the LocoAddress associated with the consist

Specified by:

getCabSignalAddress in interface CabSignal

Returns:

the cab signal address

setBlock

public void setBlock(Block position)

Set the Block of the locomotive

Specified by:

setBlock in interface CabSignal

Parameters:

position - is a Block the locomotive is in.

setBlock

public void setBlock()

Set the Block of the locomotive by searching the block list.

Specified by:

setBlock in interface CabSignal

getBlock

public Block getBlock()

Get the Block position of the locomotive associated with the cab signal.

Specified by:

getBlock in interface CabSignal

Returns:

The current Block position

getNextBlock

public Block getNextBlock()

Get the Next Block the locomotive is expected to enter. This value is calculated from the current block and direction of travel.

Specified by:

getNextBlock in interface CabSignal

Returns:

The next Block position

getNextMast

public SignalMast getNextMast()

Get the Next Signal Mast the locomotive is expected to pass. This value is calculated from the current block and direction of travel.

Specified by:

getNextMast in interface CabSignal

Returns:

The next SignalMast position

getBlockList

@Nonnull
public java.util.List<Block> getBlockList()

Get Block List to the end of Path or Signal Mast Stop, whichever first. The first Block in the list ( if any ), will be the current Block.

Specified by:

getBlockList in interface CabSignal

Returns:

list of Blocks that the loco address is expected to traverse.

forwardCabSignalToLayout

public void forwardCabSignalToLayout()

Forward the current cab signal value to the layout.

Specified by:

forwardCabSignalToLayout in interface CabSignal

forwardAspectToLayout

protected void forwardAspectToLayout()

Forward the command to the layout that sets the displayed signal aspect for this address

isCabSignalActive

public boolean isCabSignalActive()

Specified by:

isCabSignalActive in interface CabSignal

setCabSignalActive

public void setCabSignalActive(boolean active)

Specified by:

setCabSignalActive in interface CabSignal

setMasterCabSigPauseActive

public void setMasterCabSigPauseActive(boolean active)

Specified by:

setMasterCabSigPauseActive in interface CabSignal

resetLayoutCabSignal

protected void resetLayoutCabSignal()

Forward the command to the layout that clears any displayed signal for this address

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Add a listener for consist events

Specified by:

addPropertyChangeListener in interface CabSignal

Parameters:

l - is a PropertyChangeListener object

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Remove a listener for cab signal events

Specified by:

removePropertyChangeListener in interface CabSignal

Parameters:

l - is a PropertyChangeListener object

firePropertyChange

protected void firePropertyChange(java.lang.String p,
                                  java.lang.Object old,
                                  java.lang.Object n)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent event)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object