CalculationResultsCalculationResultsIdentifiers Class

Spotfire 14.3 API Reference

Implement this to contain CalculationResultsIdentifier objects to uniquely identify each result in this CalculationResults.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.Application.CalculationsCalculationResultsCalculationResultsIdentifiers

Namespace: Spotfire.Dxp.Application.Calculations
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

public abstract class CalculationResultsIdentifiers

The CalculationResultsCalculationResultsIdentifiers type exposes the following members.

Constructors

	Name	Description
	CalculationResultsCalculationResultsIdentifiers	Initializes a new instance of type CalculationResultsCalculationResultsIdentifiers.

Top

Methods

	Name	Description
	CreateIdentifier	Use this to create a CalculationResultsIdentifier.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Each CalculationResults implementation should have an implementation of this inner class. Each CalculationResultsIdentifier should have a unique string within the identifiers in this class. The pattern is very similar to the pattern for DocumentNodePropertyNames. The CalculationResultsIdentifier is used to name each result when adding them to the ResultAccumulator and once the calculation is finished can be used to get the result.

Examples

Copy

An implementation of this class could look like: 
             public new abstract class CalculationResultsIdentifiers : CalculationResults.CalculationResultsIdentifiers
            {
                public static readonly CalculationResultsIdentifier MySpecialColumn = CreateIdentifier("MySpecialColumn");

                public static readonly CalculationResultsIdentifier MyLumpedTogetherColumns = CreateIdentifier("MyLumpedTogetherColumns");

                public static readonly CalculationResultsIdentifier MyNewTable = CreateIdentifier("MyNewTable");
            }

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Calculations Namespace

CalculationResultsAddLanguageSpecificTextSet("LSTF87D55A6_0?cpp=::|nu=.");CalculationResultsIdentifiers Class

Reference

CalculationResultsCalculationResultsIdentifiers Class