Package jmri.jmrit.logixng.expressions

Class ExpressionTurnout

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.expressions.AbstractDigitalExpression

jmri.jmrit.logixng.expressions.ExpressionTurnout

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, Base, DigitalExpression, DigitalExpressionBean, NamedBean

public class ExpressionTurnout
extends AbstractDigitalExpression
implements java.beans.PropertyChangeListener

This expression sets the state of a turnout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExpressionTurnout.TurnoutState

Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

Nested classes/interfaces inherited from interface jmri.NamedBean

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

Field Summary

Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBase

_listenersAreRegistered

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.jmrit.logixng.Base

PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED

Fields inherited from interface jmri.jmrit.logixng.DigitalExpressionBean

FALSE, TRUE

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ExpressionTurnout(java.lang.String sys, java.lang.String user)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
boolean	evaluate()	Evaluate this expression.
Is_IsNot_Enum	get_Is_IsNot()
ExpressionTurnout.TurnoutState	getBeanState()
Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
Base	getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames, java.util.Map<java.lang.String,java.lang.String> userNames)	Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used.
java.lang.String	getLongDescription(java.util.Locale locale)	Get a long description of this item.
LogixNG_SelectNamedBean<Turnout>	getSelectNamedBean()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
NamedBeanAddressing	getStateAddressing()
java.lang.String	getStateFormula()
java.lang.String	getStateLocalVariable()
java.lang.String	getStateReference()
void	getUsageDetail(int level, NamedBean bean, java.util.List<NamedBeanUsageReport> report, NamedBean cdl)	Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	set_Is_IsNot(Is_IsNot_Enum is_IsNot)
void	setBeanState(ExpressionTurnout.TurnoutState state)
void	setStateAddressing(NamedBeanAddressing addressing)
void	setStateFormula(java.lang.String formula)
void	setStateLocalVariable(java.lang.String localVariable)
void	setStateReference(java.lang.String reference)
void	setup()	Setup this object and its children.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.

Methods inherited from class jmri.jmrit.logixng.expressions.AbstractDigitalExpression

getBeanType, getNewSocketName, getNewSocketName, getParent, getState, notifyChangedResult, setParent, setState

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBase

assertListenersAreNotRegistered, compareSystemNameSuffix, deepCopyChildren, dispose, getConditionalNG, getListenerRefsIncludingChildren, getLogixNG, getRoot, getUsageTree, isActive, printTree, printTree, printTree, printTreeRow, registerListeners, setParentForAllChildren, unregisterListeners

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, 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.jmrit.logixng.Base

addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

ExpressionTurnout

public ExpressionTurnout(java.lang.String sys,
                         java.lang.String user)
                  throws NamedBean.BadUserNameException,
                         NamedBean.BadSystemNameException

Throws:

NamedBean.BadUserNameException

NamedBean.BadSystemNameException

Method Detail

getDeepCopy

public Base getDeepCopy(java.util.Map<java.lang.String,java.lang.String> systemNames,
                        java.util.Map<java.lang.String,java.lang.String> userNames)
                 throws ParserException

Description copied from interface: Base

Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.

Specified by:

getDeepCopy in interface Base

Parameters:

systemNames - a map of old and new system name

userNames - a map of old system name and new user name

Returns:

a deep copy

Throws:

ParserException

getSelectNamedBean

public LogixNG_SelectNamedBean<Turnout> getSelectNamedBean()

set_Is_IsNot

public void set_Is_IsNot(Is_IsNot_Enum is_IsNot)

get_Is_IsNot

public Is_IsNot_Enum get_Is_IsNot()

setStateAddressing

public void setStateAddressing(NamedBeanAddressing addressing)
                        throws ParserException

Throws:

ParserException

getStateAddressing

public NamedBeanAddressing getStateAddressing()

setBeanState

public void setBeanState(ExpressionTurnout.TurnoutState state)

getBeanState

public ExpressionTurnout.TurnoutState getBeanState()

setStateReference

public void setStateReference(@Nonnull
                              java.lang.String reference)

getStateReference

public java.lang.String getStateReference()

setStateLocalVariable

public void setStateLocalVariable(@Nonnull
                                  java.lang.String localVariable)

getStateLocalVariable

public java.lang.String getStateLocalVariable()

setStateFormula

public void setStateFormula(@Nonnull
                            java.lang.String formula)
                     throws ParserException

Throws:

ParserException

getStateFormula

public java.lang.String getStateFormula()

getCategory

public Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Overrides:

getCategory in class AbstractBase

Returns:

the category

evaluate

public boolean evaluate()
                 throws JmriException

Evaluate this expression.

Specified by:

evaluate in interface DigitalExpression

Returns:

the result of the evaluation

Throws:

JmriException - when an exception occurs

getChild

public FemaleSocket getChild(int index)
                      throws java.lang.IllegalArgumentException,
                             java.lang.UnsupportedOperationException

Description copied from class: AbstractBase

Get a child of this item

Specified by:

getChild in interface Base

Overrides:

getChild in class AbstractBase

Parameters:

index - the index of the child to get

Returns:

the child

Throws:

java.lang.IllegalArgumentException - if the index is less than 0 or greater or equal with the value returned by getChildCount()

java.lang.UnsupportedOperationException

getChildCount

public int getChildCount()

Description copied from class: AbstractBase

Get the number of children.

Specified by:

getChildCount in interface Base

Overrides:

getChildCount in class AbstractBase

Returns:

the number of children

getShortDescription

public java.lang.String getShortDescription(java.util.Locale locale)

Description copied from interface: Base

Get a short description of this item.

Specified by:

getShortDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a short description

getLongDescription

public java.lang.String getLongDescription(java.util.Locale locale)

Description copied from interface: Base

Get a long description of this item.

Specified by:

getLongDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a long description

setup

public void setup()

Setup this object and its children. This method is used to lookup system names for child sockets, turnouts, sensors, and so on.

Specified by:

setup in interface Base

registerListenersForThisClass

public void registerListenersForThisClass()

Register listeners if this object needs that.

Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.

Overrides:

registerListenersForThisClass in class AbstractBase

unregisterListenersForThisClass

public void unregisterListenersForThisClass()

Unregister listeners if this object needs that.

Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.

Overrides:

unregisterListenersForThisClass in class AbstractBase

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

disposeMe

public void disposeMe()

Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().

Overrides:

disposeMe in class AbstractBase

getUsageDetail

public void getUsageDetail(int level,
                           NamedBean bean,
                           java.util.List<NamedBeanUsageReport> report,
                           NamedBean cdl)

Add a new NamedBeanUsageReport to the report list if there are any matches in this action or expresssion.

NamedBeanUsageReport Usage keys:

• LogixNGAction
• LogixNGExpression

Specified by:

getUsageDetail in interface Base

Overrides:

getUsageDetail in class AbstractBase

Parameters:

level - The current recursion level for debugging.

bean - The named bean that is the object of the search.

report - A list of NamedBeanUsageReport usage reports.

cdl - The current ConditionalNG bean. Null for Module searches since there is no conditional