Package jmri.jmrix.loconet.logixng

Class ExpressionSlotUsage

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.jmrit.logixng.implementation.AbstractBase

jmri.jmrit.logixng.expressions.AbstractDigitalExpression

jmri.jmrix.loconet.logixng.ExpressionSlotUsage

All Implemented Interfaces:

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

public class ExpressionSlotUsage
extends AbstractDigitalExpression
implements SlotListener

This expression compares the number of slots that are currently in use with a threshold number.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExpressionSlotUsage.AdvancedState
static class	ExpressionSlotUsage.Compare
static class	ExpressionSlotUsage.Has_HasNot
static class	ExpressionSlotUsage.PercentPieces
static class	ExpressionSlotUsage.SimpleState

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

Constructor Summary

Constructors

Constructor	Description
ExpressionSlotUsage(java.lang.String sys, java.lang.String user, LocoNetSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()	Dispose this class.
boolean	evaluate()	Evaluate this expression.
ExpressionSlotUsage.Has_HasNot	get_Has_HasNot()
boolean	getAdvanced()
java.util.Set<ExpressionSlotUsage.AdvancedState>	getAdvancedStates()
LogixNG_Category	getCategory()	Get the category.
FemaleSocket	getChild(int index)	Get a child of this item
int	getChildCount()	Get the number of children.
ExpressionSlotUsage.Compare	getCompare()
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.
LocoNetSystemConnectionMemo	getMemo()
int	getNumber()
ExpressionSlotUsage.PercentPieces	getPercentPieces()
java.lang.String	getShortDescription(java.util.Locale locale)	Get a short description of this item.
ExpressionSlotUsage.SimpleState	getSimpleState()
int	getTotalSlots()
void	notifyChangedSlot(LocoNetSlot s)
void	registerListenersForThisClass()	Register listeners if this object needs that.
void	set_Has_HasNot(ExpressionSlotUsage.Has_HasNot hasHasNot)
void	setAdvanced(boolean advanced)
void	setAdvancedStates(java.util.Set<ExpressionSlotUsage.AdvancedState> states)
void	setCompare(ExpressionSlotUsage.Compare compare)
void	setMemo(LocoNetSystemConnectionMemo memo)
void	setNumber(int number)
void	setPercentPieces(ExpressionSlotUsage.PercentPieces percentPieces)
void	setSimpleState(ExpressionSlotUsage.SimpleState simpleState)
void	setTotalSlots(int totalNumber)
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, 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, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getComment, getConditionalNG, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, 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, getRecommendedToolTip, 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

ExpressionSlotUsage

public ExpressionSlotUsage(java.lang.String sys,
                           java.lang.String user,
                           LocoNetSystemConnectionMemo memo)

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 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

getCategory

public LogixNG_Category getCategory()

Get the category.

Specified by:

getCategory in interface Base

Overrides:

getCategory in class AbstractBase

Returns:

the category

setMemo

public void setMemo(LocoNetSystemConnectionMemo memo)

getMemo

public LocoNetSystemConnectionMemo getMemo()

setAdvanced

public void setAdvanced(boolean advanced)

getAdvanced

public boolean getAdvanced()

set_Has_HasNot

public void set_Has_HasNot(ExpressionSlotUsage.Has_HasNot hasHasNot)

get_Has_HasNot

public ExpressionSlotUsage.Has_HasNot get_Has_HasNot()

setSimpleState

public void setSimpleState(ExpressionSlotUsage.SimpleState simpleState)

getSimpleState

public ExpressionSlotUsage.SimpleState getSimpleState()

setAdvancedStates

public void setAdvancedStates(java.util.Set<ExpressionSlotUsage.AdvancedState> states)

getAdvancedStates

public java.util.Set<ExpressionSlotUsage.AdvancedState> getAdvancedStates()

setCompare

public void setCompare(ExpressionSlotUsage.Compare compare)

getCompare

public ExpressionSlotUsage.Compare getCompare()

setNumber

public void setNumber(int number)

getNumber

public int getNumber()

setTotalSlots

public void setTotalSlots(int totalNumber)

getTotalSlots

public int getTotalSlots()

setPercentPieces

public void setPercentPieces(ExpressionSlotUsage.PercentPieces percentPieces)

getPercentPieces

public ExpressionSlotUsage.PercentPieces getPercentPieces()

evaluate

public boolean evaluate()

Evaluate this expression.

Specified by:

evaluate in interface DigitalExpression

Returns:

the result of the evaluation

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 - 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

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

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

notifyChangedSlot

public void notifyChangedSlot(LocoNetSlot s)

Specified by:

notifyChangedSlot in interface SlotListener