Class Linker

SystemGraph Linker. This object is in charge of connecting ports together by reference at runtime

Inheritance

Object

Linker

Namespace: Mechatronics.SystemGraph

Syntax

public class Linker

Constructors

Linker(SystemGraphComponent)

Initializes a new instance of the Linker class.

Declaration

public Linker(SystemGraphComponent component)

Parameters

Type	Name	Description
SystemGraphComponent	component	The component.

Methods

ConnectDrivers()

Connect edges of the graph to data from one source node to a target node, this method will identify the connection but not link the references

Declaration

public Linker.LinkerResult ConnectDrivers()

Returns

Type	Description
Linker.LinkerResult	LinkerResult

FindPortDescriptor(Linker.NodeReferenceDescriptor, String)

Finds the port descriptor.

Declaration

public Linker.PortReferenceDescriptor FindPortDescriptor(Linker.NodeReferenceDescriptor node, string portName)

Parameters

Type	Name	Description
Linker.NodeReferenceDescriptor	node	The node.
String	portName	Name of the port.

Returns

Type	Description
Linker.PortReferenceDescriptor	PortReferenceDescriptor.

GetEdgeConnections(SerializedEdge, List<SerializedEdge>, HashSet<SerializedEdge>)

Gets the edge connections.

Declaration

public void GetEdgeConnections(SerializedEdge edge, List<SerializedEdge> lstEdge, HashSet<SerializedEdge> setConsumedEdge)

Parameters

Type	Name	Description
SerializedEdge	edge	The edge.
List<SerializedEdge>	lstEdge	The list of edge connections.
HashSet<SerializedEdge>	setConsumedEdge	The list of consumed edges by the connection filter.

LinkField(Linker.PortReferenceDescriptor, Linker.PortReferenceDescriptor, Boolean)

Links the fields by reference

Declaration

public Linker.LinkerResult LinkField(Linker.PortReferenceDescriptor driver, Linker.PortReferenceDescriptor target, bool linkInterConnects = false)

Parameters

Type	Name	Description
Linker.PortReferenceDescriptor	driver	The driver.
Linker.PortReferenceDescriptor	target	The target.
Boolean	linkInterConnects	if set to true [link inter connects].

Returns

Type	Description
Linker.LinkerResult	LinkerResult.

LinkPorts(Boolean)

Links the ports by reference and potentially inter connect embed graphs together

Declaration

public Linker.LinkerResult LinkPorts(bool allowInterConnect = false)

Parameters

Type	Name	Description
Boolean	allowInterConnect	if set to true [allow inter connect].

Returns

Type	Description
Linker.LinkerResult	LinkerResult.

LinkReferences(Boolean)

Links the ports by reference

Declaration

public Linker.LinkerResult LinkReferences(bool allowInterConnect = false)

Parameters

Type	Name	Description
Boolean	allowInterConnect	if set to true [allow inter connect].

Returns

Type	Description
Linker.LinkerResult	LinkerResult.