Class TSparseArrayPhastDataSet

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastDataSets

Declaration

type TSparseArrayPhastDataSet = class(TCustomPhastDataSet)

Description

TSparseArrayPhastDataSet is a abstract ancestor for sparse data set. It is used mainly for boundary conditions because it doesn't store data at locations where no data is needed.

It stores most of the data required for PHAST style interpolation. Its descendants store the rest of the data depending on whether integer or real numbers are to be stored.

TSparseArrayPhastDataSet is never used directly, it is used as a common ancestor of other classes.

Most TSparseArrayPhastDataSet are managed by a TTimeList. Because they are created and destroyed frequently, they generally should not subscribe or be subscribed to. (See TObserver.Subscribe.) Instead notify the TTimeList via the Invalidate method of the TTimeList that owns the TSparseArrayPhastDataSet or TObserver.OnUpToDateSet

Hierarchy

Overview

Fields

Private FAnnotation: T3DSparseStringArray;
Private FBoundaryDataType: TDataArray;
Private FCellDistance1: T3DSparseRealArray;
Private FCellDistance2: T3DSparseRealArray;
Private FCellInterpolationDirection: T3DSparseInterpolationDirectionArray;
Private FIsInterpolatedCell: T3DSparseBooleanArray;
Private FTimeList: TTimeList;

Methods

Protected function GetAnnotation(const Layer, Row, Col: integer): string; override;
Protected function GetCellDistance1(const ALay, ARow, ACol: integer): double; override;
Protected function GetCellDistance2(const ALay, ARow, ACol: integer): double; override;
Protected function GetCellInterpolationDirection(const ALay, ARow, ACol: integer): TInterpolationDirection; override;
Protected function GetIsInterpolatedCell(const ALay, ARow, ACol: integer): boolean; override;
Protected function GetIsValue(const Layer, Row, Col: Integer): boolean; override;
Protected procedure ResetCellsPhastInterpolation; override;
Protected procedure SetAnnotation(const Layer, Row, Col: integer; const Value: string); override;
Protected procedure SetCellDistance1(const ALay, ARow, ACol: integer; const Value: double); override;
Protected procedure SetCellDistance2(const ALay, ARow, ACol: integer; const Value: double); override;
Protected procedure SetCellInterpolationDirection(const ALay, ARow, ACol: integer; const Value: TInterpolationDirection); override;
Protected procedure SetDimensions(const SetToZero: boolean); override;
Protected procedure SetIsInterpolatedCell(const ALay, ARow, ACol: integer; const Value: boolean); override;
Protected procedure SetIsValue(const Layer, Row, Col: Integer; const Value: boolean); override;
Public constructor Create(AnOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Initialize; override;

Properties

Public property ATimeList: TTimeList read FTimeList write FTimeList;
Public property BoundaryDataType: TDataArray read FBoundaryDataType write FBoundaryDataType;

Description

Fields

Private FAnnotation: T3DSparseStringArray;

FAnnotation: T3DSparseStringArray; See TCustomPhastDataSet.Annotation.

Private FBoundaryDataType: TDataArray;

FBoundaryDataType: TDataArray; See BoundaryDataType.

Private FCellDistance1: T3DSparseRealArray;

FCellDistance1: T3DSparseRealArray; See TCustomPhastDataSet.CellDistance1.

Private FCellDistance2: T3DSparseRealArray;

FCellDistance2: T3DSparseRealArray; See TCustomPhastDataSet.CellDistance2.

Private FCellInterpolationDirection: T3DSparseInterpolationDirectionArray;

FCellInterpolationDirection: T3DSparseInterpolationDirectionArray; See TCustomPhastDataSet.InterpolationDirection.

Private FIsInterpolatedCell: T3DSparseBooleanArray;

FIsInterpolatedCell: T3DSparseBooleanArray; See TCustomPhastDataSet.IsInterpolatedCell.

Private FTimeList: TTimeList;

FTimeList: TTimeList; See ATimeList.

Methods

Protected function GetAnnotation(const Layer, Row, Col: integer): string; override;

See TCustomPhastDataSet.Annotation.

Protected function GetCellDistance1(const ALay, ARow, ACol: integer): double; override;

See TCustomPhastDataSet.CellDistance1.

Protected function GetCellDistance2(const ALay, ARow, ACol: integer): double; override;

See TCustomPhastDataSet.CellDistance2.

Protected function GetCellInterpolationDirection(const ALay, ARow, ACol: integer): TInterpolationDirection; override;

See TCustomPhastDataSet.InterpolationDirection.

Protected function GetIsInterpolatedCell(const ALay, ARow, ACol: integer): boolean; override;

See TCustomPhastDataSet.IsInterpolatedCell.

Protected function GetIsValue(const Layer, Row, Col: Integer): boolean; override;

See TCustomPhastDataSet.IsValue.

Protected procedure ResetCellsPhastInterpolation; override;

ResetCellsPhastInterpolation clears TCustomPhastDataSet.IsInterpolatedCell.

Protected procedure SetAnnotation(const Layer, Row, Col: integer; const Value: string); override;

See TCustomPhastDataSet.Annotation.

Protected procedure SetCellDistance1(const ALay, ARow, ACol: integer; const Value: double); override;

See TCustomPhastDataSet.CellDistance1.

Protected procedure SetCellDistance2(const ALay, ARow, ACol: integer; const Value: double); override;

See TCustomPhastDataSet.CellDistance2.

Protected procedure SetCellInterpolationDirection(const ALay, ARow, ACol: integer; const Value: TInterpolationDirection); override;

See TCustomPhastDataSet.InterpolationDirection.

Protected procedure SetDimensions(const SetToZero: boolean); override;

SetDimensions clears all the sparse data arrays.

Protected procedure SetIsInterpolatedCell(const ALay, ARow, ACol: integer; const Value: boolean); override;

See TCustomPhastDataSet.IsInterpolatedCell.

Protected procedure SetIsValue(const Layer, Row, Col: Integer; const Value: boolean); override;

See TCustomPhastDataSet.IsValue.

Public constructor Create(AnOwner: TComponent); override;

Create creates an instance of TSparseArrayPhastDataSet.

Public destructor Destroy; override;

Destroy destroys the current instance of TSparseArrayPhastDataSet. Do not call Destroy directly. Call Free instead.

Public procedure Initialize; override;

Initialize assigns values to all the cells that ought to have values assigned.

Properties

Public property ATimeList: TTimeList read FTimeList write FTimeList;

ATimeList is the TTimeList that controls this TSparseArrayPhastDataSet.

Public property BoundaryDataType: TDataArray read FBoundaryDataType write FBoundaryDataType;

BoundaryDataType is the data set used to indicate what type of boundary is at a specific location.

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