Experimental Configuration

Overview 

This section includes experimental configuration fields.

Warning

The features available through the experimental section might be changed or removed in future versions of the SIL Kit.

TimeSynchronization 

Experimental:
    TimeSynchronization:
        AnimationFactor: 1.0
        EnableMessageAggregation: Off

Table 25 TimeSynchronization Configuration
Property Name	Description
AnimationFactor	This value affects SIL Kit simulations where a time synchronization service is used. When this value is set, the virtual time is coupled to the local wall clock of the underlying system, scaled down by the given factor. E.g., a value of 1.0 means direct coupling to the wall clock. A value of 2.0 means that the virtual time runs twice as slow as the local wall clock. Accordingly, a value of 0.5 will cause the virtual time to run twice as fast. When omitting the value or setting it to zero, no coupling to the wall clock takes place. Note Depending on the simulation step size, the chosen animation factor and the computational load per simulation step, it might not be possible to couple the virtual time to the wall clock with the desired factor.
EnableMessageAggregation	Enable the aggregation of messages in SIL Kit simulations with time synchronization. Valid options are On, Auto and Off. If option Auto is chosen, the aggregation is enabled only for the case of synchronous simulation step handlers. If option On is chosen, the aggregation is enabled for both synchronous and asynchronous simulation step handlers. Note Option Auto can be chosen without any concerns. In the case of option On, however, it is necessary to verify that the transmission of messages within a time step does not depend on incoming messages from other participants. In this case, the time step will not be terminated and the communication will block.

Metrics for participants 

Each participant supports collecting static attributes of a simulation and runtime performance metrics. They are collected and distributed to the configured sinks at the given update interval.

Experimental:
    Metrics:
      Sinks:
        - Name: SomeSink1
          Type: Remote

Table 26 Participant Metrics Configuration
Property Name	Description
Sinks	A list of named metric sinks. They can be of type `JsonFile` or `Remote`.
updateInterval	The time between sending batches of metrics to the registry in seconds.

Metrics for the registry 

The registry configuration supports collecting metrics from remote participants and forwarding the collected data to the SIL Kit Dashboard for further analysis and visualization. Refer to the documentation of the Vector SIL Kit Dashboard for further instructions.

Experimental:
    Metrics:
      CollectFromRemote: true

Table 27 Registry Metrics Configuration
Property Name	Description
CollectFromRemote	Collect metrics from all connected participants. Defaults to `true`.