Unit DataSetUnit

DescriptionUsesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

The main purposes of DataSetUnit is to define TDataArray which provides an interface to a 3D array of data and TCustom2DInterpolater which provides an interface for 2D interpolation.

See also
PhastDataSets
PhastDataSets is used to define a series of classes that represent data sets in PHAST.
ModflowConstantHeadBoundaryUnit

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EInvalidDataType EInvalidDataType is raised if a formula is assigned that, when compiled gives a type of data that is incompatible with the type of data stored in the TDataArray.
Class EInterpolationException EInterpolationException is raised if an error occurs during interpolation.
Class ECircularReference ECircularReference is raised if, when assigning values to a data set, a circular reference is encountered so that the TDataArray depends on itself.
Class ECorruptedData  
Class TColoringLimit When the grid is colored by a TDataArray, the colors can be restricted to lie within a range. TColoringLimit is used to represent one end of the range. See TColoringLimits.
Class TSkipReal  
Class TCustomSkipCollection  
Class TSkipRealCollection  
Class TSkipInteger  
Class TSkipIntegerCollection  
Class TColoringLimits When the grid is colored by a TDataArray, the colors can be restricted to lie within a range. TColoringLimits is used to represent both ends of the range. See TColoringLimit.
Class TContours  
Class TDataArray TDataArray provides an interface to a 3D array of data.
Class TDataArrayList  
Class TTempDataArrayStorage  
Class TCustom2DInterpolater TCustom2DInterpolater provides an abstract interface for 2D interpolation. Descendants of TCustom2DInterpolater provide concrete implementations.

Call RegisterClass in the initialization section for any descendants that are instantiated.
Class TCustomSparseDataSet TCustomSparseDataSet is the abstract ancestor of classes that use descendants of T3DSparsePointerArray to store data.
Class TRealSparseDataSet TRealSparseDataSet is used to store real numbers in a sparse array.
Class TTransientRealSparseDataSet  
Class TIntegerSparseDataSet TIntegerSparseDataSet is used to store integers in a sparse array.
Class TTransientIntegerSparseDataSet  
Class TCustomTimeList TCustomTimeList is used to store a series of TDataArrays.

Functions and Procedures

procedure GlobalDataArrayRemoveSubscription(Sender: TObject; Subject: TObject; const AName: string);
procedure GlobalDataArrayRestoreSubscription(Sender: TObject; Subject: TObject; const AName: string);

Types

T3DRealDataSet = array of array of array of real;
T3DIntegerDataSet = array of array of array of integer;
T3DBooleanDataSet = array of array of array of boolean;
T3DStringDataSet = array of array of array of string;
TBoundaryType = (...);
TBoundaryTypes = set of TBoundaryType;
TContourAlg = (...);
TAngleType = (...);
TObjectUsedEvent = function(Sender: TObject): boolean of object;
TUseListFunction = function: TStringList of Object;
TIsUniform = (...);
TDataArrayType = class of TDataArray;
TInterpolatorType = class of TCustom2DInterpolater;
TInitializeDataSetInterpolator = procedure(Sender: TObject; const DataSet: TDataArray) of object;
TInterpolatorClass = class of TCustom2DInterpolater;
TOnGetUseList = procedure (Sender: TObject; NewUseList: TStringList) of object;

Constants

StrDataSets = 'Data Sets';
StrUserDefined = 'User Defined';
StrRequiredPart = '|Required|';
StrOptionalPart = '|Optional|';
StrCircularReferenceI = 'Circular reference in %s';
StrInvalidDataType = 'Invalid data type.';

Variables

Stack: TStringList = nil;
StrRequired: string;
StrOptional: string;
strDefaultClassification: string;

Description

Functions and Procedures

procedure GlobalDataArrayRemoveSubscription(Sender: TObject; Subject: TObject; const AName: string);
 
procedure GlobalDataArrayRestoreSubscription(Sender: TObject; Subject: TObject; const AName: string);
 

Types

T3DRealDataSet = array of array of array of real;

T3DRealDataSet is a 3D array of real numbers.

T3DIntegerDataSet = array of array of array of integer;

T3DIntegerDataSet is a 3D array of integers.

T3DBooleanDataSet = array of array of array of boolean;

T3DBooleanDataSet is a 3D array of booleans.

T3DStringDataSet = array of array of array of string;

T3DStringDataSet is a 3D array of strings.

TBoundaryType = (...);
 
Values
  • btUndefined:  
  • btPhastSpecifiedHead:  
  • btPhastFlux:  
  • btPhastLeaky:  
  • btPhastRiver:  
  • btPhastWell:  
  • btMfWell:  
  • btMfGhb:  
  • btMfDrn:  
  • btMfDrt:  
  • btMfRiv:  
  • btMfChd:  
  • btMfEts:  
  • btMfEt:  
  • btMfRch:  
  • btMfSfr:  
  • btMfUzf:  
  • btMfObs:  
  • btMfMnw:  
  • btMt3dSsm:  
  • btMfHfb:  
  • btSutraSpecifiedPressure:  
  • btSutraSpecifiedHead:  
  • btSutraSpecConcTemp:  
  • btSutraFluidFlux:  
  • btMassEnergyFlux:  
TBoundaryTypes = set of TBoundaryType;
 
TContourAlg = (...);
 
Values
  • caSimple:  
  • caACM626:  
TAngleType = (...);
 
Values
  • atNone:  
  • atDegrees:  
  • atRadians:  
TObjectUsedEvent = function(Sender: TObject): boolean of object;

TObjectUsedEvent is the type of the TDataArray.OnDataSetUsed event. TDataArray.OnDataSetUsed is called by TDataArray.UsedByModel

TUseListFunction = function: TStringList of Object;

TUseListFunction is used in ChangeAFormula where it is used to get the TObservers that will affect the TDataArray whose formula is being changed.

TIsUniform = (...);

TIsUniform is the data type of IsUniform.

Values
  • iuUnknown:  
  • iuFalse:  
  • iuTrue:  
TDataArrayType = class of TDataArray;

TDataArrayType is used in creating descendants of TDataArray of the correct type when reading the model from a stream. See TDataSetItem.DataSetClass.

TInterpolatorType = class of TCustom2DInterpolater;

TInterpolatorType is used in creating descendants of TCustom2DInterpolater of the correct type when reading a TDataArray from a stream. See TDataArray.TwoDInterpolatorClass.

TInitializeDataSetInterpolator = procedure(Sender: TObject; const DataSet: TDataArray) of object;

See TCustom2DInterpolater.OnInitialize and TCustom2DInterpolater.OnFinalize.

TInterpolatorClass = class of TCustom2DInterpolater;

TInterpolatorClass is used to create descendants of TCustom2DInterpolater when reading a TDataArray from a file.

TOnGetUseList = procedure (Sender: TObject; NewUseList: TStringList) of object;
 

Constants

StrDataSets = 'Data Sets';

StrDataSets is used in the classification of data sets.

StrUserDefined = 'User Defined';

StrUserDefined is used in the classification of data sets.

StrRequiredPart = '|Required|';
 
StrOptionalPart = '|Optional|';
 
StrCircularReferenceI = 'Circular reference in %s';
 
StrInvalidDataType = 'Invalid data type.';
 

Variables

Stack: TStringList = nil;

Stack Stack is used in Initialize to detect circular references. A ECircularReference is raised if one is found.

StrRequired: string;

StrRequired is used in the classification of data sets. StrRequired is set in the initialization section and subsequently should be treated as a constant.

StrOptional: string;

StrOptional is used in the classification of data sets. StrOptional is set in the initialization section and subsequently should be treated as a constant.

strDefaultClassification: string;

strDefaultClassification is used in the classification of data sets. strDefaultClassification is set in the initialization section and subsequently should be treated as a constant.

Author

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