|
| SimulationModule (Entity *e, const char *m_class, const char *part, const IncoTable *table=NULL, int state_size=0) |
| Constructor. More...
|
|
virtual | ~SimulationModule () |
| Destructor. More...
|
|
SimulationState::Type | getAndCheckState (const TimeSpec &ts, bool confirm_transition=true) |
| Returns the state of the simulation at this time. More...
|
|
void | transitionComplete () |
| If a transition was not (implicitly) confirmed in the getAndCheckState call (second argument false), confirm with this call that it is now complete. More...
|
|
SimulationState::Type | getCurrentState () |
| If you "forgot" what the state from a previous getAndCheckState() call was, you can remember it here. More...
|
|
| DusimeModule (Entity *e, const char *m_class, const char *part, const IncoTable *inco_table, int state_size) |
| Constructor. More...
|
|
virtual | ~DusimeModule () |
| Destructor. More...
|
|
bool | snapshotNow () |
| Returns true if a snapshot has to be taken in this cycle. More...
|
|
virtual void | fillSnapshot (const TimeSpec &ts, Snapshot &snap, bool from_trim) |
| If snapshots are generated, this has to be implemented by a descendant. More...
|
|
virtual void | loadSnapshot (const TimeSpec &ts, const Snapshot &snap) |
| For restoring the state from an old snapshot. More...
|
|
void | trimCalculationCondition (TriggerPuller &cond) |
| This can be used to specify the condition under which the trim calculation may take place, for example, data has to be received on trim calculation input channels. More...
|
|
virtual void | trimCalculation (const TimeSpec &ts, const TrimMode &mode) |
| This must be overridden if the module takes part in trim condition calculations. More...
|
|
| Module (const Entity *e, const char *m_class, const char *part) |
| Constructor.
|
|
virtual void | setSafetyStop () |
| Put a brake on this module's activities.
|
|
| NamedObject (const GlobalId &id) |
| Reserve for AssociateObject. More...
|
|
| NamedObject (const NameSet &ns) |
| Normal constructor, protected, because it has no use to create a NamedObject by itself.
|
|
virtual | ~NamedObject () |
| Destructor.
|
|
SnapshotState | snap_state |
| State of the snapshot taking. More...
|
|
ModuleState | state |
| Flag to remember whether we are stopped due to some error with hardware device manipulation. More...
|
|
Generic HDF5 file format logging.
The instructions to create an module of this class from the Scheme script are:
dueca.Module('hdf5-logger', <part name; string>, <PrioritySpec>).param(
set_timing = <TimeSpec>,
# Supply a time specification to define the update rate of the main activity
check_timing = <array of integers>,
# Supply three integer parameters to specify a check on the timing of
# the main activity: warning limit (in us), critical limit (in us), and
# the number of loops to test before sending a report (optional, dflt=2000)
log_entry = <array of strings>,
# log a specific channel entry; enter channel name, dataclass type, if
# applicable entry label and as last the path where the data should be
# stored in the file. Without label, only the first entry is logged,
# with, only the first entry matching the label
watch_channel = <array of strings>,
# log all entries in a specific channel; enter channel name and path
# where entries should be stored
filename_template = <string>,
# Template for file name; check boost time_facet for format strings
# Default name: datalog-%Y%m%d_%H%M%S.hdf5
log_always = <boolean>,
# For watched channels or channel entries created with log_always,
# logging also is done in HoldCurrent mode. Default off, toggles
# this capability for logging defined hereafter.
immediate_start = <boolean>,
# Immediately start the logging module, do not wait for DUECA control
#
chunksize = <uint32_t>,
# Size of logging chunks (no of data points) for the log file,
# in effect for all following entries.
compress = <boolean>,
# Log compressed data sets; reduces file size and may increase
# computation time. In effect for all following entries
reduction = <TimeSpec>,
# Reduce the logging data rate according to the given time
# specification. Applies to all following logged values
config_channel = <string>,
# Specify a channel with configuration events, to control logging
# check DUECALogConfig doc for options
)
'''Description:
Generic logging facilities for channel data to HDF5 data files.
The logger may be controlled with DUECALogConfig events, but may
also be run without control.
Note that hdf5 may sometimes take unpredictable time (when it
needs to flush data to disk). DUECA has no problem with that, but
you are advised to configure a separate priority for the hdf5
modules.'''