Package jmri.jmrit.logixng
Interface Module
-
- All Superinterfaces:
Base
,java.lang.Comparable<NamedBean>
,NamedBean
,PropertyChangeProvider
- All Known Implementing Classes:
DefaultModule
public interface Module extends Base, NamedBean
Represent a LogixNG module. A module is similar to a ConditionalNG, except that it can be used by both ConditionalNGs and modules.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Module.Parameter
The definition of a parameter.static class
Module.ParameterData
Data for a parameter.static class
Module.ReturnValueType
An enum that defines the types of initial value.-
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 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addLocalVariable(java.lang.String name, SymbolTable.InitialValueType initialValueType, java.lang.String initialValueData)
void
addParameter(java.lang.String name, boolean isInput, boolean isOutput)
void
addParameter(Module.Parameter parameter)
java.util.Collection<SymbolTable.VariableData>
getLocalVariables()
java.util.Collection<Module.Parameter>
getParameters()
FemaleSocket
getRootSocket()
FemaleSocketManager.SocketType
getRootSocketType()
void
setCurrentConditionalNG(ConditionalNG conditionalNG)
-
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.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, describeState, dispose, getBeanType, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, 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
-
getRootSocketType
FemaleSocketManager.SocketType getRootSocketType()
-
getRootSocket
FemaleSocket getRootSocket()
-
setCurrentConditionalNG
void setCurrentConditionalNG(ConditionalNG conditionalNG)
-
addParameter
void addParameter(java.lang.String name, boolean isInput, boolean isOutput)
-
addParameter
void addParameter(Module.Parameter parameter)
-
addLocalVariable
void addLocalVariable(java.lang.String name, SymbolTable.InitialValueType initialValueType, java.lang.String initialValueData)
-
getParameters
java.util.Collection<Module.Parameter> getParameters()
-
getLocalVariables
java.util.Collection<SymbolTable.VariableData> getLocalVariables()
-
-