IAccumulator Interface

Spotfire 14.2 API Reference
This is the interface that a CustomAggregationMethod implement to perform the actual calculation. The accumulator is created in a factory method on the CustomAggregationMethod class. Before the calculation starts the Initialize method is called and when the calculation is complete then the Terminate method is called terminate the calculation allowing the Result property to be used to retrieve the result.

Namespace:  Spotfire.Dxp.Data.Computations
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public interface IAccumulator

The IAccumulator type exposes the following members.

Properties

  NameDescription
Public propertyResult
Gets the result value after the calculation is finished. This property is only retrieved after the Terminate call.
Top
Methods

  NameDescription
Public methodInitialize
Initializes the accumulator. This method is called before the calculation starts. This method can be called multiple times on the same instance and the accumulator should reset internal state after each call.
Public methodTerminate
Stops the calculations and calculates the result value.
Top
Remarks

All useful implementors of this interface should also implement one or more of the IIterativeAccumulator, IDependentAccumulator and ISortedAccumulator interfaces.
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference