Package jmri.jmrit.logixng

Interface MaleAnalogActionSocket

All Superinterfaces:

AnalogAction, AnalogActionBean, Base, java.lang.Comparable<NamedBean>, Debugable, MaleSocket, NamedBean, PropertyChangeProvider

All Known Implementing Classes:

DebuggerMaleAnalogActionSocket, DefaultMaleAnalogActionSocket

public interface MaleAnalogActionSocket
extends MaleSocket, AnalogActionBean

A LogixNG male AnalogActionBean socket.

Nested Class Summary

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

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

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

Debugable.DebugConfig

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

MaleSocket.ErrorHandlingType

Nested classes/interfaces inherited from interface jmri.NamedBean

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

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

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Method Summary

Modifier and Type	Method	Description
void	setValue(double value)	Set an analog value.

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, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParent, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.jmrit.logixng.Debugable

createDebugConfig, getDebugConfig, setDebugConfig

Methods inherited from interface jmri.jmrit.logixng.MaleSocket

addLocalVariable, addLocalVariable, clearLocalVariables, find, getCatchAbortExecution, getErrorHandlingType, getListen, getLocalVariables, getManager, getObject, handleError, handleError, handleError, isEnabled, isLocked, isSupportingLocalVariables, isSystem, setCatchAbortExecution, setEnabled, setEnabledFlag, setErrorHandlingType, setListen, setLocked, setSystem, setup

Methods inherited from interface jmri.NamedBean

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

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setValue

void setValue(double value)
       throws JmriException

Set an analog value.

This method must ensure that the value is not a Double.NaN, negative infinity or positive infinity. If that is the case, it must throw an IllegalArgumentException before checking if an error has occured.

Specified by:

setValue in interface AnalogAction

Parameters:

value - the value. The male socket that holds this action ensures that this value is not Double.NaN or an infinite value.

Throws:

JmriException - when an exception occurs