org.eclipse.scada.configuration.component.common

Interface HeartbeatGenerator

All Superinterfaces:

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

All Known Subinterfaces:

ToggleHeartbeatGenerator

All Known Implementing Classes:

HeartbeatGeneratorImpl, ToggleHeartbeatGeneratorImpl

public interface HeartbeatGenerator
extends MasterComponent

A representation of the model object 'Heartbeat Generator'.

The following features are supported:

• Period
• Target Item
• Active Input

See Also:

CommonPackage.getHeartbeatGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
InputDefinition	getActiveInput() Returns the value of the 'Active Input' containment reference.
long	getPeriod() Returns the value of the 'Period' attribute.
InputDefinition	getTargetItem() Returns the value of the 'Target Item' containment reference.
void	setActiveInput(InputDefinition value) Sets the value of the 'Active Input' containment reference.
void	setPeriod(long value) Sets the value of the 'Period' attribute.
void	setTargetItem(InputDefinition value) Sets the value of the 'Target Item' containment reference.

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

getMasterOn

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

getArchiveSelector, getCustomizationPipeline, getLevel, 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

getPeriod

long getPeriod()

Returns the value of the 'Period' attribute. The default value is "1000". The generator period in milliseconds

Returns:

the value of the 'Period' attribute.

See Also:

setPeriod(long), CommonPackage.getHeartbeatGenerator_Period()

setPeriod

void setPeriod(long value)

Sets the value of the 'Period' attribute.

Parameters:

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

See Also:

getPeriod()

getTargetItem

InputDefinition getTargetItem()

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

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

Returns:

the value of the 'Target Item' containment reference.

See Also:

setTargetItem(InputDefinition), CommonPackage.getHeartbeatGenerator_TargetItem()

setTargetItem

void setTargetItem(InputDefinition value)

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

Parameters:

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

See Also:

getTargetItem()

getActiveInput

InputDefinition getActiveInput()

Returns the value of the 'Active Input' containment reference. This is a input which activates or deactivates the heartbeat generator. If the input is set it must be "true" for the heartbeat generator to write its heartbeat.

Returns:

the value of the 'Active Input' containment reference.

See Also:

setActiveInput(InputDefinition), CommonPackage.getHeartbeatGenerator_ActiveInput()

setActiveInput

void setActiveInput(InputDefinition value)

Sets the value of the 'Active Input' containment reference.

Parameters:

value - the new value of the 'Active Input' containment reference.

See Also:

getActiveInput()