Struct PortDescription.InputPort
Describes an input port on a node. An PortDescription.InputPort can automatically decay to- and be used as a weakly typed InputPortID.
Inherited Members
Namespace: Unity.DataFlowGraph
Syntax
public struct InputPort : PortDescription.IPort<InputPortID>, IEquatable<InputPortID>, IEquatable<PortDescription.InputPort>
Properties
Category
Describes the category of a port.
Declaration
public PortDescription.Category Category { get; }
Property Value
Type | Description |
---|---|
PortDescription.Category |
IsPortArray
True if the port is a PortArray<TPort>.
Declaration
public bool IsPortArray { get; }
Property Value
Type | Description |
---|---|
Boolean |
Name
Returns the name of the port suitable for use in UI.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
String |
PortUsage
Declaration
[Obsolete("Use Category instead.")]
public PortDescription.Category PortUsage { get; }
Property Value
Type | Description |
---|---|
PortDescription.Category |
Type
Describes the data type of a port.
Declaration
public Type Type { get; }
Property Value
Type | Description |
---|---|
Type |
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj |
Returns
Type | Description |
---|---|
Boolean |
Overrides
Equals(InputPortID)
Declaration
public bool Equals(InputPortID portID)
Parameters
Type | Name | Description |
---|---|---|
InputPortID | portID |
Returns
Type | Description |
---|---|
Boolean |
Implements
Equals(PortDescription.InputPort)
Declaration
public bool Equals(PortDescription.InputPort port)
Parameters
Type | Name | Description |
---|---|---|
PortDescription.InputPort | port |
Returns
Type | Description |
---|---|
Boolean |
Implements
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 |
Overrides
Operators
Equality(InputPortID, PortDescription.InputPort)
Declaration
public static bool operator ==(InputPortID left, PortDescription.InputPort right)
Parameters
Type | Name | Description |
---|---|---|
InputPortID | left | |
PortDescription.InputPort | right |
Returns
Type | Description |
---|---|
Boolean |
Equality(PortDescription.InputPort, PortDescription.InputPort)
Declaration
public static bool operator ==(PortDescription.InputPort left, PortDescription.InputPort right)
Parameters
Type | Name | Description |
---|---|---|
PortDescription.InputPort | left | |
PortDescription.InputPort | right |
Returns
Type | Description |
---|---|
Boolean |
Implicit(PortDescription.InputPort to InputPortID)
Returns the weakly typed port identifier that corresponds to the input port being described.
Declaration
public static implicit operator InputPortID(PortDescription.InputPort port)
Parameters
Type | Name | Description |
---|---|---|
PortDescription.InputPort | port |
Returns
Type | Description |
---|---|
InputPortID |
Inequality(InputPortID, PortDescription.InputPort)
Declaration
public static bool operator !=(InputPortID left, PortDescription.InputPort right)
Parameters
Type | Name | Description |
---|---|---|
InputPortID | left | |
PortDescription.InputPort | right |
Returns
Type | Description |
---|---|
Boolean |
Inequality(PortDescription.InputPort, PortDescription.InputPort)
Declaration
public static bool operator !=(PortDescription.InputPort left, PortDescription.InputPort right)
Parameters
Type | Name | Description |
---|---|---|
PortDescription.InputPort | left | |
PortDescription.InputPort | right |
Returns
Type | Description |
---|---|
Boolean |