org.eclipse.scada.configuration.component.common

Interface TimerAction

All Superinterfaces:

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

All Known Implementing Classes:

TimerActionImpl

public interface TimerAction
extends MasterComponent

A representation of the model object 'Timer Action'.

The following features are supported:

• Period
• Target Item
• Value
• Name

See Also:

CommonPackage.getTimerAction()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the value of the 'Name' attribute.
long	getPeriod() Returns the value of the 'Period' attribute.
InputDefinition	getTargetItem() Returns the value of the 'Target Item' containment reference.
Variant	getValue() Returns the value of the 'Value' attribute.
void	setName(String value) Sets the value of the 'Name' attribute.
void	setPeriod(long value) Sets the value of the 'Period' attribute.
void	setTargetItem(InputDefinition value) Sets the value of the 'Target Item' containment reference.
void	setValue(Variant value) Sets the value of the 'Value' 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

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.getTimerAction_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.getTimerAction_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()

getValue

Variant getValue()

Returns the value of the 'Value' attribute.

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

Returns:

the value of the 'Value' attribute.

See Also:

setValue(Variant), CommonPackage.getTimerAction_Value()

setValue

void setValue(Variant value)

Sets the value of the 'Value' attribute.

Parameters:

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

See Also:

getValue()

getName

String getName()

Returns the value of the 'Name' attribute. The default value is "$TIMER_ACTION".

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

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), CommonPackage.getTimerAction_Name()

setName

void setName(String value)

Sets the value of the 'Name' attribute.

Parameters:

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

See Also:

getName()