Apama Documentation : Developing Apama Applications : Developing Apama Applications in Event Modeler : Using Standard Blocks : The Timer blocks : Wait v3.0
Wait v3.0
The Wait block sends an output feed at a given time in the future. The time is specified by a number of seconds to wait from the time the start operation is called. A timer may be set to repeat. Multiple timers may be started in a single block, each one having a different timer id. This timer id is supplied in the output feed when the timer fires, so may be used to determine what to do when that happens.
Parameters
Parameter
Description
timer id
A string to identify this timer from others in used in this block (an empty string is valid).
time
The number of seconds to wait.
repeat
true if the timer should repeat, false if a single-shot.
Operations
Operation
Description
start
Starts the specified timer ID.
cancel
Cancels the specified timer ID.
retrieve
Retrieve the details of the specified timer id by setting the output feed accordingly.
reset
Resets the output feed. Useful for repeating timers to set the output feed's time up field to false.
Input feeds
This block has no input feeds.
Output feeds
Feed
Fields
Description
timer
timer id
The id of the timer, as supplied by the timer id parameter.
time
The time to wait in seconds.
repeat
true if the timer repeats.
time up
true if time is up, false otherwise (i.e. on retrieval).
book
num timers
The total number of timers known to this block.
Copyright © 2013-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback