Class BlockDescriptor

One registered block type, with the display metadata and parameter hints the GUI needs.

Inheritance
BlockDescriptor
Namespace: MOSAIC.Components.Factory
Assembly: MOSAIC.dll
Syntax
public sealed record BlockDescriptor : IEquatable<BlockDescriptor>
Remarks

Carries the CLR Type (compile-checked) so BlockConstraints can reflect input arity off it.

Constructors

BlockDescriptor(string, Type, string, BlockCategory, string, IReadOnlyList<ParamHint>)

One registered block type, with the display metadata and parameter hints the GUI needs.

Declaration
public BlockDescriptor(string TypeKey, Type BlockType, string DisplayName, BlockCategory Category, string Description, IReadOnlyList<ParamHint> Params)
Parameters
Type Name Description
string TypeKey
Type BlockType
string DisplayName
BlockCategory Category
string Description
IReadOnlyList<ParamHint> Params
Remarks

Carries the CLR Type (compile-checked) so BlockConstraints can reflect input arity off it.

Properties

BlockType

Declaration
public Type BlockType { get; init; }
Property Value
Type Description
Type

CanBeSource

Whether the block needs no inputs and can originate a stream. Derived from the block class via BlockConstraints (reflection) — never hand-set, so it can't drift.

Declaration
public bool CanBeSource { get; }
Property Value
Type Description
bool

Category

Declaration
public BlockCategory Category { get; init; }
Property Value
Type Description
BlockCategory

Description

Declaration
public string Description { get; init; }
Property Value
Type Description
string

DisplayName

Declaration
public string DisplayName { get; init; }
Property Value
Type Description
string

Params

Declaration
public IReadOnlyList<ParamHint> Params { get; init; }
Property Value
Type Description
IReadOnlyList<ParamHint>

TypeKey

Declaration
public string TypeKey { get; init; }
Property Value
Type Description
string

Implements

IEquatable<T>

Search documentation

Start typing to search the documentation.