org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions Class Reference

Settings related to clock synchronization. More...

Public Attributes
int	attenuation = 10
	Dampen the adjustments to the clock synchronization offset by this rate.
boolean	collectStats = true
	Whether to collect statistics while performing clock synchronization.
boolean	localFederatesOn = false
	Enable clock synchronization for federates on the same machine.
TimeValue	period = new TimeValue(5, TimeUnit.MILLI)
	Interval at which clock synchronization is initiated by the RTI (will be passed to it as an argument on the command-line).
TimeValue	testOffset
	Used to create an artificial clock synchronization error for the purpose of testing.
int	trials = 10
	Indicate the number of exchanges to be had per each clock synchronization round.

Detailed Description

Settings related to clock synchronization.

Member Data Documentation

attenuation

int org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.attenuation = 10

Dampen the adjustments to the clock synchronization offset by this rate.

The default is 10.

collectStats

boolean org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.collectStats = true

Whether to collect statistics while performing clock synchronization.

This setting is only considered when clock synchronization has been activated. The default is true.

localFederatesOn

boolean org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.localFederatesOn = false

Enable clock synchronization for federates on the same machine.

Default is false.

period

TimeValue org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.period = new TimeValue(5, TimeUnit.MILLI)

Interval at which clock synchronization is initiated by the RTI (will be passed to it as an argument on the command-line).

The default is 5 milliseconds.

testOffset

TimeValue org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.testOffset

Used to create an artificial clock synchronization error for the purpose of testing.

The default is null.

trials

int org.lflang.target.property.ClockSyncOptionsProperty.ClockSyncOptions.trials = 10

Indicate the number of exchanges to be had per each clock synchronization round.

See /lib/core/federated/clock-sync.h for more details. The default is 10.

---

The documentation for this class was generated from the following file:

• /Users/runner/work/lingua-franca/lingua-franca/core/src/main/java/org/lflang/target/property/ClockSyncOptionsProperty.java