CalculationSettingsCalculationDependencyIdentifiers Class

Spotfire 14.3 API Reference
Implement this to contain CalculationDependencyIdentifier objects to uniquely identify each result in this CalculationSettings.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.CalculationsCalculationSettingsCalculationDependencyIdentifiers

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

C#
public abstract class CalculationDependencyIdentifiers

The CalculationSettingsCalculationDependencyIdentifiers type exposes the following members.

Constructors

  NameDescription
Protected methodCalculationSettingsCalculationDependencyIdentifiers
Initializes a new instance of type CalculationSettingsCalculationDependencyIdentifiers. This constructor must never be used. Instead, use CreateIdentifier(String).
Top
Methods

  NameDescription
Protected methodStatic memberCreateIdentifier
Use this to create a new CalculationDependencyIdentifier
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Each CalculationSettings 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 CalculationDependencyIdentifier is used to name each dependency when adding them with one of the AddDependency overrides. They can then be used to get the dependencies to use as input in the calculation step.
Examples

An implementation of this class could look like: 
                public new abstract class CalculationDependencyIdentifiers 
                    : CalculationSettings.CalculationDependencyIdentifiers
                {
                    internal static readonly CalculationDependencyIdentifier XColumns = CreateIdentifier("XColumns");

                    internal static readonly CalculationDependencyIdentifier YColumns = CreateIdentifier("YColumns");

                    internal static readonly CalculationDependencyIdentifier DataFilteringSelection = CreateIdentifier("DataFilteringSelection"); 
                }
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
See Also

Reference