Package jmri.jmrit.entryexit

Class DestinationPoints

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.entryexit.DestinationPoints

All Implemented Interfaces:

Comparable<NamedBean>, PropertyChangeProvider, NamedBean

public class DestinationPoints
extends AbstractNamedBean

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	entryExitType
(package private) JButton	jButton_Stack
(package private) Object	lastSeenActiveBlockObject
(package private) EntryExitPairs	manager
(package private) static final int	NXMESSAGEBOXCLEARTIMEOUT
(package private) PointDetails	point
static final String	PROPERTY_ACTIVE	String constant for active.
static final String	PROPERTY_FAILED	String constant for failed.
static final String	PROPERTY_NO_CHANGE	String constant for no change.
static final String	PROPERTY_STACKED	String constant for stacked.
protected PropertyChangeListener	propertyBlockListener
(package private) SignalMastLogic	sml
(package private) Source	src

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DestinationPoints(PointDetails point, String id, Source src)

Method Summary

Modifier and Type	Method	Description
(package private) void	activeBean(boolean reverseDirection)
(package private) void	activeBean(boolean reverseDirection, boolean showMessage)
protected void	blockStateUpdated(PropertyChangeEvent e)
(package private) void	cancelClearInterlock(int cancelClear)
(package private) void	cancelClearOptionBox()
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
String	getBeanType()	For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
PointDetails	getDestPoint()
(package private) int	getEntryExitType()
(package private) LayoutBlock	getFacing()
(package private) List<LayoutBlock>	getProtecting()
(package private) NamedBean	getSignal()
Source	getSource()
int	getState()	Provide generic access to internal state.
(package private) boolean	getUniDirection()
(package private) String	getUniqueId()
List<NamedBeanUsageReport>	getUsageReport(NamedBean bean)	Get a list of references for the specified bean.
(package private) void	handleNoCurrentRoute(boolean reverse, String message)
boolean	isActive()
boolean	isEnabled()	public for testing purposes.
boolean	isReversed()
(package private) boolean	isRouteToPointSet()
boolean	isUniDirection()
(package private) void	removeBlockFromRoute(LayoutBlock lBlock)
protected void	setActiveEntryExit(boolean boo)
protected void	setActiveEntryExit(boolean boo, boolean reversed)
void	setEnabled(boolean boo)
(package private) void	setEntryExitType(int type)
void	setInterlockRoute(boolean reverseDirection)
(package private) void	setRoute(boolean state)
(package private) void	setRouteFrom(boolean set)
(package private) void	setRouteTo(boolean set)
void	setState(int state)	Provide generic access to internal state.
(package private) void	setUniDirection(boolean uni)

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.NamedBean

compareTo, getRecommendedToolTip

Field Details

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

String constant for active.

See Also:

• Constant Field Values

PROPERTY_NO_CHANGE

public static final String PROPERTY_NO_CHANGE

String constant for no change.

See Also:

• Constant Field Values

PROPERTY_STACKED

public static final String PROPERTY_STACKED

String constant for stacked.

See Also:

• Constant Field Values

PROPERTY_FAILED

public static final String PROPERTY_FAILED

String constant for failed.

See Also:

• Constant Field Values

point

transient PointDetails point

entryExitType

int entryExitType

manager

transient EntryExitPairs manager

sml

transient SignalMastLogic sml

NXMESSAGEBOXCLEARTIMEOUT

static final int NXMESSAGEBOXCLEARTIMEOUT

See Also:

• Constant Field Values

src

transient Source src

propertyBlockListener

protected transient PropertyChangeListener propertyBlockListener

lastSeenActiveBlockObject

Object lastSeenActiveBlockObject

jButton_Stack

JButton jButton_Stack

Constructor Details

DestinationPoints

protected DestinationPoints(PointDetails point,
 String id,
 Source src)

Method Details

getBeanType

public String getBeanType()

Description copied from interface: NamedBean

For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.

Returns:

a string of the bean type, eg Turnout, Sensor etc

isEnabled

public boolean isEnabled()

public for testing purposes.

Returns:

true if enabled, else false.

setEnabled

public void setEnabled(boolean boo)

getUniqueId

String getUniqueId()

getDestPoint

public PointDetails getDestPoint()

getSource

public Source getSource()

Returns:

source.

Since:

4.17.4 Making the source object available for scripting in Jython.

getUniDirection

boolean getUniDirection()

setUniDirection

void setUniDirection(boolean uni)

getSignal

NamedBean getSignal()

setRouteTo

void setRouteTo(boolean set)

setRouteFrom

void setRouteFrom(boolean set)

isRouteToPointSet

boolean isRouteToPointSet()

getFacing

LayoutBlock getFacing()

getProtecting

List<LayoutBlock> getProtecting()

getEntryExitType

int getEntryExitType()

setEntryExitType

void setEntryExitType(int type)

blockStateUpdated

protected void blockStateUpdated(PropertyChangeEvent e)

removeBlockFromRoute

void removeBlockFromRoute(LayoutBlock lBlock)

setRoute

void setRoute(boolean state)

cancelClearOptionBox

void cancelClearOptionBox()

cancelClearInterlock

void cancelClearInterlock(int cancelClear)

setInterlockRoute

public void setInterlockRoute(boolean reverseDirection)

activeBean

void activeBean(boolean reverseDirection)

activeBean

void activeBean(boolean reverseDirection,
 boolean showMessage)

handleNoCurrentRoute

void handleNoCurrentRoute(boolean reverse,
 String message)

dispose

public void dispose()

Description copied from class: AbstractNamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

Overrides:

dispose in class AbstractNamedBean

getState

public int getState()

Description copied from interface: NamedBean

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

Returns:

the state

isActive

public boolean isActive()

isReversed

public boolean isReversed()

isUniDirection

public boolean isUniDirection()

setState

public void setState(int state)

Description copied from interface: NamedBean

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

Parameters:

state - the state

setActiveEntryExit

protected void setActiveEntryExit(boolean boo)

setActiveEntryExit

protected void setActiveEntryExit(boolean boo,
 boolean reversed)

getUsageReport

public List<NamedBeanUsageReport> getUsageReport(NamedBean bean)

Description copied from interface: NamedBean

Get a list of references for the specified bean.

Parameters:

bean - The bean to be checked.

Returns:

a list of NamedBeanUsageReports or an empty ArrayList.