Skip to content

Event

abstract class Event < Object

Event during the simulation of a model.

An Event requires that an action be taken. The choice of action is made by a Handler. The action is performed by calling the appropriate member function of event, such as play(), delay(), replay(), etc.

Member Functions

Name Description
play Perform the play action.
replay Perform the replay action.
unplay Perform the unplay action.
delay Perform the delay action.
redelay Perform the redelay action.
undelay Perform the undelay action.
propose Perform the propose action.
record Produce a record for the event.

Member Function Details

delay

abstract function delay() -> Real

Perform the delay action.

Returns: The required weight adjustment.

play

abstract function play() -> Real

Perform the play action.

Returns: The required weight adjustment.

propose

abstract function propose(record:Record) -> Real

Perform the propose action.

  • record: Associated record in the trace.

Returns: The required weight adjustment.

record

abstract function record() -> Record

Produce a record for the event.

Returns: The record.

redelay

abstract function redelay(record:Record) -> Real

Perform the redelay action. This is typically used when reconstructing a trace that was originally simulated forward using delay().

  • record: Associated record in the trace.

Returns: The required weight adjustment.

replay

abstract function replay(record:Record) -> Real

Perform the replay action. This is typically used when reconstructing a trace that was originally simulated forward using play().

  • record: Associated record in the trace.

Returns: The required weight adjustment.

undelay

abstract function undelay(record:Record) -> Real

Perform the undelay action. This is typically used when undoing the effects of a trace that was originally simulated forward using delay().

  • record: Associated record in the trace.

Returns: The required weight adjustment.

unplay

abstract function unplay(record:Record) -> Real

Perform the unplay action. This is typically used when undoing the effects of a trace that was originally simulated forward using play().

  • record: Associated record in the trace.

Returns: The required weight adjustment.