Click or drag to resize

PeakFittingBaseControllerTModel, TView Class

Base controller for peak-fitting option documents.
Inheritance Hierarchy
SystemObject
  Altaxo.GuiControllerBase
    Altaxo.GuiMVCANControllerEditImmutableDocBaseTModel, TView
      Altaxo.Gui.Science.Spectroscopy.PeakFittingPeakFittingBaseControllerTModel, TView
        More

Namespace: Altaxo.Gui.Science.Spectroscopy.PeakFitting
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
public abstract class PeakFittingBaseController<TModel, TView> : MVCANControllerEditImmutableDocBase<TModel, TView>
where TView : class

Type Parameters

TModel
The model type.
TView
The view type.

The PeakFittingBaseControllerTModel, TView type exposes the following members.

Constructors
 NameDescription
Protected methodPeakFittingBaseControllerTModel, TViewInitializes a new instance of the PeakFittingBaseControllerTModel, TView class
Top
Properties
 NameDescription
Public propertyCmdConfigureFitFunction Gets the command that configures the current fit function.
Public propertyFitFunctions Gets or sets the available fit functions.
Public propertyFitWidthScalingFactor Gets or sets the fit-width scaling factor.
Public propertyFitWidthScalingFactorEnvironment Gets the unit environment for the fit-width scaling factor.
Public propertyIsDisposed Gets a value indicating whether this controller is already disposed.
(Inherited from ControllerBase)
Public propertyIsMinimalFWHMValueInXUnits Gets or sets a value indicating whether the minimal FWHM value is expressed in X units.
Public propertyMinimalFWHMValue Gets or sets the minimal FWHM value.
Public propertyModelObject Gets the model (document) that this controller manages.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected propertyNoDocumentException Gets an exception that is thrown when a controller was not initialized with a document.
(Inherited from ControllerBase)
Protected propertyNotInitializedException Gets an exception that is thrown when a controller is not properly initialized.
(Inherited from ControllerBase)
Protected propertyNoViewException Gets an exception that is thrown when a controller currently has no view.
(Inherited from ControllerBase)
Public propertyUseDocumentCopy Sets whether or not a copy of the document is used. If set to true, a copy of the document is used, so if the controller is not applied, all changes can be reverted. If set to false, no copy must be made. The document is directly changed by the controller, and changes cannot be reverted. Use the last option if a controller higher in the hierarchy has already made a copy of the document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public propertyViewObject Gets or sets the GUI element that shows the model to the user.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Top
Methods
 NameDescription
Public methodApply Called when the user input has to be applied to the document being controlled. Returns if applying succeeded.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodApplyEnd Helper that performs the final steps of the apply operation, optionally disposing the controller.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodAttachView Override this function to attach the view to the controller, either by subscribing to events of the view, or by setting the controller object on the view.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodCheckDocumentInitializedT Checks whether the document has been initialized and throws an exception if it is null.
(Inherited from ControllerBase)
Protected methodDetachView Override this function to detach the view from the controller, either by unsubscribing from events of the view or by setting the controller object on the view to null.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from ControllerBase)
Public methodDispose(Boolean) Releases unmanaged and, optionally, managed resources.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodEhCanConfigureFitFunction Determines whether the current fit function exposes configurable properties.
Protected methodEhConfigureFitFunction Opens a dialog to configure the current fit function.
Protected methodEhFitFunctionChanged Handles selection changes of the fit function.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetSubControllers Enumerates the sub controllers. This function is called on Dispose(Boolean) of this controller to dispose the sub controllers too. By overriding this function, there is no need to override Dispose(Boolean).
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodInitialize Basic initialization of the document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodInitializeDocument Initializes the controller with the document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodInitializeFitFunctions Initializes the available fit functions.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOnPropertyChanged Raises the PropertyChanged event.
(Inherited from ControllerBase)
Public methodRevert Tries to revert changes to the model, i.e. restores the original state of the model.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected methodThrowIfNotInitializedThrows an exception if the controller is not initialized with a document.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
(Inherited from ControllerBase)
Top
Fields
 NameDescription
Protected field_currentFitFunctionThe currently selected fit function.
Protected field_doc The document to edit. If _useDocumentCopy is , this is a copy of the original document; otherwise, it is the original document itself.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_fitFunctionInstancesKeeps the configured fit functions. Key is the type, value is the instance.
Protected field_originalDoc The original document. If _useDocumentCopy is , it may have been edited by this controller.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_useDocumentCopy If , a copy of the document is made before editing; this copy can later be used to revert the state of the document to the original state.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Protected field_view The GUI view of this controller.
(Inherited from MVCANControllerEditImmutableDocBaseTModel, TView)
Top
See Also
Inheritance Hierarchy