|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Sequencer
A Sequencer
is the computational unit that determines the
sequence of time points at which the state of the canonical Graph
is
determined. It also is used to determine if and when the sequence terminates.
Scenario#step()
,
STEMTime
Field Summary | |
---|---|
static long |
UNKNOWN_DURATION
This constant is returned by getEndTime() when a
Sequencer has no specified end time. |
Method Summary | |
---|---|
STEMTime |
getCurrentTime()
|
int |
getCycle()
obtain the number of processing cycles that have been completed. |
long |
getDuration()
|
STEMTime |
getEndTime()
|
STEMTime |
getNextTime()
|
STEMTime |
getStartTime()
|
long |
getTimeDelta()
|
double |
getWorkComplete()
|
int |
getWorkIncrement()
|
boolean |
isTimeToStop()
|
void |
reset()
Set the current time to the start time and prepare the Sequencer to begin computing the next time from that
point. |
void |
setCurrentTime(STEMTime value)
Sets the value of the ' Current Time ' containment reference. |
void |
setCycle(int value)
Sets the value of the ' Cycle ' attribute. |
void |
setDuration(long value)
Sets the value of the ' Duration ' attribute. |
void |
setEndTime(STEMTime value)
Sets the value of the ' End Time ' containment reference. |
void |
setStartTime(STEMTime value)
Sets the value of the ' Start Time ' containment reference. |
void |
setWorkComplete(double value)
Sets the value of the ' Work Complete ' attribute. |
Methods inherited from interface org.eclipse.ohf.stem.core.common.Identifiable |
---|
getDublinCore, getTypeURI, getURI, sane, setDublinCore, setTypeURI, setURI |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Field Detail |
---|
static final long UNKNOWN_DURATION
getEndTime()
when a
Sequencer
has no specified end time.
getDuration()
,
Constant Field ValuesMethod Detail |
---|
STEMTime getStartTime()
void setStartTime(STEMTime value)
Start Time
' containment reference.
value
- the new value of the 'Start Time' containment reference.getStartTime()
STEMTime getEndTime()
UNKNOWN_DURATION
if
there is no end time.void setEndTime(STEMTime value)
End Time
' containment reference.
value
- the new value of the 'End Time' containment reference.getEndTime()
STEMTime getCurrentTime()
Sequencer
's current time.void setCurrentTime(STEMTime value)
Current Time
' containment reference.
value
- the new value of the 'Current Time' containment reference.getCurrentTime()
STEMTime getNextTime()
sequencer
's current time is set to the returned
value.long getTimeDelta()
getCurrentTime()
and that returned by
getNextTime()
. This value is only valid after a call to
getNextTime()
.getCurrentTime()
,
getNextTime()
long getDuration()
UNKNOWN_DURATION
is returned.UNKNOWN_DURATION
void setDuration(long value)
Duration
' attribute.
value
- the new value of the 'Duration' attribute.getDuration()
boolean isTimeToStop()
void reset()
Sequencer
to begin computing the next time from that
point. Also reset the amount of work complete
getNextTime()
,
getWorkComplete()
double getWorkComplete()
void setWorkComplete(double value)
Work Complete
' attribute.
value
- the new value of the 'Work Complete' attribute.getWorkComplete()
int getWorkIncrement()
getNextTime()
int getCycle()
void setCycle(int value)
Cycle
' attribute.
value
- the new value of the 'Cycle' attribute.getCycle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |