Class TCustomPhastDataSet

Description

Hierarchy

Fields

Methods

Properties

Unit

PhastDataSets

Declaration

type TCustomPhastDataSet = class(TDataArray)

Description

TCustomPhastDataSet is the abstract ancestor of TDataArrays that use PHAST-style interpolation.

Hierarchy

TComponent
TObserver
TDataArray
TCustomPhastDataSet

Overview

Fields

	`FDistance1: double;`
	`FDistance2: double;`
	`FInterpolationDirection: TInterpolationDirection;`
	`FMixtureFormula: string;`
	`FMixtureUseList: TStringList;`
	`FMixtureUseListUpToDate: boolean;`
	`FUsePHAST_InterpolationForAllCells: boolean;`
	`FMixtureFormulaObject: TFormulaObject;`

Methods

	`function GetDistance1: double;`
	`function GetDistance2: double;`
	`function GetMixtureUseList: TStringList;`
	`procedure ResetCellsPhastInterpolation; virtual; abstract;`
	`procedure ResetMixtureExpression(const Compiler: TRbwParser; const ErrorMessage: string);`
	`procedure SetDistance1(const Value: double);`
	`procedure SetDistance2(const Value: double);`
	`procedure SetInterpolationDirection( const Value: TInterpolationDirection);`
	`procedure SetMixtureFormula(const Value: string);`
	`procedure SetUsePHAST_InterpolationForAllCells(const Value: boolean);`
	`procedure UpdateMixtureUseList;`
	`function GetMixtureFormula: string;`
	`procedure SetEvaluatedAt(const Value: TEvaluatedAt); override;`
	`procedure SetOrientation(const Value: TDataSetOrientation); override;`
	`procedure ReadData(DecompressionStream: TDecompressionStream); override;`
	`procedure StoreData(Stream: TStream); override;`
	`function GetCellDistance1(const ALay, ARow, ACol: integer): double; virtual; abstract;`
	`function GetCellDistance2(const ALay, ARow, ACol: integer): double; virtual; abstract;`
	`function GetCellInterpolationDirection(const ALay, ARow, ACol: integer): TInterpolationDirection; virtual; abstract;`
	`function GetIsInterpolatedCell(const ALay, ARow, ACol: integer): boolean; virtual; abstract;`
	`function GetUseList: TStringList; override;`
	`procedure InitializePhastArrays; virtual;`
	`procedure SetCellDistance1(const ALay, ARow, ACol: integer; const Value: double); virtual; abstract;`
	`procedure SetCellDistance2(const ALay, ARow, ACol: integer; const Value: double); virtual; abstract;`
	`procedure SetCellInterpolationDirection(const ALay, ARow, ACol: integer; const Value: TInterpolationDirection); virtual; abstract;`
	`procedure SetIsInterpolatedCell(const ALay, ARow, ACol: integer; const Value: boolean); virtual; abstract;`
	`procedure CheckIfUniform; override;`
	`procedure Assign(Source: TPersistent); override;`
	`constructor Create(AnOwner: TComponent); override;`
	`destructor Destroy; override;`
	`procedure Initialize; override;`
	`procedure Invalidate; override;`
	`procedure RefreshFormula; override;`

Properties

	`property MixtureUseList: TStringList read GetMixtureUseList;`
	`property CellDistance1[constALay,ARow,ACol:integer]: double read GetCellDistance1 write SetCellDistance1;`
	`property CellDistance2[constALay,ARow,ACol:integer]: double read GetCellDistance2 write SetCellDistance2;`
	`property CellInterpolationDirection[constALay,ARow,ACol:integer]: TInterpolationDirection read GetCellInterpolationDirection write SetCellInterpolationDirection;`
	`property IsInterpolatedCell[constALay,ARow,ACol:integer]: boolean read GetIsInterpolatedCell write SetIsInterpolatedCell;`
	`property Distance1: double read GetDistance1 write SetDistance1;`
	`property Distance2: double read GetDistance2 write SetDistance2;`
	`property InterpolationDirection: TInterpolationDirection read FInterpolationDirection write SetInterpolationDirection;`
	`property MixtureFormula: string read GetMixtureFormula write SetMixtureFormula;`
	`property UsePHAST_InterpolationForAllCells: boolean read FUsePHAST_InterpolationForAllCells write SetUsePHAST_InterpolationForAllCells;`

Description

Fields

	`FDistance1: double;`
See Distance1.

	`FDistance2: double;`
See Distance2.

	`FInterpolationDirection: TInterpolationDirection;`
See InterpolationDirection.

	`FMixtureFormula: string;`
`FMixtureFormula` is a temporary variable used when changing MixtureFormula.

	`FMixtureUseList: TStringList;`
See MixtureUseList.

	`FMixtureUseListUpToDate: boolean;`
`FMixtureUseListUpToDate` is set to false when MixtureUseList is out of date.

	`FUsePHAST_InterpolationForAllCells: boolean;`
See UsePHAST_InterpolationForAllCells.

	`FMixtureFormulaObject: TFormulaObject;`

Methods

	`function GetDistance1: double;`
See Distance1.

	`function GetDistance2: double;`
See Distance2.

	`function GetMixtureUseList: TStringList;`
See MixtureUseList.

	`procedure ResetCellsPhastInterpolation; virtual; abstract;`
`ResetCellsPhastInterpolation` clears all data regarding PHAST-style interpolation

	`procedure ResetMixtureExpression(const Compiler: TRbwParser; const ErrorMessage: string);`
`ResetMixtureExpression` sets the MixtureFormula to 0.5. `ResetMixtureExpression` is called if the MixtureFormula is invalid.

	`procedure SetDistance1(const Value: double);`
See Distance1.

	`procedure SetDistance2(const Value: double);`
See Distance2.

	`procedure SetInterpolationDirection( const Value: TInterpolationDirection);`
See InterpolationDirection.

	`procedure SetMixtureFormula(const Value: string);`
See MixtureFormula.

	`procedure SetUsePHAST_InterpolationForAllCells(const Value: boolean);`
See UsePHAST_InterpolationForAllCells.

	`procedure UpdateMixtureUseList;`
`UpdateMixtureUseList` recalculates MixtureUseList.

	`function GetMixtureFormula: string;`

	`procedure SetEvaluatedAt(const Value: TEvaluatedAt); override;`

	`procedure SetOrientation(const Value: TDataSetOrientation); override;`

	`procedure ReadData(DecompressionStream: TDecompressionStream); override;`

	`procedure StoreData(Stream: TStream); override;`

	`function GetCellDistance1(const ALay, ARow, ACol: integer): double; virtual; abstract;`
`GetCellDistance1` is the first of the distances used for PHAST-style interpolation.

	`function GetCellDistance2(const ALay, ARow, ACol: integer): double; virtual; abstract;`
`GetCellDistance2` is the second of the distances used for PHAST-style interpolation.

	`function GetCellInterpolationDirection(const ALay, ARow, ACol: integer): TInterpolationDirection; virtual; abstract;`
`GetCellInterpolationDirection` specifies whether the PHAST-style interpolation is done in the X, Y, or Z direction or with a mixture.

	`function GetIsInterpolatedCell(const ALay, ARow, ACol: integer): boolean; virtual; abstract;`
See IsInterpolatedCell.

	`function GetUseList: TStringList; override;`
`GetUseList` calls TDataArray.GetUseList `GetUseList` and then adds the contents of MixtureUseList if appropriate.

	`procedure InitializePhastArrays; virtual;`
`InitializePhastArrays` stores the PHAST-style interpolation data at all cells where it is appropriate to do so. `InitializePhastArrays` does nothing in `TCustomPhastDataSet` but in descendants it is used.

	`procedure SetCellDistance1(const ALay, ARow, ACol: integer; const Value: double); virtual; abstract;`
See CellDistance1.

	`procedure SetCellDistance2(const ALay, ARow, ACol: integer; const Value: double); virtual; abstract;`
See CellDistance2.

	`procedure SetCellInterpolationDirection(const ALay, ARow, ACol: integer; const Value: TInterpolationDirection); virtual; abstract;`
See CellInterpolationDirection.

	`procedure SetIsInterpolatedCell(const ALay, ARow, ACol: integer; const Value: boolean); virtual; abstract;`
See IsInterpolatedCell.

	`procedure CheckIfUniform; override;`

	`procedure Assign(Source: TPersistent); override;`
`Assign` copies data from Source to this `TCustomPhastDataSet`. If Source is a TCustomPhastDataSet or a TPhastInterpolationValues, PHAST-style interpolation data is copied from Source.

	`constructor Create(AnOwner: TComponent); override;`
`Create` creates an instance of `TCustomPhastDataSet`.

	`destructor Destroy; override;`
`Destroy` destroys the current instance of `TCustomPhastDataSet`. Do not call `Destroy` directly. Call Free instead.

procedure Initialize; override;

Initialize sets the values for all the cells in TCustomPhastDataSet.

Flow chart (part 1) illustrating how values are assigned to elements or cells.

Flow chart (part 2) illustrating how values are assigned to elements or cells.

	`procedure Invalidate; override;`
`Invalidate` calls TDataArray.Invalidate `Invalidate` and then specifies the MixtureUseList as being out of date.

	`procedure RefreshFormula; override;`

Properties

	`property MixtureUseList: TStringList read GetMixtureUseList;`
`MixtureUseList` holds a list of all the variables used by MixtureFormula.

	`property CellDistance1[constALay,ARow,ACol:integer]: double read GetCellDistance1 write SetCellDistance1;`
`CellDistance1` specifies the first PHAST-style interpolation distance for the cell at ALay, ARow, ACol.

	`property CellDistance2[constALay,ARow,ACol:integer]: double read GetCellDistance2 write SetCellDistance2;`
`CellDistance2` specifies the second PHAST-style interpolation distance for the cell at ALay, ARow, ACol.

	`property CellInterpolationDirection[constALay,ARow,ACol:integer]: TInterpolationDirection read GetCellInterpolationDirection write SetCellInterpolationDirection;`
`CellInterpolationDirection` specifies the TInterpolationDirection for PHAST-style interpolation distance for the cell at ALay, ARow, ACol.

	`property IsInterpolatedCell[constALay,ARow,ACol:integer]: boolean read GetIsInterpolatedCell write SetIsInterpolatedCell;`
`IsInterpolatedCell` specifies whether the cell at ALay, ARow, ACol uses PHAST-style interpolation.

	`property Distance1: double read GetDistance1 write SetDistance1;`
`Distance1` is the first distance used for PHAST-style interpolation when PHAST-style interpolation is applied to the entire data set.

	`property Distance2: double read GetDistance2 write SetDistance2;`
`Distance2` is the second distance used for PHAST-style interpolation when PHAST-style interpolation is applied to the entire data set.

	`property InterpolationDirection: TInterpolationDirection read FInterpolationDirection write SetInterpolationDirection;`
`InterpolationDirection` is the TInterpolationDirection used for PHAST-style interpolation when PHAST-style interpolation is applied to the entire data set.

	`property MixtureFormula: string read GetMixtureFormula write SetMixtureFormula;`
`MixtureFormula` is the formula used for PHAST-style interpolation when PHAST-style interpolation is applied to the entire data set and InterpolationDirection = pidMix.

	`property UsePHAST_InterpolationForAllCells: boolean read FUsePHAST_InterpolationForAllCells write SetUsePHAST_InterpolationForAllCells;`
`UsePHAST_InterpolationForAllCells` specifies whether PHAST-style interpolation should be applied to all cells.

Generated by PasDoc 0.12.1 on 2013-05-13 15:41:55