Class TCustomPhastBoundaryCondition

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastScreenObjectUnit

Declaration

type TCustomPhastBoundaryCondition = class(TInterpValuesItem)

Description

TCustomPhastBoundaryCondition is and abstract base class. Its descendants, TIntegerPhastBoundaryCondition and TRealPhastBoundaryCondition, are used to define the value of one aspect of a boundary condition for one time period.

Hierarchy

Overview

Fields

Private FExpression: string;
Private FMixtureDataSetList: TList;
Private FMixtureFormula: string;
Private FMixtureObserver: TObserver;
Private FTime: double;

Methods

Private procedure AddMixtureSubscriptions;
Private function GetDistance1: double;
Private function GetDistance2: double;
Private function GetInterpolationDirection: TInterpolationDirection;
Private function GetMixtureExpression: string;
Private function GetScreenObject: TPhastScreenObject;
Private function GetUsePHAST_Interpolation: boolean;
Private procedure RemoveMixtureSubscriptions;
Private procedure SetDistance1(const Value: double);
Private procedure SetDistance2(const Value: double);
Private procedure SetExpression(const Value: string);
Private procedure SetInterpolationDirection(const Value: TInterpolationDirection);
Private procedure SetMixtureExpression(const Value: string);
Private procedure SetMixtureFormula(const Value: string);
Private procedure SetTime(const Value: double);
Private procedure SetUsePHAST_Interpolation(const Value: boolean);
Protected function GetDatatype: TRbwDataType; virtual; abstract;
Protected procedure ResetMixtureSubscription;
Protected procedure UpdateMixtureExpression;
Public procedure Assign(Source: TPersistent); override;
Public constructor Create(Collection: TCollection); override;
Public destructor Destroy; override;
Public function GetDataSet: TSparseArrayPhastDataSet;

Properties

Public property MixtureExpression: string read GetMixtureExpression write SetMixtureExpression;
Public property ScreenObject: TPhastScreenObject read GetScreenObject;
Published property DataType: TRbwDataType read GetDatatype;
Published property Distance1: double read GetDistance1 write SetDistance1;
Published property Distance2: double read GetDistance2 write SetDistance2;
Published property Expression: string read FExpression write SetExpression;
Published property InterpolationDirection: TInterpolationDirection read GetInterpolationDirection write SetInterpolationDirection;
Published property MixtureFormula: string read GetMixtureExpression write SetMixtureFormula;
Published property Time: double read FTime write SetTime;
Published property UsePHAST_Interpolation: boolean read GetUsePHAST_Interpolation write SetUsePHAST_Interpolation;

Description

Fields

Private FExpression: string;

FExpression: string; See Expression.

Private FMixtureDataSetList: TList;

FMixtureDataSetList: TList; FMixtureDataSetList is a list of the TDataArrays that are directly used in MixtureFormula.

Private FMixtureFormula: string;

FMixtureFormula: string; See MixtureFormula.

Private FMixtureObserver: TObserver;

FMixtureObserver: TObserver; FMixtureObserver is used to monitor changes to the TDataArrays that are used in MixtureFormula.

Private FTime: double;

FTime: double; See Time.

Methods

Private procedure AddMixtureSubscriptions;

AddMixtureSubscriptions determines the TDataArrays that are used in MixtureFormula and has FMixtureObserver subscribe to each of them.

Private function GetDistance1: double;

See Distance1.

Private function GetDistance2: double;

See Distance2.

Private function GetInterpolationDirection: TInterpolationDirection;

See InterpolationDirection.

Private function GetMixtureExpression: string;

See MixtureExpression.

Private function GetScreenObject: TPhastScreenObject;

See ScreenObject.

Private function GetUsePHAST_Interpolation: boolean;

See UsePHAST_Interpolation.

Private procedure RemoveMixtureSubscriptions;

RemoveMixtureSubscriptions causes FMixtureObserver to unsubscribe from every TDataArray that it is observing.

Private procedure SetDistance1(const Value: double);

See Distance1.

Private procedure SetDistance2(const Value: double);

See Distance2.

Private procedure SetExpression(const Value: string);

See Expression.

Private procedure SetInterpolationDirection(const Value: TInterpolationDirection);

See InterpolationDirection.

Private procedure SetMixtureExpression(const Value: string);

See MixtureExpression.

Private procedure SetMixtureFormula(const Value: string);

See MixtureFormula.

Private procedure SetTime(const Value: double);

See Time.

Private procedure SetUsePHAST_Interpolation(const Value: boolean);

See UsePHAST_Interpolation.

Protected function GetDatatype: TRbwDataType; virtual; abstract;

See DataType.

Protected procedure ResetMixtureSubscription;

ResetMixtureSubscription sets FMixtureObserver.UpToDate := True;

Protected procedure UpdateMixtureExpression;

UpdateMixtureExpression transfers the value stored in FMixtureFormula to MixtureExpression. See MixtureFormula.

Public procedure Assign(Source: TPersistent); override;

Assign copies values from TCustomPhastBoundaryCondition or TInterpValuesItem to the object calling Assign.

Public constructor Create(Collection: TCollection); override;

Create creates an instance of TCustomPhastBoundaryCondition.

Public destructor Destroy; override;

Destroy destroys the current instance of TCustomPhastBoundaryCondition.

Public function GetDataSet: TSparseArrayPhastDataSet;

GetDataSet gets the TSparseArrayPhastDataSet to which this TCustomPhastBoundaryCondition applies.

Properties

Public property MixtureExpression: string read GetMixtureExpression write SetMixtureExpression;

See TInterpValuesItem.Values.MixtureFormula. Mixture Expression can not be set until the entire model has been loaded. See MixtureFormula. See TPhastInterpolationValues.

Public property ScreenObject: TPhastScreenObject read GetScreenObject;

ScreenObject is used to read the TPhastScreenObject to which this TCustomPhastBoundaryCondition applies.

Published property DataType: TRbwDataType read GetDatatype;

DataType specifies the type of data (real number, integer, boolean, or string) stored in the TCustomPhastBoundaryCondition. However, at the time this was written only real numbers and integers were supported because those were the only types supported in descendants of TSparseArrayPhastDataSet. See GetDataSet.

Published property Distance1: double read GetDistance1 write SetDistance1;

See TInterpValuesItem.Values.Distance1. See TPhastInterpolationValues.

Published property Distance2: double read GetDistance2 write SetDistance2;

See TInterpValuesItem.Values.Distance2. See TPhastInterpolationValues.

Published property Expression: string read FExpression write SetExpression;

Expression is the formula used to set the value of the TCustomPhastBoundaryCondition when PHAST style interpolation is not used (that is: UsePHAST_Interpolation = False). See TPhastInterpolationValues.

Published property InterpolationDirection: TInterpolationDirection read GetInterpolationDirection write SetInterpolationDirection;

See TInterpValuesItem.Values.InterpolationDirection.

Published property MixtureFormula: string read GetMixtureExpression write SetMixtureFormula;

See TInterpValuesItem.Values.MixtureFormula. MixtureFormula is used to read and write MixtureExpression. After the model is loaded, UpdateMixtureExpression is called to transfer the value saved in FMixtureFormula to MixtureExpression. See TPhastInterpolationValues.

Published property Time: double read FTime write SetTime;

Time is the time at which this TCustomPhastBoundaryCondition takes effect.

Published property UsePHAST_Interpolation: boolean read GetUsePHAST_Interpolation write SetUsePHAST_Interpolation;

UsePHAST_Interpolation indicates whether or not PHAST-style interpolation will be used. See TPhastInterpolationValues.

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