Class ConsumerNode

The base node for any node that consumes (takes) data. In other words, any node that has one more in ports.

Inheritance
System.Object
ScriptNode
ConsumerNode
OutputNode
Inherited Members
Namespace: InsaneScatterbrain.ScriptGraph
Syntax
public abstract class ConsumerNode : ScriptNode, IConsumerNode, IScriptNode, INode

Properties

InPorts

Declaration
public ReadOnlyCollection<InPort> InPorts { get; }
Property Value
Type Description
ReadOnlyCollection<InPort>

Node

In case of proxy classes (such as ProcessorNode uses) it's useful to explicitly set the node's type.

Declaration
protected virtual IConsumerNode Node { get; }
Property Value
Type Description
IConsumerNode

Methods

AddIn(String, Type, IScriptNode, InPort)

Adds an in port with the given name of the given type.

Declaration
public InPort AddIn(string name, Type type, IScriptNode owner = null, InPort port = null)
Parameters
Type Name Description
System.String name

The port's name.
Type type

The port's data type.
IScriptNode owner

The node that is marked as the owner. If this is null that will be this node (which is probably what you want).
InPort port

The existing port.
Returns
Type Description
InPort

The new in port.

AddIn<T>(String, IScriptNode)

Declaration
public InPort AddIn<T>(string name, IScriptNode owner = null)
Parameters
Type Name Description
System.String name
IScriptNode owner
Returns
Type Description
InPort
Type Parameters
Name Description
T

ClearPorts()

Declaration
public void ClearPorts()

GetInPort(String)

Declaration
public InPort GetInPort(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
InPort

MoveIn(Int32, Int32)

Declaration
public void MoveIn(int oldIndex, int newIndex)
Parameters
Type Name Description
System.Int32 oldIndex
System.Int32 newIndex

OnLoadInputPorts()

Declaration
public virtual void OnLoadInputPorts()

RemoveIn(String)

Declaration
public void RemoveIn(string name)
Parameters
Type Name Description
System.String name

RenameIn(String, String)

Declaration
public void RenameIn(string oldName, string newName)
Parameters
Type Name Description
System.String oldName
System.String newName

Events

OnInPortAdded

Declaration
public event Action<InPort> OnInPortAdded
Event Type
Type Description
Action<InPort>

OnInPortMoved

Declaration
public event Action<InPort, int> OnInPortMoved
Event Type
Type Description
Action<InPort, System.Int32>

OnInPortRemoved

Declaration
public event Action<InPort> OnInPortRemoved
Event Type
Type Description
Action<InPort>

OnInPortRenamed

Declaration
public event Action<InPort, string, string> OnInPortRenamed
Event Type
Type Description
Action<InPort, System.String, System.String>

Implements