org.eclipse.scada.configuration.component

Interface MovingAverageModule

All Superinterfaces:

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

All Known Implementing Classes:

MovingAverageModuleImpl

public interface MovingAverageModule
extends CalculationModule

A representation of the model object 'Moving Average Module'.

The following features are supported:

• Null Range
• Range
• Trigger
• Trigger Only

See Also:

ComponentPackage.getMovingAverageModule()

Method Summary

Methods

Modifier and Type	Method and Description
long	getNullRange() Returns the value of the 'Null Range' attribute.
long	getRange() Returns the value of the 'Range' attribute.
long	getTrigger() Returns the value of the 'Trigger' attribute.
boolean	isTriggerOnly() Returns the value of the 'Trigger Only' attribute.
void	setNullRange(long value) Sets the value of the 'Null Range' attribute.
void	setRange(long value) Sets the value of the 'Range' attribute.
void	setTrigger(long value) Sets the value of the 'Trigger' attribute.
void	setTriggerOnly(boolean value) Sets the value of the 'Trigger Only' attribute.

Methods inherited from interface org.eclipse.scada.configuration.component.CalculationModule

getKnownInputs, getKnownOutputs

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

getNullRange

long getNullRange()

Returns the value of the 'Null Range' attribute. The default value is "30".

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

The amount of time (seconds) that is required to be valid to produce a valid output value.

Returns:

the value of the 'Null Range' attribute.

See Also:

setNullRange(long), ComponentPackage.getMovingAverageModule_NullRange()

setNullRange

void setNullRange(long value)

Sets the value of the 'Null Range' attribute.

Parameters:

value - the new value of the 'Null Range' attribute.

See Also:

getNullRange()

getRange

long getRange()

Returns the value of the 'Range' attribute. The default value is "60". The time range in seconds for which this average will be calculated.

Returns:

the value of the 'Range' attribute.

See Also:

setRange(long), ComponentPackage.getMovingAverageModule_Range()

setRange

void setRange(long value)

Sets the value of the 'Range' attribute.

Parameters:

value - the new value of the 'Range' attribute.

See Also:

getRange()

getTrigger

long getTrigger()

Returns the value of the 'Trigger' attribute. The default value is "1". The update time period in seconds.

Returns:

the value of the 'Trigger' attribute.

See Also:

setTrigger(long), ComponentPackage.getMovingAverageModule_Trigger()

setTrigger

void setTrigger(long value)

Sets the value of the 'Trigger' attribute.

Parameters:

value - the new value of the 'Trigger' attribute.

See Also:

getTrigger()

isTriggerOnly

boolean isTriggerOnly()

Returns the value of the 'Trigger Only' attribute. The default value is "false". Whether value changes or only timed triggers will update the value.

Returns:

the value of the 'Trigger Only' attribute.

See Also:

setTriggerOnly(boolean), ComponentPackage.getMovingAverageModule_TriggerOnly()

setTriggerOnly

void setTriggerOnly(boolean value)

Sets the value of the 'Trigger Only' attribute.

Parameters:

value - the new value of the 'Trigger Only' attribute.

See Also:

isTriggerOnly()