CIF 3

Normal console output

Normal console output mainly focuses on the state of the specification, and the progress of the simulation.

Available types of normal output

The following types of normal output are available:

The initial state [state-init] (default)
Prints the initial state to the console.
The target states [state-target] (default)
Prints all target states to the console. This includes all states reached by event transitions and time transitions. Specifically, it excludes the initial state, and it includes the final/deadlock state.
The final state [state-final]
Prints the final state to the console, regardless of whether or not the final state is a deadlock state.
The deadlock state [state-deadlock]
Prints the final state to the console, but only if it is a deadlock state.
The intermediate states [state-intermediate]
Prints all intermediate states to the console. Intermediate states are the states that are used to generate intermediate frames, for smooth visualizations. The intermediate states are generated for states between the start and end states of time transitions, when real-time simulation is enabled. Note that this does not include the initial state, target states, and final/deadlock states.
The algebraic variables as part of the state [state-alg-vars] (default)
Prints the algebraic variables (derived state) as part of the state. This applies to all states, including the states for intermediate frames. If no state information is printed, this output type has no effect. Disabling printing of algebraic variables excludes algebraic variables, regardless of whether state filtering includes or excludes them.
The derivatives as part of the state [state-derivs] (default)
Prints the derivatives of the continuous variables (derived state) as part of the state. This applies to all states, including the states for intermediate frames. If no state information is printed, this output type has no effect. The derivative of variable time is not included. Disabling printing of derivatives excludes derivatives, regardless of whether state filtering includes or excludes them.
The possible transitions (for interactive console choice only) [trans-minimal]
Prints the possible transitions to the console, if the interactive console input mode is used. Multiple possible transition are always printed. Single possible transitions are only printed if automatic choice for a single possible transition is disabled. Nothing is printed if no transitions are possible.
The possible transitions (for interactive console choice, or if more than one transition) [trans-default]
Similar to ‘interactive console choice only’, but additionally always prints the possible transitions, if there are multiple possible transitions, regardless of the input mode.
The possible transitions (always) [trans-always]
Always print the possible transitions to the console, regardless of the input mode, and the number of possible transitions. However, nothing is printed if no transitions are possible.
The chosen transitions [chosen-trans] (default)
Prints the chosen transitions (the transitions that are about to be taken), to the console.
The interrupted transitions [interrupted-trans] (default)
Prints information about interrupted transitions (time transitions that are stopped prematurely) to the console.
The simulation result [sim-rslt] (default)
Prints the simulation result the console, at the end of the simulation, if simulation did not result in a runtime error.
The random seeds used for the random generators [seeds] (default)

Prints the seeds used for the random generators to the console, to allow reproducing the simulation trace. Only if a random seed is used, is the seed printed. That is, for user-specified seeds, the seed is not printed. The following seeds may be printed:

The print declarations output [print] (default)

Prints the output generated by print declarations.

Normal output option

In the option dialog, each of the different types of output can be enabled and disabled individually (Normal output option, Output category).

From the command line, using the -o or --output option, the names of the different types of normal output, as specified between square brackets, should be used, separated by commas. The output types indicated with ‘(default)’ are enabled when default settings are used, i.e. when the -o or --output option is not used. As an example, consider -o print,seeds or --output=print,seeds. Only output generated by print declarations (due to print) and output about the used seeds for random generators (due to seeds) is enabled, while all other output is disabled.

The output types that are specified using the option replace the default output types. However, it is also possible to specify additions and removals relative to the default output, by prefixing output types with a + or - respectively. For instance, when using -o -print,+trans-always or --output=-print,+trans-always the default output is used, with print declarations output excluded from it (due to -print), and with always printing possible transitions enabled (due to +trans-always). Replacements (no prefix) may not be combined with additions/removals (+ or - prefix).

Specifying a replacement output type twice leads to a warning being printed to the console. Adding an output type that is already present or removing an output type that is not present, also leads to a warning being printed.

Output details

When printing states, variable time is always printed first. It is followed by the current location of each of the automata, the current values of the state variables (the discrete and continuous variables), the current values of the derivatives of the continuous variables, and the current values of the algebraic variables. Except for variable time, the state objects are sorted alphabetically based on their absolute names. For automata with a single nameless location, the current location is always *.

For variables with a function type and implicit default values, the default values may include defaultValueFunc, defaultValueFunc2, etc.

When printing the possible transitions, the event transitions are printed first, followed by the tau transitions, and the time transition. The event transitions are sorted alphabetically on the names of the events.

State filtering

By default, when printing states, all state objects are included. Using the Normal output state filters option (Output category), the state objects can be filtered. The Normal output state filters option only has effect if states are printed at all.

As value for the option, comma separated filters should be supplied. Each filter specifies one or more state objects. The absolute names of the objects are used. That is, for an automaton a, with a variable x, the absolute name of the variable object is a.x. If CIF 3 textual syntax keyword are used as names for events (such as plant), then they must be escaped in .cif files ($plant). For filters however, all escape characters ($) in the names are ignored. The * character can be used as wildcard, to indicate zero or more characters. If a filter doesn’t match any of the state objects of the CIF model, a warning is printed to the console.

By default, filters include matching state objects. Filters may however be preceded by a - character, turning them into exclusion filters, which exclude matching states objects rather than including them. Filters are processed in the order they are specified, allowing for alternating additions and removals. If a filter does not result in the addition/removal of any state objects to/from the filter result, a warning is printed to the console. A warning is also printed if the entire state is filtered out.

As an example, option value a.*,-a.b*,a.bc* consists of three filters: a.*, -a.b*, and a.bc*. The first filter indicates that state objects whose absolute names start with a. are to be included. The second filter indicates that from those matching state objects, the state objects whose absolute names start with a.b* are to be excluded. To that result, the third filter adds those state objects whose absolute names start with a.bc*. For instance, if a specification contains state objects time, a.a, a.b a.bb, a.bc, a.b.c, a.bc, a.bcc, and a.bcd, the result of the three filters is that the following state objects are displayed: a.a, a.bc, a.bc, a.bcc, and a.bcd.

The default option value (filter) is *.

Regardless of whether the filtered result includes them or not, all algebraic variables and derivatives of continuous variables may be excluded, using the Normal output option.

Profiling

If profiling is enabled, all normal output is automatically disabled. That is, profiling suppresses all normal output.