org.eclipse.scada.configuration.world.osgi

Interface MovingAverage

All Superinterfaces:

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

All Known Implementing Classes:

MovingAverageImpl

public interface MovingAverage
extends NamedDocumentable

A representation of the model object 'Moving Average'.

The following features are supported:

• Item
• Range
• Null Range
• Trigger
• Trigger Only

See Also:

OsgiPackage.getMovingAverage()

Method Summary

Methods

Modifier and Type	Method and Description
Item	getItem() Returns the value of the 'Item' reference.
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	getTriggerOnly() Returns the value of the 'Trigger Only' attribute.
void	setItem(Item value) Sets the value of the ' Item' reference.
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.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

getItem

Item getItem()

Returns the value of the 'Item' reference.

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

Returns:

the value of the 'Item' reference.

See Also:

setItem(Item), OsgiPackage.getMovingAverage_Item()

setItem

void setItem(Item value)

Sets the value of the ' Item' reference.

Parameters:

value - the new value of the 'Item' reference.

See Also:

getItem()

getRange

long getRange()

Returns the value of the 'Range' attribute. The number of seconds the average will be calculated for.

Returns:

the value of the 'Range' attribute.

See Also:

setRange(long), OsgiPackage.getMovingAverage_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()

getNullRange

long getNullRange()

Returns the value of the 'Null Range' attribute. The number of seconds the average must have recorded valid data in order to provide a valid (non-error) value.

Returns:

the value of the 'Null Range' attribute.

See Also:

setNullRange(long), OsgiPackage.getMovingAverage_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()

getTrigger

long getTrigger()

Returns the value of the 'Trigger' attribute. The default value is "1". A period time in seconds when the average will be updated although no value has changed.

Returns:

the value of the 'Trigger' attribute.

See Also:

setTrigger(long), OsgiPackage.getMovingAverage_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()

getTriggerOnly

Boolean getTriggerOnly()

Returns the value of the 'Trigger Only' attribute. The default value is "false". A flag which decides if the average is only updated by time (true) or also by value change (false).

Returns:

the value of the 'Trigger Only' attribute.

See Also:

setTriggerOnly(Boolean), OsgiPackage.getMovingAverage_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:

getTriggerOnly()