Class TSparseIntegerPhastDataSet

Description

Hierarchy

Fields

Methods

Properties

Unit

PhastDataSets

Declaration

type TSparseIntegerPhastDataSet = class(TSparseArrayPhastInterpolationDataSet)

Description

TSparseIntegerPhastDataSet is a sparse data set that stores integers. It is used mainly for boundary conditions.

See TSparseArrayPhastInterpolationDataSet.

Hierarchy

Overview

Fields

	`FCellValue1: T3DSparseIntegerArray;`
	`FCellValue2: T3DSparseIntegerArray;`
	`FFraction: T3DSparseRealArray;`
	`FIntegerValues: T3DSparseIntegerArray;`
	`FValue1: integer;`
	`FValue2: integer;`

Methods

	`function GetCellValue1(const ALay, ARow, ACol: integer): integer;`
	`function GetCellValue2(const ALay, ARow, ACol: integer): integer;`
	`function GetFraction(const ALay, ARow, ACol: integer): double;`
	`function GetRealValue(const ALay, ARow, ACol: integer): double;`
	`procedure SetCellValue1(const ALay, ARow, ACol, Value: integer);`
	`procedure SetCellValue2(const ALay, ARow, ACol, Value: integer);`
	`procedure SetFraction(const ALay, ARow, ACol: integer; const Value: double);`
	`procedure SetValue1(const Value: integer);`
	`procedure SetValue2(const Value: integer);`
	`procedure ReadData(DecompressionStream: TDecompressionStream); override;`
	`procedure StoreData(Stream: TStream); override;`
	`function GetIntegerData(const Layer, Row, Col: integer): integer; override;`
	`function GetIsValue(const Index1, Index2, Index3: Integer): boolean; override;`
	`function GetRealData(const Layer, Row, Col: integer): double; override;`
	`procedure SetDataType(const Value: TRbwDataType); override;`
	`procedure SetDimensions(const SetToZero: boolean); override;`
	`procedure SetIntegerData(const Layer, Row, Col, Value: integer); override;`
	`procedure Assign(Source: TPersistent); override;`
	`constructor Create(AnOwner: TComponent); override;`
	`destructor Destroy; override;`
	`function DisplayRealValue: boolean; override;`

Properties

	`property CellValue1[constALay,ARow,ACol:integer]: integer read GetCellValue1 write SetCellValue1;`
	`property CellValue2[constALay,ARow,ACol:integer]: integer read GetCellValue2 write SetCellValue2;`
	`property Fraction[constALay,ARow,ACol:integer]: double read GetFraction write SetFraction;`
	`property RealValue[constALay,ARow,ACol:integer]: double read GetRealValue;`
	`property Value1: integer read FValue1 write SetValue1;`
	`property Value2: integer read FValue2 write SetValue2;`

Description

Fields

	`FCellValue1: T3DSparseIntegerArray;`
`FCellValue1`: T3DSparseIntegerArray; See CellValue1.

	`FCellValue2: T3DSparseIntegerArray;`
`FCellValue2`: T3DSparseIntegerArray; See CellValue2.

	`FFraction: T3DSparseRealArray;`
`FFraction`: T3DSparseRealArray; See Fraction.

	`FIntegerValues: T3DSparseIntegerArray;`
`FIntegerValues`: T3DSparseIntegerArray; `FIntegerValues` stores the values assigned to cells or elements when PHAST-style interpolation is not used.

	`FValue1: integer;`
`FValue1`: integer; See Value1.

	`FValue2: integer;`
`FValue2`: integer; See Value2.

Methods

	`function GetCellValue1(const ALay, ARow, ACol: integer): integer;`
See CellValue1.

	`function GetCellValue2(const ALay, ARow, ACol: integer): integer;`
See CellValue2.

	`function GetFraction(const ALay, ARow, ACol: integer): double;`
See Fraction.

	`function GetRealValue(const ALay, ARow, ACol: integer): double;`
`GetRealValue` is a representation of the data as a real number.

	`procedure SetCellValue1(const ALay, ARow, ACol, Value: integer);`
See CellValue1.

	`procedure SetCellValue2(const ALay, ARow, ACol, Value: integer);`
See CellValue2.

	`procedure SetFraction(const ALay, ARow, ACol: integer; const Value: double);`
See Fraction.

	`procedure SetValue1(const Value: integer);`
See Value1.

	`procedure SetValue2(const Value: integer);`
See Value2.

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

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

	`function GetIntegerData(const Layer, Row, Col: integer): integer; override;`
See IntegerData.

	`function GetIsValue(const Index1, Index2, Index3: Integer): boolean; override;`
See TCustomPhastDataSet.IsValue.

	`function GetRealData(const Layer, Row, Col: integer): double; override;`
`GetRealData` represents the data as a real number.

	`procedure SetDataType(const Value: TRbwDataType); override;`
`SetDataType` checks that the TRbwDataType represents an integer.

	`procedure SetDimensions(const SetToZero: boolean); override;`
`SetDimensions` clears the sparse arrays used to store data.

	`procedure SetIntegerData(const Layer, Row, Col, Value: integer); override;`
See IntegerData.

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

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

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

	`function DisplayRealValue: boolean; override;`
`DisplayRealValue` returns true.

Properties

	`property CellValue1[constALay,ARow,ACol:integer]: integer read GetCellValue1 write SetCellValue1;`
`CellValue1` represents the first value used for PHAST-style interpolation at each location in the data set.

	`property CellValue2[constALay,ARow,ACol:integer]: integer read GetCellValue2 write SetCellValue2;`
`CellValue2` represents the second value used for PHAST-style interpolation at each location in the data set.

	`property Fraction[constALay,ARow,ACol:integer]: double read GetFraction write SetFraction;`
`Fraction` represents the fraction of CellValue1 to be applied at ALay, ARow, ACol.

	`property RealValue[constALay,ARow,ACol:integer]: double read GetRealValue;`
`RealValue` represents the data as a real number.

	`property Value1: integer read FValue1 write SetValue1;`
`Value1` represents the global value of the first value used for PHAST-style interpolation. `Value1` is the default first value assigned to TScreenObjects when PHAST-style interpolation is first activated.

	`property Value2: integer read FValue2 write SetValue2;`
`Value2` represents the global value of the second value used for PHAST-style interpolation. `Value2` is the default second value assigned to TScreenObjects when PHAST-style interpolation is first activated.

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