Package jmri.jmrit.logixng.expressions

Class Antecedent

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.expressions.AbstractDigitalExpression

jmri.jmrit.logixng.expressions.Antecedent

All Implemented Interfaces:

Comparable<NamedBean>, PropertyChangeProvider, Base, DigitalExpression, DigitalExpressionBean, FemaleSocketListener, NamedBean

public class Antecedent
extends AbstractDigitalExpression
implements FemaleSocketListener

Evaluates to True if the antecedent evaluates to true

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Antecedent.DataPair
static class	Antecedent.ExpressionEntry

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

Modifier and Type	Field	Description
(package private) static final ResourceBundle	rbx

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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
Antecedent(String sys, String user)	Create a new instance of Antecedent with system name and user name.
Antecedent(String sys, String user, List<Map.Entry<String,String>> expressionSystemNames)	Create a new instance of Antecedent with system name and user name.

Method Summary

Modifier and Type	Method	Description
void	connected(FemaleSocket socket)	The socket is connected.
void	disconnected(FemaleSocket socket)	The socket is disconnected.
void	disposeMe()	Dispose this class.
void	doSocketOperation(int index, FemaleSocketOperation oper)	Do an operation on a child
boolean	evaluate()	Evaluate this expression.
String	getAntecedent()
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
Base	getDeepCopy(Map<String,String> systemNames, Map<String,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.
String	getExpressionSystemName(int index)
String	getLongDescription(Locale locale)	Get a long description of this item.
String	getShortDescription(Locale locale)	Get a short description of this item.
boolean	isSocketOperationAllowed(int index, FemaleSocketOperation oper)	Is the operation allowed on this child?
(package private) Antecedent.DataPair	parseCalculate(String s, List<Antecedent.ExpressionEntry> expressionEntryList)	Parses and computes one parenthesis level of a boolean statement.
void	registerListenersForThisClass()	Register listeners if this object needs that.
final void	setAntecedent(String antecedent)
void	setChildCount(int count)
void	setup()	Setup this object and its children.
void	unregisterListenersForThisClass()	Unregister listeners if this object needs that.
String	validateAntecedent(String ant, List<Antecedent.ExpressionEntry> expressionEntryList)	Check that an antecedent is well formed.

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, getUsageDetail, 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, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isEnabled, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.jmrit.logixng.FemaleSocketListener

socketNameChanged

Methods inherited from interface jmri.NamedBean

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Field Details

rbx

static final ResourceBundle rbx

Constructor Details

Antecedent

public Antecedent(@Nonnull
 String sys,
 @CheckForNull
 String user)

Create a new instance of Antecedent with system name and user name.

Parameters:

sys - the system name

user - the user name

Antecedent

public Antecedent(@Nonnull
 String sys,
 @CheckForNull
 String user,
 List<Map.Entry<String,String>> expressionSystemNames)
           throws NamedBean.BadUserNameException,
NamedBean.BadSystemNameException

Create a new instance of Antecedent with system name and user name.

Parameters:

sys - the system name

user - the user name

expressionSystemNames - a list of system names for the expressions this antecedent uses

Throws:

NamedBean.BadUserNameException - when needed

NamedBean.BadSystemNameException - when needed

Method Details

getDeepCopy

public Base getDeepCopy(Map<String,String> systemNames,
 Map<String,String> userNames)
                 throws JmriException

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:

JmriException - in case of an error

getExpressionSystemName

public String getExpressionSystemName(int index)

getCategory

public LogixNG_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 IllegalArgumentException,
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:

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

UnsupportedOperationException - when needed

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

setChildCount

public void setChildCount(int count)

getShortDescription

public String getShortDescription(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 String getLongDescription(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

getAntecedent

public String getAntecedent()

setAntecedent

public final void setAntecedent(String antecedent)
                         throws JmriException

Throws:

JmriException

isSocketOperationAllowed

public boolean isSocketOperationAllowed(int index,
 FemaleSocketOperation oper)

Is the operation allowed on this child?

Specified by:

isSocketOperationAllowed in interface Base

Parameters:

index - the index of the child to do the operation on

oper - the operation to do

Returns:

true if operation is allowed, false otherwise

doSocketOperation

public void doSocketOperation(int index,
 FemaleSocketOperation oper)

Do an operation on a child

Specified by:

doSocketOperation in interface Base

Parameters:

index - the index of the child to do the operation on

oper - the operation to do

connected

public void connected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is connected.

Specified by:

connected in interface FemaleSocketListener

Parameters:

socket - the socket

disconnected

public void disconnected(FemaleSocket socket)

Description copied from interface: FemaleSocketListener

The socket is disconnected.

Specified by:

disconnected in interface FemaleSocketListener

Parameters:

socket - the socket

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

validateAntecedent

public String validateAntecedent(String ant,
 List<Antecedent.ExpressionEntry> expressionEntryList)
                          throws JmriException

Check that an antecedent is well formed.

Parameters:

ant - the antecedent string description

expressionEntryList - arraylist of existing ExpressionEntries

Returns:

error message string if not well formed

Throws:

JmriException - when an exception occurs

parseCalculate

Antecedent.DataPair parseCalculate(String s,
 List<Antecedent.ExpressionEntry> expressionEntryList)
                            throws JmriException

Parses and computes one parenthesis level of a boolean statement.

Recursively calls inner parentheses levels. Note that all logic operators are detected by the parsing, therefore the internal negation of a variable is washed.

Parameters:

s - The expression to be parsed

expressionEntryList - ExpressionEntries for R1, R2, etc

Returns:

a data pair consisting of the truth value of the level a count of the indices consumed to parse the level and a bitmap of the variable indices used.

Throws:

JmriException - if unable to compute the logic

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

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