Module Simantics/Event

This module is undocumented. This is a list of its definitions.

eventCount :: String -> <Proc> Integer

Returns the number of events in the event source with the given id.

eventSourceIds :: () -> <Proc> [String]

Returns the ids of all currently registered event sources.

eventSourceName :: String -> <Proc> String

Returns the human readable name of the event source with the given id.

exportCurrentEvents :: String -> String -> <Proc> ()
exportCurrentEvents "\t" "X:/events.txt"

exports the events of the default event source into the specified text file using the specified column separator string.

exportCurrentEventsG :: String -> String -> <ReadGraph> ()
exportCurrentEventsG "\t" "X:/events.txt"

Use exportCurrentEvents instead, which does the same thing and takes the same arguments.

Events used to be read from the Simantics database, so exporting them from inside a transaction needed that transaction's own graph to avoid deadlocking against it. They are now read from an event store, which no transaction is involved in, so there is nothing left for the two variants to differ in and neither can deadlock. This one remains so that existing scripts keep running.

exportEventFile :: String -> String -> String -> <Proc> ()
exportEventFile "X:/ic/events.db" "\t" "X:/events.txt"

exports the events of a stored event log file, such as the one saved with an initial condition, into the specified text file.

exportEvents :: String -> String -> String -> <Proc> ()
exportEvents sourceId "\t" "X:/events.txt"

exports the events of the event source with the given id into the specified text file using the specified column separator string. eventSourceIds lists the ids of the sources currently available.