Interface IBaseBlockProps

Defines common monitoring and identification properties exposed by MOSAIC processing blocks.

Namespace: MOSAIC.Components.Basics
Assembly: MOSAIC.dll
Syntax
public interface IBaseBlockProps
Remarks

This interface is primarily intended for UI binding and runtime diagnostics. Implementations typically update Status and FrequencyText based on internal timing measurements (for example via a tick tracker) and expose DesiredRate as a reference value for performance evaluation.

DesiredRate does not imply throttling by itself; it is used as the expected target rate for status classification (e.g., “lagging” vs. “normal”).

Properties

DesiredRate

Gets or sets the desired processing rate in Hertz used as a reference for status evaluation.

Declaration
double DesiredRate { get; set; }
Property Value
Type Description
double
Remarks

This value is used to interpret measured timing (e.g., whether a block is idle or lagging). It does not throttle execution unless a specific block implementation uses it for scheduling.

FrequencyText

Gets a human-readable representation of the current output rate in Hertz (e.g., "200.0 Hz").

Declaration
string FrequencyText { get; }
Property Value
Type Description
string
Remarks

Intended for UI display. Implementations typically format this from an internally computed rate estimate.

Name

Gets or sets the display name of the block.

Declaration
string Name { get; set; }
Property Value
Type Description
string
Remarks

Typically assigned from the pipeline configuration to identify the block in UI views and logs.

Status

Gets the current execution status of the block (e.g., Idle, Lagging, Normal).

Declaration
BlockStatus Status { get; }
Property Value
Type Description
BlockStatus
Remarks

Implementations usually compute this value from timing measurements and internal contention indicators.

Search documentation

Start typing to search the documentation.