org.eclipse.scada.configuration.component.common

Interface ChangeHeartbeatDetector

All Superinterfaces:

Component, DataComponent, Documentable, org.eclipse.emf.ecore.EObject, HeartbeatDetector, MasterComponent, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

ChangeHeartbeatDetectorImpl

public interface ChangeHeartbeatDetector
extends HeartbeatDetector

A representation of the model object 'Change Heartbeat Detector'.

The following features are supported:

• Timeout
• Check Period
• Source Item

See Also:

CommonPackage.getChangeHeartbeatDetector()

Method Summary

Methods

Modifier and Type	Method and Description
long	getCheckPeriod() Returns the value of the 'Check Period' attribute.
InputDefinition	getSourceItem() Returns the value of the 'Source Item' containment reference.
long	getTimeout() Returns the value of the 'Timeout' attribute.
void	setCheckPeriod(long value) Sets the value of the 'Check Period' attribute.
void	setSourceItem(InputDefinition value) Sets the value of the 'Source Item' containment reference.
void	setTimeout(long value) Sets the value of the 'Timeout' attribute.

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

getMasterOn

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

getArchiveSelector, getCustomizationPipeline, getLevel, getProperties, setArchiveSelector, setCustomizationPipeline, setLevel

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

getTimeout

long getTimeout()

Returns the value of the 'Timeout' attribute. The default value is "10000". The timeout of the detector in milliseconds.

Returns:

the value of the 'Timeout' attribute.

See Also:

setTimeout(long), CommonPackage.getChangeHeartbeatDetector_Timeout()

setTimeout

void setTimeout(long value)

Sets the value of the 'Timeout' attribute.

Parameters:

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

See Also:

getTimeout()

getCheckPeriod

long getCheckPeriod()

Returns the value of the 'Check Period' attribute. The default value is "1000".

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

Returns:

the value of the 'Check Period' attribute.

See Also:

setCheckPeriod(long), CommonPackage.getChangeHeartbeatDetector_CheckPeriod()

setCheckPeriod

void setCheckPeriod(long value)

Sets the value of the 'Check Period' attribute.

Parameters:

value - the new value of the 'Check Period' attribute.

See Also:

getCheckPeriod()

getSourceItem

InputDefinition getSourceItem()

Returns the value of the 'Source Item' containment reference.

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

Returns:

the value of the 'Source Item' containment reference.

See Also:

setSourceItem(InputDefinition), CommonPackage.getChangeHeartbeatDetector_SourceItem()

setSourceItem

void setSourceItem(InputDefinition value)

Sets the value of the 'Source Item' containment reference.

Parameters:

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

See Also:

getSourceItem()