Abstract class representing a calculation.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.DataCalculation
Spotfire.Dxp.Application.CalculationsCalculationTSettings, TResults
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(2, 10)] public abstract class Calculation : DocumentNode, IDependentComponent
The Calculation type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
| CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
| DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
 | Execute |
Execute the calculation. If the results exists they will updated - otherwise they will be created.
|
| Execute(CalculationExecutionPromptMode) |
Execute the calculation. If the results exists they will updated - otherwise they will be created.
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GenerateDataHistoryCore |
Create detail information for the Calculation.
See DataHistoryBuilder for more information on
how to add detailed information to the data history.
|
| GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
| SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| SetName |
Set the unique (within the CalculationCollection) name of
this Calculation instance.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Extension Methods
| Name | Description | |
|---|---|---|
 | GetServiceTService |
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.) |
Properties
| Name | Description | |
|---|---|---|
 | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
| IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
| IsValid |
Gets a value indicating whether or not this calculation can be calculated. A calculation
may for example be invalid when vital dependencies are missing.
|
| Name |
Gets the unique name of this calculation instance.
|
| NeedsRefresh |
Gets a value indicating whether or not this calculation needs refreshing (through
a call to Execute) to make sure that its results
are up-to-date.
|
| Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
| TypeId | Gets the type identifier for the Calculation.
|
| UpdateBehavior |
Gets the CalculationUpdateBehavior of the calculation.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
| INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
| INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
| INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
| ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
| ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
Version Information
See Also