ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode Interface Reference

Read-only handle to a series within an IHeatmapVisualStateNode. The renderer iterates committed samples through this interface; mutation goes through the lease (IHeatmapVisualLease.Series<TValue>). More...

Inheritance diagram for ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode:

Public Member Functions
IEnumerable< HeatmapIndicatorVisualSample >	GetCommittedSamples ()
	Wait-free, forward-only enumeration of the front-committed samples in arrival order. The enumeration captures the committed snapshot at the moment of the call; subsequent commits do not affect an in-flight enumerator. Safe to call from any thread (typically the renderer at frame rate). Returns an empty sequence when no samples have been committed yet. The returned enumerable does NOT allocate beyond the implementation's iterator state — implementers should avoid materialising a list and may return a struct enumerator wrapped through IEnumerable<T>.

Properties
string	SeriesId [get]
	Stable series id, matches the descriptor entry.
HeatmapIndicatorSeriesDescriptor	Descriptor [get]
	Series-level descriptor — role, value kind, metric id, unit, default style.
HeatmapIndicatorVisualStyle?	Style [get]
	Active per-series style. Defaults to HeatmapIndicatorSeriesDescriptor.DefaultStyle; when null both the descriptor default and any visual-level style apply per renderer convention.
int	CommittedCount [get]
	Number of samples committed to the front and visible to the renderer.
long	LastCommittedTimestampNanos [get]
	Most recent committed sample timestamp, or 0 if empty.

Detailed Description

Read-only handle to a series within an IHeatmapVisualStateNode. The renderer iterates committed samples through this interface; mutation goes through the lease (IHeatmapVisualLease.Series<TValue>).

Member Function Documentation

GetCommittedSamples()

IEnumerable< HeatmapIndicatorVisualSample > ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.GetCommittedSamples

(

)

Wait-free, forward-only enumeration of the front-committed samples in arrival order. The enumeration captures the committed snapshot at the moment of the call; subsequent commits do not affect an in-flight enumerator. Safe to call from any thread (typically the renderer at frame rate). Returns an empty sequence when no samples have been committed yet. The returned enumerable does NOT allocate beyond the implementation's iterator state — implementers should avoid materialising a list and may return a struct enumerator wrapped through IEnumerable<T>.

Property Documentation

CommittedCount

int ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.CommittedCount

get

Number of samples committed to the front and visible to the renderer.

Descriptor

HeatmapIndicatorSeriesDescriptor ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.Descriptor

get

Series-level descriptor — role, value kind, metric id, unit, default style.

LastCommittedTimestampNanos

long ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.LastCommittedTimestampNanos

get

Most recent committed sample timestamp, or 0 if empty.

SeriesId

string ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.SeriesId

get

Stable series id, matches the descriptor entry.

Style

HeatmapIndicatorVisualStyle? ATAS.Indicators.Heatmap.IHeatmapSeriesStateNode.Style

get

Active per-series style. Defaults to HeatmapIndicatorSeriesDescriptor.DefaultStyle; when null both the descriptor default and any visual-level style apply per renderer convention.

---

The documentation for this interface was generated from the following file:

• IHeatmapVisualState.cs