org.eclipse.scada.configuration.world.osgi

Interface BufferedValue

All Superinterfaces:

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

All Known Implementing Classes:

BufferedValueImpl

public interface BufferedValue
extends NamedDocumentable

A representation of the model object 'Buffered Value'.

The following features are supported:

• Item
• Initial Value
• Range
• Trigger
• Trigger Only
• Persistence

See Also:

OsgiPackage.getBufferedValue()

Method Summary

Methods

Modifier and Type	Method and Description
Variant	getInitialValue() Returns the value of the 'Initial Value' attribute.
ItemReference	getItem() Returns the value of the 'Item' containment reference.
Persistence	getPersistence() Returns the value of the 'Persistence' 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	setInitialValue(Variant value) Sets the value of the 'Initial Value' attribute.
void	setItem(ItemReference value) Sets the value of the 'Item' containment reference.
void	setPersistence(Persistence value) Sets the value of the 'Persistence' 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

ItemReference getItem()

Returns the value of the 'Item' containment 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' containment reference.

See Also:

setItem(ItemReference), OsgiPackage.getBufferedValue_Item()

setItem

void setItem(ItemReference value)

Sets the value of the 'Item' containment reference.

Parameters:

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

See Also:

getItem()

getInitialValue

Variant getInitialValue()

Returns the value of the 'Initial Value' attribute. The default value is "".

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

Returns:

the value of the 'Initial Value' attribute.

See Also:

setInitialValue(Variant), OsgiPackage.getBufferedValue_InitialValue()

setInitialValue

void setInitialValue(Variant value)

Sets the value of the 'Initial Value' attribute.

Parameters:

value - the new value of the 'Initial Value' attribute.

See Also:

getInitialValue()

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.getBufferedValue_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". 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.getBufferedValue_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.getBufferedValue_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()

getPersistence

Persistence getPersistence()

Returns the value of the 'Persistence' attribute. The default value is "NONE". The literals are from the enumeration Persistence.

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

Returns:

the value of the 'Persistence' attribute.

See Also:

Persistence, setPersistence(Persistence), OsgiPackage.getBufferedValue_Persistence()

setPersistence

void setPersistence(Persistence value)

Sets the value of the 'Persistence' attribute.

Parameters:

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

See Also:

Persistence, getPersistence()