Class Scheduler.ClockState

The ClockState class is used to describe the current clock state for a specific tick event

Inheritance

Object

Scheduler.ClockState

Namespace: Mechatronics.SystemGraph

Syntax

public class ClockState

Fields

ClockEvent

Associated serialized ClockEvent

Declaration

public ClockEvent ClockEvent

Field Value

Type	Description
ClockEvent

DeltaTime

Time elapsed since previous tick in seconds

Declaration

public double DeltaTime

Field Value

Type	Description
Double

EventCount

Number of events related to this clock state

Declaration

public int EventCount

Field Value

Type	Description
Int32

LastFrameTime

Last update frame time in seconds

Declaration

public double LastFrameTime

Field Value

Type	Description
Double

Node

The node driven by this clock state

Declaration

public NodeRuntime Node

Field Value

Type	Description
NodeRuntime

Period

Period of the waveform in seconds

Declaration

public double Period

Field Value

Type	Description
Double

PhaseShift

Time delta used to compute the initial next period of a clock event

Declaration

public double PhaseShift

Field Value

Type	Description
Double

Prescaler

The prescaler ratio, used to divide the period

Declaration

public int Prescaler

Field Value

Type	Description
Int32

Tag

Unique id of this clock state

Declaration

public int Tag

Field Value

Type	Description
Int32

TickCPUTimeNs

Profiling timer

Declaration

public long TickCPUTimeNs

Field Value

Type	Description
Int64

TimeOffsetSeconds

The time offset to spend at start

Declaration

public double TimeOffsetSeconds

Field Value

Type	Description
Double

TimeOffsetSpent

True when the time offset has been elapsed

Declaration

public bool TimeOffsetSpent

Field Value

Type	Description
Boolean

UseClockSource

Diretly use the frequency of the clock source if true

Declaration

public bool UseClockSource

Field Value

Type	Description
Boolean