Package jmri.jmrit.logixng

Interface AnalogExpression

All Superinterfaces:

Base, PropertyChangeProvider

All Known Subinterfaces:

AnalogExpressionBean, FemaleAnalogExpressionSocket, MaleAnalogExpressionSocket

All Known Implementing Classes:

AbstractAnalogExpression, AnalogExpressionAnalogIO, AnalogExpressionConstant, AnalogExpressionLocalVariable, AnalogExpressionMemory, AnalogFormula, DebuggerMaleAnalogExpressionSocket, DefaultFemaleAnalogExpressionSocket, DefaultMaleAnalogExpressionSocket, TimeSinceMidnight

public interface AnalogExpression
extends Base

Analog expression is used in LogixNG to answer a question that can give an analog value as result.

Nested Class Summary

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

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

Field Summary

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

Method Summary

Modifier and Type	Method	Description
double	evaluate()	Evaluate this expression.
boolean	getTriggerOnChange()	Get whenether this expression should trigger the ConditionalNG if the named beans it listens to changes state.
void	setTriggerOnChange(boolean triggerOnChange)	Set whenether this expression should trigger the ConditionalNG if the named beans it listens to changes state.

Methods inherited from interface jmri.jmrit.logixng.Base

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Details

evaluate

double evaluate()
         throws JmriException

Evaluate this expression.

Returns:

the result of the evaluation. The male socket that holds this expression throws an exception if this value is a Double.NaN or an infinite number.

Throws:

JmriException - when an exception occurs

setTriggerOnChange

void setTriggerOnChange(boolean triggerOnChange)

Set whenether this expression should trigger the ConditionalNG if the named beans it listens to changes state.

Parameters:

triggerOnChange - true if trigger on change, false otherwise

getTriggerOnChange

boolean getTriggerOnChange()

Get whenether this expression should trigger the ConditionalNG if the named beans it listens to changes state.

Returns:

true if trigger on change, false otherwise