Package jmri.jmrit.logixng

Interface GlobalVariable

All Superinterfaces:

Base, Comparable<NamedBean>, NamedBean, PropertyChangeProvider

All Known Implementing Classes:

DefaultGlobalVariable

public interface GlobalVariable
extends Base, NamedBean

LogixNG Global Variable.

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

Method Summary

Modifier and Type	Method	Description
String	getInitialValueData()	Get the initial value.
SymbolTable.InitialValueType	getInitialValueType()	Get the initial value type.
Object	getValue()	Get the value.
void	initialize()	Initialize this global variable to the initial value.
void	setInitialValueData(String value)	Set the initial value.
void	setInitialValueType(SymbolTable.InitialValueType value)	Set the initial value type.
void	setValue(Object value)	Set the 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, 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, 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 Details

initialize

void initialize()
         throws JmriException

Initialize this global variable to the initial value.

Throws:

JmriException - in case of an error

setValue

void setValue(Object value)

Set the value.

Parameters:

value - the value

getValue

Object getValue()

Get the value.

Returns:

the value

setInitialValueType

void setInitialValueType(SymbolTable.InitialValueType value)

Set the initial value type.

Parameters:

value - the type

getInitialValueType

SymbolTable.InitialValueType getInitialValueType()

Get the initial value type.

Returns:

the type

setInitialValueData

void setInitialValueData(String value)

Set the initial value.

Parameters:

value - the value

getInitialValueData

String getInitialValueData()

Get the initial value.

Returns:

the value