Class NodeRuntime
The NodeRuntime class provides an interface to create a systemgraph runtime and editor node. Implementation of this class exposes the user implementation to the lifecycle of SystemGraph.
Inherited Members
Namespace: Mechatronics.SystemGraph
Assembly: solution.dll
Syntax
[Serializable]
public class NodeRuntime : ScriptableObject
  Remarks
Implement this class in conjunction with NodeCategory attribute to configure your node. See NodeCategoryAttribute for configuration attributes of your node.
Fields
| Name | Description | 
|---|---|
| _parent | The bound SystemGraphComponent that coordinate events, scheduler and nodes  | 
      
| _portList | The port list  | 
      
| _queryPath | The query path  | 
      
| _tickCPUTimeNs | Store the last profiling time of the OnTick call of this Node  | 
      
Properties
| Name | Description | 
|---|---|
| PortDataList | Gets the port data list.  | 
      
| QueryPath | Gets the query path.  | 
      
| TickCPUTimeNs | Gets or sets the tick cpu time ns.  | 
      
Methods
| Name | Description | 
|---|---|
| Disable() | Forwarded OnDisable Unity event from the parent SystemGraphComponent  | 
      
| Enable(ClockState) | Forwarded OnEnable Unity event from the parent SystemGraphComponent  | 
      
| FixedUpdate() | Forwarded FixedUpdate Unity event from the parent SystemGraphComponent, if event is registered for this node.  | 
      
| Initialize(SystemGraphComponent) | Initialize is called by SystemGraphComponent parent to bind the parent to the Node and to call the InternalInitialize event of the node.  | 
      
| InitializeDynamicPorts(SystemGraphComponent) | Called at start of runtime execution to load ports from PortList. Override for custom behaviour on load.  | 
      
| InternalInitialize() | The implementation of this virtual function shall handle special initialization code to handle when the graph is initialized.  | 
      
| OnPortAdded(string, Type, string, PortDirection, FieldExtra, ref IPortType) | PortAddition event recieved from the editor during edit mode if ExpandablePorts attribute is set. By default this function will accept all ports.  | 
      
| OnPortRemoved(string) | Port removal event recieved from the editor during edit mode if ExpandablePorts attribute is set. By default this function will reject all removeals  | 
      
| OnTick(double, double, ClockState, 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.  | 
      
| Start() | Forwarded Start Unity event from the parent SystemGraphComponent  | 
      
| Update() | Forwarded Update Unity event from the parent SystemGraphComponent, if event is registered for this node.  |