Class NodeFunctionality

Base class for all node definition declarations. Provides helper functionality and base implementations around INodeFunctionality.

A NodeFunctionality instance exists per existing NodeSet.

Inheritance
Object
NodeFunctionality
NodeFunctionality<TSimulationPortDefinition>
Inherited Members
Namespace: Unity.DataFlowGraph
Syntax
public abstract class NodeFunctionality : INodeDefinition, INodeFunctionality, IDisposable

Fields

AutoPorts

Declaration
protected PortDescription AutoPorts
Field Value
Type Description
PortDescription

Properties

BaseTraits

Declaration
public abstract NodeTraitsBase BaseTraits { get; }
Property Value
Type Description
NodeTraitsBase
Implements

Set

The NodeSet associated with this instance of this node definition.

Declaration
public NodeSet Set { get; set; }
Property Value
Type Description
NodeSet
Implements

Methods

Destroy(NodeHandle)

See Destroy(NodeHandle)

Declaration
public virtual void Destroy(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Implements

Dispose()

Called when disposing a NodeSet. Dispose()

Declaration
public virtual void Dispose()
Implements

EmitMessage<T, TNodeDefinition>(NodeHandle, MessageOutput<TNodeDefinition, T>, T)

Emit a message from yourself on a port. Everything connected to it will receive your message.

Declaration
protected void EmitMessage<T, TNodeDefinition>(NodeHandle from, MessageOutput<TNodeDefinition, T> port, in T msg)
    where TNodeDefinition : INodeDefinition
Parameters
Type Name Description
NodeHandle from
MessageOutput<TNodeDefinition, T> port
T msg
Type Parameters
Name Description
T
TNodeDefinition

GeneratePortDescriptions()

Declaration
public void GeneratePortDescriptions()
Implements

GetPortDescription(NodeHandle)

Retrieve the runtime type information about this node's input and output ports (see PortDescription.

Declaration
public virtual PortDescription GetPortDescription(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
PortDescription
Implements

Init(InitContext)

See Init(InitContext)

Declaration
public virtual void Init(InitContext ctx)
Parameters
Type Name Description
InitContext ctx
Implements

OnMessage<T>(MessageContext, T)

Declaration
public virtual void OnMessage<T>(in MessageContext ctx, in T msg)
Parameters
Type Name Description
MessageContext ctx
T msg
Type Parameters
Name Description
T
Implements

OnUpdate(NodeHandle)

See OnUpdate(NodeHandle)

Declaration
public virtual void OnUpdate(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Implements