org.eclipse.scada.configuration.component

Interface ScriptModule

All Superinterfaces:

CalculationModule, Documentable, org.eclipse.emf.ecore.EObject, NamedDocumentable, org.eclipse.emf.common.notify.Notifier, Service

All Known Implementing Classes:

ScriptModuleImpl

public interface ScriptModule
extends NamedDocumentable, CalculationModule

A representation of the model object 'Script Module'.

The following features are supported:

• Inputs
• Outputs
• Script Engine
• Init Script
• Update Script
• Write Command Script
• Timer Script

See Also:

ComponentPackage.getScriptModule()

Method Summary

Methods

Modifier and Type	Method and Description
Script	getInitScript() Returns the value of the 'Init Script' containment reference.
org.eclipse.emf.common.util.EList<InputSpecification>	getInputs() Returns the value of the 'Inputs' containment reference list.
org.eclipse.emf.common.util.EList<InputSpecification>	getKnownInputs()
org.eclipse.emf.common.util.EList<OutputSpecification>	getKnownOutputs()
org.eclipse.emf.common.util.EList<OutputSpecification>	getOutputs() Returns the value of the 'Outputs' containment reference list.
String	getScriptEngine() Returns the value of the 'Script Engine' attribute.
TimerScript	getTimerScript() Returns the value of the 'Timer Script' containment reference.
Script	getUpdateScript() Returns the value of the 'Update Script' containment reference.
Script	getWriteCommandScript() Returns the value of the 'Write Command Script' containment reference.
void	setInitScript(Script value) Sets the value of the 'Init Script' containment reference.
void	setScriptEngine(String value) Sets the value of the 'Script Engine' attribute.
void	setTimerScript(TimerScript value) Sets the value of the 'Timer Script' containment reference.
void	setUpdateScript(Script value) Sets the value of the 'Update Script' containment reference.
void	setWriteCommandScript(Script value) Sets the value of the 'Write Command Script' containment reference.

Methods inherited from interface org.eclipse.scada.configuration.world.NamedDocumentable

getName, setName

Methods inherited from interface org.eclipse.scada.configuration.world.Documentable

getShortDescription, setShortDescription

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getInputs

org.eclipse.emf.common.util.EList<InputSpecification> getInputs()

Returns the value of the 'Inputs' containment reference list. The list contents are of type InputSpecification.

If the meaning of the 'Inputs' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Inputs' containment reference list.

See Also:

ComponentPackage.getScriptModule_Inputs()

getOutputs

org.eclipse.emf.common.util.EList<OutputSpecification> getOutputs()

Returns the value of the 'Outputs' containment reference list. The list contents are of type OutputSpecification.

If the meaning of the 'Outputs' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Outputs' containment reference list.

See Also:

ComponentPackage.getScriptModule_Outputs()

getScriptEngine

String getScriptEngine()

Returns the value of the 'Script Engine' attribute. The default value is "JavaScript".

If the meaning of the 'Script Engine' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Script Engine' attribute.

See Also:

setScriptEngine(String), ComponentPackage.getScriptModule_ScriptEngine()

setScriptEngine

void setScriptEngine(String value)

Sets the value of the 'Script Engine' attribute.

Parameters:

value - the new value of the 'Script Engine' attribute.

See Also:

getScriptEngine()

getInitScript

Script getInitScript()

Returns the value of the 'Init Script' containment reference.

If the meaning of the 'Init Script' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Init Script' containment reference.

See Also:

setInitScript(Script), ComponentPackage.getScriptModule_InitScript()

setInitScript

void setInitScript(Script value)

Sets the value of the 'Init Script' containment reference.

Parameters:

value - the new value of the 'Init Script' containment reference.

See Also:

getInitScript()

getUpdateScript

Script getUpdateScript()

Returns the value of the 'Update Script' containment reference.

If the meaning of the 'Update Script' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Update Script' containment reference.

See Also:

setUpdateScript(Script), ComponentPackage.getScriptModule_UpdateScript()

setUpdateScript

void setUpdateScript(Script value)

Sets the value of the 'Update Script' containment reference.

Parameters:

value - the new value of the 'Update Script' containment reference.

See Also:

getUpdateScript()

getWriteCommandScript

Script getWriteCommandScript()

Returns the value of the 'Write Command Script' containment reference.

If the meaning of the 'Write Command Script' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Write Command Script' containment reference.

See Also:

setWriteCommandScript(Script), ComponentPackage.getScriptModule_WriteCommandScript()

setWriteCommandScript

void setWriteCommandScript(Script value)

Sets the value of the 'Write Command Script' containment reference.

Parameters:

value - the new value of the 'Write Command Script' containment reference.

See Also:

getWriteCommandScript()

getTimerScript

TimerScript getTimerScript()

Returns the value of the 'Timer Script' containment reference.

If the meaning of the 'Timer Script' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Timer Script' containment reference.

See Also:

setTimerScript(TimerScript), ComponentPackage.getScriptModule_TimerScript()

setTimerScript

void setTimerScript(TimerScript value)

Sets the value of the 'Timer Script' containment reference.

Parameters:

value - the new value of the 'Timer Script' containment reference.

See Also:

getTimerScript()

getKnownInputs

org.eclipse.emf.common.util.EList<InputSpecification> getKnownInputs()

Specified by:

getKnownInputs in interface CalculationModule

Returns:

the value of the 'Known Inputs' reference list.

See Also:

ComponentPackage.getCalculationModule_KnownInputs()

getKnownOutputs

org.eclipse.emf.common.util.EList<OutputSpecification> getKnownOutputs()

Specified by:

getKnownOutputs in interface CalculationModule

Returns:

the value of the 'Known Outputs' reference list.

See Also:

ComponentPackage.getCalculationModule_KnownOutputs()