ForecastHoltWintersFittingModel Members TIBCO Spotfire 6.0 API Reference
The ForecastHoltWintersFittingModel type exposes the following members.
Methods

  NameDescription
Protected methodConfigureModelCore
Override this method to configure the fitting model.
(Inherited from FittingModel.)
Protected methodCreateCurve
Creates a new curve.
(Inherited from FittingModel.)
Protected methodCreateEventRelay
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 methodCreatePoint
Creates a new point.
(Inherited from FittingModel.)
Protected methodCreateProperty T (PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TNode (PropertyName, UndoableCrossReferenceProperty TNode  , TNode) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableProperty T  , T) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TValue (PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TNode (PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyProperty T 
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstant T 
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 methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , DependencyDeclarer, PropertyComputer T )Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , StatelessDependencyDeclarer, StatelessPropertyComputer T ) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferenceProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TValue (SerializationInfo, StreamingContext, PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TNode (SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyProperty T 
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtree T 
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 methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFit
Performs the fitting operation.
(Inherited from FittingModel.)
Protected methodGetConfigureModelTriggerCore
Override this method to provide a Trigger that fires when the fitting model needs to be reconfigured.
(Inherited from FittingModel.)
Protected methodGetCurve
Gets the curve with the specified name.
(Inherited from FittingModel.)
Protected methodGetPersistedTypeName
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 methodGetPersistedVersion
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 methodGetPoint
Gets the point with the specified name.
(Inherited from FittingModel.)
Public methodGetResultsDataSource
Gets the current results as a data source.
(Inherited from FittingModel.)
Protected methodGetResultTriggerCore
Method called by the framework to get a Trigger that fires when the results become invalid. Subclasses should override this method if they declare properties that affect the result.
(Inherited from FittingModel.)
Protected methodGetService
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableCrossReferenceProperty T )
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableList T )
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableProperty T )
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableSet T )
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TValue (SerializationInfo, StreamingContext, UndoableDictionary TKey, TValue )
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TNode (SerializationInfo, StreamingContext, UndoableKeyedCollection TKey, TNode ) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyProperty T 
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodSupportsVisualConfigurationCore
Tells whether a class implementing FittingModel supports the specified VisualContent instance.
(Inherited from FittingModel.)
Public methodUpdate
Forces an update of this fitting model. Only allowed if ManualUpdate is set to true.
(Inherited from FittingModel.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Back to Top
Properties

  NameDescription
Public propertyAllowEmptyValueReplacement
Gets or sets a value indicating whether this Holt Winters model allows interpolation to replace missing values. Setting this to true will mean that an empty value in the time series will be replaced by linear interpolation between the values before and after it. If there are multiple empty values in a row then no curve fit is computed. Setting this value to false will mean that if empty values are found in the time series, no curve fit is computed.
Public propertyAutomaticFrequency
Gets or sets a value indicating whether the frequency parameter is deduced from the visualization.
Public propertyConfidenceCurve
Gets the confidence curve.
Public propertyConfidenceLevel
Gets or sets the confidence level for the prediction intervals. Must be within the half-open unit interval [0, 1), but is typically close to 1.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyEnabled
Gets or sets a value indicating whether this FittingModel is enabled.
(Inherited from FittingModel.)
Public propertyFittedCurve
Gets the fitted curve.
Public propertyForecastCurve
Gets the forecast curve.
Public propertyFrequency
Gets or sets the frequency (the number of observations per sampling period). For example, monthly data have frequency=12. This must be greater than 1 to fit a seasonal component.
This is a convenience wrapper of FrequencyExpression. If this property is read when preprocessor expression does not evaluate to a positive integer, -1 is returned.
Public propertyFrequencyExpression
Gets or sets the frequency expression (the number of observations per sampling period). For example, monthly data have frequency=12. This string is preprocessed and should evaluate to a positive integer. This must be greater than 1 to fit a seasonal component.
Public propertyIndividualFittingModes
The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.
(Inherited from FittingModel.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLevel
Gets or sets the level (alpha) parameter of Holt-Winters specifying how to smooth the level component. Must be within the half-open unit interval (0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of alpha.
Public propertyManualUpdate
Gets or sets a value indicating whether to use manual updates.
(Inherited from FittingModel.)
Public propertySeasonal
Gets or sets the seasonal (gamma) parameter of Holt-Winters specifying how to smooth the seasonal component. Must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of gamma.
Public propertySeasonalModelType
Gets or sets the seasonal parameter.
Public propertyTimePointsAhead
Gets or sets the number of time points in the future at which to predict the values of the time series. This is a convenience wrapper of TimePointsAheadExpression. If this property is read when the preprocessor expression does not evaluate to a positive integer, -1 is returned.
Public propertyTimePointsAheadExpression
Gets or sets the number of time points in the future at which to predict the values of the time series
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTrend
Gets or sets the trend (beta) parameter of Holt-Winters specifying how to smooth the trend component. Must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of beta.
Public propertyTypeId
Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers.
(Inherited from FittingModel.)
Public propertyUseSeasonal
Gets or sets a value indicating whether the seasonal component should be included or not.
Public propertyUseTrend
Gets or sets a value indicating whether the trend component should be included or not.
Back to Top
Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider GetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implemetationPrivate methodINodeContext GetAncestor T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext GetService T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext IsDescendantOf (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions BeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteTransaction (Inherited from DocumentNode.)
Back to Top
See Also