Class NodeClock
Class NodeClock. Implements the NodeRuntime
Inherited Members
Namespace: Mechatronics.SystemGraph
Syntax
[NodeCategory("Type", "Clock", NodeTick.Synchronous, (LifeCycle)0, 0F, NodeMode.Standard, false, Mode = NodeMode.Standard)]
public class NodeClock : NodeRuntimeFields
_signal
The signal
Declaration
[Field("Signal", PortDirection.Right, FieldExtra.Write)]
[SerializeField]
public PortType<uint> _signalField Value
| Type | Description |
|---|---|
| PortType<UInt32> |
Methods
Enable(Scheduler.ClockState)
Forwarded OnEnable Unity event from the parent SystemGraphComponent
Declaration
public override void Enable(Scheduler.ClockState clockState)Parameters
| Type | Name | Description |
|---|---|---|
| Scheduler.ClockState | clockState | The parameters of the waveform associated to this node |
Overrides
OnTick(Double, Double, Scheduler.ClockState, Scheduler.Signal)
OnTick event received from the scheduler for this node waveform. This is received for every rising edge of the waveform at the frequency configured in the scheduler.
Declaration
public override bool OnTick(double now, double eventTime, Scheduler.ClockState clockState, Scheduler.Signal signal)Parameters
| Type | Name | Description |
|---|---|---|
| Double | now | The current time in seconds of the scheduler clocksource |
| Double | eventTime | The current time in seconds of the scheduler waveform. This is independent from the clocksource time and aligned to every rising edge time in the waveform. |
| Scheduler.ClockState | clockState | The current parameters of the waveform event associated to this node |
| Scheduler.Signal | signal | Signals that the scheduler pass to the OnTick event receiver. These are signals that describe the action that should be done in the Node. For example, integrate this tick as multiple events. |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if time integration was performed |