Class TCustom2DInterpolater

DescriptionHierarchyFieldsMethodsProperties

Unit

DataSetUnit

Declaration

type TCustom2DInterpolater = class(TComponent)

Description

TCustom2DInterpolater provides an abstract interface for 2D interpolation. Descendants of TCustom2DInterpolater provide concrete implementations.

Call RegisterClass in the initialization section for any descendants that are instantiated.

Descendants of TCustom2DInterpolater include TCustomAnisotropicInterpolator, TInvDistSq2DInterpolator, TNearest2DInterpolator, and TNearestPoint2DInterpolator.

Hierarchy

Overview

Fields

Private FDataSet: TDataArray;
Private FOnEdit: TNotifyEvent;
Private FOnFinalize: TInitializeDataSetInterpolator;
Private FOnInitialize: TInitializeDataSetInterpolator;

Methods

Protected procedure FillScreenObjectList(const ListOfScreenObjects: TList);
Public procedure Assign(Source: TPersistent); override;
Public function BooleanResult(const Location: T2DRealPoint): boolean; virtual;
Public constructor Create(AOwner: TComponent); override;
Public procedure Edit;
Public procedure Finalize(const DataSet: TDataArray);
Public procedure Initialize(const DataSet: TDataArray);
Public function IntegerResult(const Location: T2DRealPoint): integer; virtual;
Public class function InterpolatorName: string; virtual; abstract;
Public function RealResult(const Location: T2DRealPoint): real; virtual;
Public function SameAs(AnotherInterpolator: TCustom2DInterpolater): boolean; virtual;
Public function ShouldInterpolate: boolean;
Public function StringResult(const Location: T2DRealPoint): string; virtual;
Public class function ValidReturnTypes: TRbwDataTypes; virtual; abstract;

Properties

Public property DataSet: TDataArray read FDataSet;
Published property OnEdit: TNotifyEvent read FOnEdit write FOnEdit;
Published property OnFinalize: TInitializeDataSetInterpolator read FOnFinalize write FOnFinalize;
Published property OnInitialize: TInitializeDataSetInterpolator read FOnInitialize write FOnInitialize;

Description

Fields

Private FDataSet: TDataArray;

FDataSet: TDataArray; See DataSet.

Private FOnEdit: TNotifyEvent;

FOnEdit: TNotifyEvent; See OnEdit.

Private FOnFinalize: TInitializeDataSetInterpolator;

FOnFinalize: TInitializeDataSetInterpolator; See OnFinalize.

Private FOnInitialize: TInitializeDataSetInterpolator;

FOnInitialize: TInitializeDataSetInterpolator; See OnInitialize.

Methods

Protected procedure FillScreenObjectList(const ListOfScreenObjects: TList);

FillScreenObjectList fills ListOfScreenObjects with all the TScreenObjects that should be used to assign values to cells with this TCustom2DInterpolater. The order of TScreenObjects is the same as the order in frmGoPhast.Model.ScreenObjects.

Public procedure Assign(Source: TPersistent); override;

Assign copies the values from Source to the current TCustom2DInterpolater.

Public function BooleanResult(const Location: T2DRealPoint): boolean; virtual;

BooleanResult returns a boolean value at Location.

Public constructor Create(AOwner: TComponent); override;

Create creates an instance of TCustom2DInterpolater. If Owner is a TDataArray Create checks the DataType. Create makes itself a subcomponent of Owner.

Public procedure Edit;

If OnEdit is assigned, Edit calls OnEdit.

Public procedure Finalize(const DataSet: TDataArray);

If OnFinalize is assigned, Finalize calls OnFinalize. Finalize is called just after the interpolation process ends.

Public procedure Initialize(const DataSet: TDataArray);

If OnInitialize is assigned, Initialize calls OnInitialize. Initialize is called just before the interpolation process begins.

Public function IntegerResult(const Location: T2DRealPoint): integer; virtual;

IntegerResult returns a integer value at Location.

Public class function InterpolatorName: string; virtual; abstract;

InterpolatorName is the name of the interpolator as displayed to the user.

Public function RealResult(const Location: T2DRealPoint): real; virtual;

RealResult returns a real-number value at Location.

Public function SameAs(AnotherInterpolator: TCustom2DInterpolater): boolean; virtual;

SameAs returns True if AnotherInterpolator has the same parameters as the TCustom2DInterpolater being called.

Public function ShouldInterpolate: boolean;

ShouldInterpolate returns true if there are any TScreenObjects that can be used for interpolation with this data set.

Public function StringResult(const Location: T2DRealPoint): string; virtual;

StringResult returns a string value at Location.

Public class function ValidReturnTypes: TRbwDataTypes; virtual; abstract;

ValidReturnTypes indicates the types of data that the current TCustom2DInterpolater can be used with.

Properties

Public property DataSet: TDataArray read FDataSet;

DataSet is the TDataArray with which this TCustom2DInterpolater will be used. Normally DataSet is set by passing a TDataArray as AOwner in Create.

Published property OnEdit: TNotifyEvent read FOnEdit write FOnEdit;

OnEdit can be used to respond to a change in the interpolator.

Published property OnFinalize: TInitializeDataSetInterpolator read FOnFinalize write FOnFinalize;

If the TCustom2DInterpolater has to do something to finish up after the interpolation process use OnFinalize to do it.

Published property OnInitialize: TInitializeDataSetInterpolator read FOnInitialize write FOnInitialize;

If the TCustom2DInterpolater has to do something to get ready to start the interpolation process use OnInitialize to do it.

Generated by PasDoc 0.10.0 on 2006-10-31 09:56:33