CalculationSettings Methods TIBCO Spotfire 7.6 API Reference

The CalculationSettings type exposes the following members.

Methods

  Name Description
Protected method AddDependency(CalculationDependencyIdentifier, DataColumn)
Creates a dependency on a DataColumn identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
Protected method AddDependency(CalculationDependencyIdentifier, DataSelection)
Creates a dependency on a dataselection identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
Protected method AddDependency(CalculationDependencyIdentifier, IEnumerableDataColumn)
Creates a dependency on a number of DataColumn objects identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
Protected method 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.)
Protected method 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.)
Protected method CreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected method CreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected method CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected method CreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected method CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected method CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method CreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected method CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected method DeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Overrides DocumentNodeDeclareInternalEventHandlers(InternalEventManager).)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected method DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected method DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method DeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected method GetAdditionalIsValidTriggers
If a subclass has additional dependencies besides those added to the baseclass this method can be overridden to indicate when the input to the calculation has changed/disappeared so the calculation can no longer produce a sensible result. This will trigger the Calculation.HasValidValue property and cause invalid columns to be output the next time the calculation is run.
Protected method GetAdditionalNeedsRefreshTriggers
If a subclass has additional dependencies besides those added to the baseclass this method can be overridden to indicate when the input to the calculation has changed to warrant an invalidation or recalculation depending on UpdateBehavior. This will trigger the Calculation.NeedsRefresh property.
Protected method GetColumnDependencies
Get the column dependencies identified by a given CalculationDependencyIdentifier
Protected method GetDataSelectionDependency
Get the DataSelection dependency identified by a given CalculationDependencyIdentifier
Protected method 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.)
Protected method 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.)
Protected method GetSelectedRows Obsolete.
Gets the selected rows for a datatable and a CalculationDependencyIdentifier that has been registered together with a DataSelection.
Protected method 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.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method GetUpdateBehaviorTriggerCore
Override this method to provide a trigger which fire when the value of the UpdateBehavior changes.
Protected method InternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected method OnConfigure
Allows a node to configure itself to the surrounding document.
(Overrides DocumentNodeOnConfigure.)
Protected method OnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected method OnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected method OnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method SerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected method ValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Public method ValidateSettings
Validates the suggested columns, filtering selections and marking selections with respect to the current Settings and Results. In particular this means checking for circular references. This method is meant to be called from a dialog before allowing the user to set up dependencies that would cause errors. If the implementer forgets to do this the framework will run the same check before trying to calculate but without any chance for the user to modify their choices.
Top
Explicit Interface Implementations

  Name Description
Explicit interface implementation Private method IServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementation Private method INodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
See Also

Reference