Struct NodeHandle<TDefinition>

A strongly typed version of a NodeHandle.

A strongly typed version can automatically decay to an untyped NodeHandle, but the other way around requires a cast.

Strongly typed handles are pre-verified and subsequently can be a lot more efficient in usage, as no type checks need to be performed internally.

CastHandle<TDefinition>(NodeHandle)

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: Unity.DataFlowGraph

Syntax

public struct NodeHandle<TDefinition> : IEquatable<NodeHandle<TDefinition>> where TDefinition : NodeDefinition

Type Parameters

Name	Description
TDefinition

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

Equals(NodeHandle<TDefinition>)

Declaration

public bool Equals(NodeHandle<TDefinition> other)

Parameters

Type	Name	Description
NodeHandle<TDefinition>	other

Returns

Type	Description
Boolean

Implements

IEquatable<T>.Equals(T)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

Tie<TType>(DataInput<TDefinition, TType>)

Combine this node handle with input to form a type validated endpoint. See IEndpoint for more information.

Declaration

public DataInputEndpoint<TType> Tie<TType>(DataInput<TDefinition, TType> input)
    where TType : struct

Parameters

Type	Name	Description
DataInput<TDefinition, TType>	input

Returns

Type	Description
DataInputEndpoint<TType>

Type Parameters

Name	Description
TType

Tie<TType>(DataOutput<TDefinition, TType>)

Combine this node handle with output to form a type validated endpoint. See IEndpoint for more information.

Declaration

public DataOutputEndpoint<TType> Tie<TType>(DataOutput<TDefinition, TType> output)
    where TType : struct

Parameters

Type	Name	Description
DataOutput<TDefinition, TType>	output

Returns

Type	Description
DataOutputEndpoint<TType>

Type Parameters

Name	Description
TType

Tie<TType>(MessageInput<TDefinition, TType>)

Combine this node handle with input to form a type validated endpoint. See IEndpoint for more information.

Declaration

public MessageInputEndpoint<TType> Tie<TType>(MessageInput<TDefinition, TType> input)
    where TType : struct

Parameters

Type	Name	Description
MessageInput<TDefinition, TType>	input

Returns

Type	Description
MessageInputEndpoint<TType>

Type Parameters

Name	Description
TType

Tie<TType>(MessageOutput<TDefinition, TType>)

Combine this node handle with output to form a type validated endpoint. See IEndpoint for more information.

Declaration

public MessageOutputEndpoint<TType> Tie<TType>(MessageOutput<TDefinition, TType> output)
    where TType : struct

Parameters

Type	Name	Description
MessageOutput<TDefinition, TType>	output

Returns

Type	Description
MessageOutputEndpoint<TType>

Type Parameters

Name	Description
TType

Tie<TCompleteDefinition, TDSLDefinition, IDSL>(DSLInput<TCompleteDefinition, TDSLDefinition, IDSL>)

Combine this node handle with input to form a type validated endpoint. See IEndpoint for more information.

Declaration

public DSLInputEndpoint<TDSLDefinition> Tie<TCompleteDefinition, TDSLDefinition, IDSL>(DSLInput<TCompleteDefinition, TDSLDefinition, IDSL> input)
    where TCompleteDefinition : TDefinition, IDSL where TDSLDefinition : DSLHandler<IDSL>, new()
    where IDSL : class

Parameters

Type	Name	Description
DSLInput<TCompleteDefinition, TDSLDefinition, IDSL>	input

Returns

Type	Description
DSLInputEndpoint<TDSLDefinition>

Type Parameters

Name	Description
TCompleteDefinition
TDSLDefinition
IDSL

Tie<TCompleteDefinition, TDSLDefinition, IDSL>(DSLOutput<TCompleteDefinition, TDSLDefinition, IDSL>)

Combine this node handle with output to form a type validated endpoint. See IEndpoint for more information.

Declaration

public DSLOutputEndpoint<TDSLDefinition> Tie<TCompleteDefinition, TDSLDefinition, IDSL>(DSLOutput<TCompleteDefinition, TDSLDefinition, IDSL> output)
    where TCompleteDefinition : TDefinition, IDSL where TDSLDefinition : DSLHandler<IDSL>, new()
    where IDSL : class

Parameters

Type	Name	Description
DSLOutput<TCompleteDefinition, TDSLDefinition, IDSL>	output

Returns

Type	Description
DSLOutputEndpoint<TDSLDefinition>

Type Parameters

Name	Description
TCompleteDefinition
TDSLDefinition
IDSL

Operators

Equality(NodeHandle<TDefinition>, NodeHandle<TDefinition>)

Declaration

public static bool operator ==(NodeHandle<TDefinition> left, NodeHandle<TDefinition> right)

Parameters

Type	Name	Description
NodeHandle<TDefinition>	left
NodeHandle<TDefinition>	right

Returns

Type	Description
Boolean

Implicit(NodeHandle<TDefinition> to NodeHandle)

Declaration

public static implicit operator NodeHandle(NodeHandle<TDefinition> handle)

Parameters

Type	Name	Description
NodeHandle<TDefinition>	handle

Returns

Type	Description
NodeHandle

Inequality(NodeHandle<TDefinition>, NodeHandle<TDefinition>)

Declaration

public static bool operator !=(NodeHandle<TDefinition> left, NodeHandle<TDefinition> right)

Parameters

Type	Name	Description
NodeHandle<TDefinition>	left
NodeHandle<TDefinition>	right

Returns

Type	Description
Boolean