Class TPhastInterpolationValues

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastDataSets

Declaration

type TPhastInterpolationValues = class(TPersistent)

Description

TPhastInterpolationValues is used to store data related to PHAST-style interpolation and also to PHAST-style mixtures.

In PHAST-style interpolation, the user specifies a coordinate direction (X, Y, or Z), two distances, and two values. If the X, Y, or Z coordinate of the current node is less than or equal to the first distance, the first value is used. If the X, Y, or Z coordinate of the current node is greater than or equal to the second distance, the second value is used. For intermediate distances, linear interpolation between the two values is used.

In PHAST-style mixtures, the user specifies two values and a series of proportions (between 0 and 1). The proportion represents the fraction of value 1 in the mixture. One minus the proportion represents the fraction of value 2 in the mixture. This is useful for chemical mixtures where Value 1 and Value 2 represent indices to two end member solutions. The fraction tells how much or each end member to include in the solution.

Hierarchy

Overview

Fields

Private FDataSet: TCustomPhastDataSet;
Private FDistance1: double;
Private FDistance2: double;
Private FInterpolationDirection: TInterpolationDirection;
Private FIntValue1: integer;
Private FIntValue2: integer;
Private FMixtureFormula: TFormulaObject;
Private FRealValue1: double;
Private FRealValue2: double;
Private FUsePHAST_Interpolation: boolean;

Methods

Private function GetDistance1: double;
Private function GetDistance2: double;
Private procedure SetDistance1(const Value: double);
Private procedure SetDistance2(const Value: double);
Private procedure SetInterpolationDirection( const Value: TInterpolationDirection);
Private procedure SetIntValue1(const Value: integer);
Private procedure SetIntValue2(const Value: integer);
Private procedure SetMixtureFormula(const Value: string);
Private procedure SetRealValue1(const Value: double);
Private procedure SetRealValue2(const Value: double);
Private procedure SetUsePHAST_Interpolation(const Value: boolean);
Private function GetMixtureFormula: string;
Public procedure Assign(Source: TPersistent); override;
Public procedure AssignTo(Dest: TPersistent); override;
Public constructor Create;
Public destructor Destroy; override;
Public function SameAs(Another: TPhastInterpolationValues): boolean;

Properties

Public property DataSet: TCustomPhastDataSet read FDataSet write FDataSet;
Published property Distance1: double read GetDistance1 write SetDistance1;
Published property Distance2: double read GetDistance2 write SetDistance2;
Published property InterpolationDirection: TInterpolationDirection read FInterpolationDirection write SetInterpolationDirection;
Published property IntValue1: integer read FIntValue1 write SetIntValue1;
Published property IntValue2: integer read FIntValue2 write SetIntValue2;
Published property MixtureExpression: string read GetMixtureFormula write SetMixtureFormula stored False;
Published property MixtureFormula: string read GetMixtureFormula write SetMixtureFormula;
Published property RealValue1: double read FRealValue1 write SetRealValue1;
Published property RealValue2: double read FRealValue2 write SetRealValue2;
Published property UsePHAST_Interpolation: boolean read FUsePHAST_Interpolation write SetUsePHAST_Interpolation;

Description

Fields

Private FDataSet: TCustomPhastDataSet;

See DataSet.

Private FDistance1: double;

See Distance1.

Private FDistance2: double;

See Distance2.

Private FInterpolationDirection: TInterpolationDirection;

See InterpolationDirection.

Private FIntValue1: integer;

See IntValue1.

Private FIntValue2: integer;

See IntValue2.

Private FMixtureFormula: TFormulaObject;

See MixtureFormula.

Private FRealValue1: double;

See RealValue1.

Private FRealValue2: double;

See RealValue2.

Private FUsePHAST_Interpolation: boolean;

See UsePHAST_Interpolation.

Methods

Private function GetDistance1: double;
 
Private function GetDistance2: double;

See Distance2.

Private procedure SetDistance1(const Value: double);

See Distance1.

Private procedure SetDistance2(const Value: double);

See Distance2.

Private procedure SetInterpolationDirection( const Value: TInterpolationDirection);

See InterpolationDirection.

Private procedure SetIntValue1(const Value: integer);

See IntValue1.

Private procedure SetIntValue2(const Value: integer);

See IntValue2.

Private procedure SetMixtureFormula(const Value: string);

See MixtureFormula.

Private procedure SetRealValue1(const Value: double);

See RealValue1.

Private procedure SetRealValue2(const Value: double);

See RealValue2.

Private procedure SetUsePHAST_Interpolation(const Value: boolean);

See UsePHAST_Interpolation.

Private function GetMixtureFormula: string;
 
Public procedure Assign(Source: TPersistent); override;

Use Assign to assign the properties of a TCustomPhastDataSet, TCustomPhastBoundaryCondition, or TPhastInterpolationValues to the current TPhastInterpolationValues.

Public procedure AssignTo(Dest: TPersistent); override;
 
Public constructor Create;
 
Public destructor Destroy; override;
 
Public function SameAs(Another: TPhastInterpolationValues): boolean;

SameAs returns True if Another is identical with the TPhastInterpolationValues being called.

Properties

Public property DataSet: TCustomPhastDataSet read FDataSet write FDataSet;

DataSet is the data set to which the TPhastInterpolationValues is to be applied.

Published property Distance1: double read GetDistance1 write SetDistance1;

Distance1 is the first distance used for "PHAST-style interpolation. It is not used if InterpolationDirection = pidMix.

Published property Distance2: double read GetDistance2 write SetDistance2;

Distance2 is the second distance used for PHAST-style interpolation. It is not used if InterpolationDirection = pidMix.

Published property InterpolationDirection: TInterpolationDirection read FInterpolationDirection write SetInterpolationDirection;

InterpolationDirection determines whether PHAST-style interpolation is used or PHAST-style mixtures. If PHAST-style interpolation is used, it also determines the coordinate direction.

Published property IntValue1: integer read FIntValue1 write SetIntValue1;

If DataSet stores integers, IntValue1 stores the first integer value for PHAST-style interpolation.

Published property IntValue2: integer read FIntValue2 write SetIntValue2;

If DataSet stores integers, IntValue2 stores the second integer value for PHAST-style interpolation.

Published property MixtureExpression: string read GetMixtureFormula write SetMixtureFormula stored False;

MixtureExpression is identical to MixtureFormula. It is only maintained for backwards compatibility.

Published property MixtureFormula: string read GetMixtureFormula write SetMixtureFormula;

MixtureFormula is the expression used to determine the fraction for "PHAST" style mixtures. It is only used if InterpolationDirection = pidMix.

Published property RealValue1: double read FRealValue1 write SetRealValue1;

If DataSet stores real numbers, RealValue1 stores the first real number value for PHAST-style interpolation.

Published property RealValue2: double read FRealValue2 write SetRealValue2;

If DataSet stores real numbers, RealValue2 stores the second real number value for PHAST-style interpolation. See TPhastInterpolationValues.

Published property UsePHAST_Interpolation: boolean read FUsePHAST_Interpolation write SetUsePHAST_Interpolation;

UsePHAST_Interpolation specifies whether PHAST-style interpolation should be used. (For purposes of programming, PHAST-style mixtures are considered to be PHAST-Interpolation.) See TPhastInterpolationValues.

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