Loading...
Searching...
No Matches
ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue > Interface Template Reference

Per-series mutation surface inside the lease. Append, replace, clear, and trim operations are buffered to the back-stage and become visible to the renderer on lease disposal. More...

Inheritance diagram for ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >:
[legend]

Public Member Functions

bool Append (long timestampNanos, TValue value)
 Append one sample to the back-stage. Returns true when stored, false when discarded because timestampNanos is older than the latest committed-or-staged sample. Equal-timestamp appends replace the latest staged sample (or the latest committed one if no staged samples yet).
 
bool Append (in HeatmapIndicatorSample< TValue > sample)
 Append a pre-built sample by reference. Equivalent to Append(long,TValue) with the sample fields, but avoids destructuring + reconstructing the struct when the indicator already holds a HeatmapIndicatorSample<TValue> (e.g. from warm-up payload or a calculation that returned the sample shape).
 
int AppendRange (ReadOnlySpan< HeatmapIndicatorSample< TValue > > samples)
 Append a span of samples; same ordering rules as Append(long,TValue). Returns the number of samples accepted.
 
void Clear ()
 Drop every sample in this series. After commit, IHeatmapSeriesStateNode.CommittedCount reads as zero. Combined with subsequent appends in the same lease this is the canonical "rebuild" pattern for indicator-initiated recalculation (see design doc §5.2).
 
int TrimBefore (long timestampNanos)
 Evict every committed sample whose timestamp < timestampNanos . Returns the number of samples evicted. Useful at session boundaries to bound memory.
 

Properties

HeatmapIndicatorVisualStyle? Style [get, set]
 Per-series style override; null falls back to the descriptor default.
 

Detailed Description

Per-series mutation surface inside the lease. Append, replace, clear, and trim operations are buffered to the back-stage and become visible to the renderer on lease disposal.

Template Parameters
TValueIndicator-internal sample type.

Member Function Documentation

◆ Append() [1/2]

bool ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >.Append ( in HeatmapIndicatorSample< TValue >  sample)

Append a pre-built sample by reference. Equivalent to Append(long,TValue) with the sample fields, but avoids destructuring + reconstructing the struct when the indicator already holds a HeatmapIndicatorSample<TValue> (e.g. from warm-up payload or a calculation that returned the sample shape).

◆ Append() [2/2]

bool ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >.Append ( long  timestampNanos,
TValue  value 
)

Append one sample to the back-stage. Returns true when stored, false when discarded because timestampNanos is older than the latest committed-or-staged sample. Equal-timestamp appends replace the latest staged sample (or the latest committed one if no staged samples yet).

◆ AppendRange()

int ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >.AppendRange ( ReadOnlySpan< HeatmapIndicatorSample< TValue > >  samples)

Append a span of samples; same ordering rules as Append(long,TValue). Returns the number of samples accepted.

◆ Clear()

Drop every sample in this series. After commit, IHeatmapSeriesStateNode.CommittedCount reads as zero. Combined with subsequent appends in the same lease this is the canonical "rebuild" pattern for indicator-initiated recalculation (see design doc §5.2).

◆ TrimBefore()

int ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >.TrimBefore ( long  timestampNanos)

Evict every committed sample whose timestamp < timestampNanos . Returns the number of samples evicted. Useful at session boundaries to bound memory.

Property Documentation

◆ Style

HeatmapIndicatorVisualStyle? ATAS.Indicators.Heatmap.IHeatmapSeriesLease< TValue >.Style
getset

Per-series style override; null falls back to the descriptor default.


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