Class TDataArrayManager

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastModelUnit

Declaration

type TDataArrayManager = class(TObject)

Description

Hierarchy

Overview

Fields

Private FCustomModel: TCustomModel;
Private FDataSets: TObjectList;
Private FDataSetsToCache: TList;
Private FBoundaryDataSets: TObjectList;
Private FDataSetLookUpList: THashTableFacade;
Private FRiverDataSets: TList;
Private FStoreCachedData: boolean;
Private FDeletedDataSets: TList;
Private FDispersivityIndex: Integer;
Private FPorosityIndex: Integer;
Public FDataArrayCreationRecords: array of TDataSetCreationData;

Methods

Private function GetDataSetCount: integer;
Private function GetDataSet(const Index: integer): TDataArray;
Private function GetBoundaryDataSetCount: integer;
Private function GetBoundaryDataSets(const Index: integer): TDataArray;
Private function IndexOfDataSetInList(DataSetName: string; const List: TObjectList): integer;
Private function GetDataSetsCapacity: integer;
Private procedure SetDataSetsCapacity(const Value: integer);
Private procedure Invalidate;
Private procedure DefinePackageDataArrays;
Private procedure InvalidateDataSetLookupList;
Private function DataArrayHeld(DataArray: TDataArray): boolean;
Private function GetChildDataArrayManager(Index: integer): TDataArrayManager;
Private function GetChildDataArrayManagerCount: integer;
Private function LocalCount: integer;
Private function AddDataSet(const DataSet: TDataArray): Integer;
Private procedure UpdateDataSetDimensions;
Public procedure Assign(Source: TDataArrayManager);
Public procedure AddDataSetToLookUpList(const DataSet: TDataArray);
Public Constructor Create(Model: TCustomModel);
Public Destructor Destroy; override;
Public procedure ClearDataSetsToCache;
Public procedure ClearAllDataSets;
Public procedure AddDataSetToCache(DataArray: TDataArray);
Public procedure DontCache(DataArray: TDataArray);
Public procedure CacheDataArrays;
Public function CreateNewDataArray(const ClassType: TDataArrayType; const Name, Formula, DisplayName: string; Lock: TDataLock; DataType: TRbwDataType; EvaluatedAt: TEvaluatedAt; Orientation: TDataSetOrientation; const Classification: string): TDataArray;
Public function GetDataSetByName(const DataSetName: string): TDataArray;
Public procedure CreateInitialDataSets;
Public procedure RemoveDataSetFromLookUpList(const DataSet: TDataArray);
Public function AddBoundaryDataSet(const DataSet: TDataArray): Integer;
Public procedure CreateInitialBoundaryDataSets;
Public procedure ExtractDataSet(const DataSet: TDataArray);
Public function IndexOfDataSet(DataSetName: string): integer;
Public function IndexOfBoundaryDataSet(DataSetName: string): integer;
Public procedure InvalidateAllDataSets;
Public procedure InvalidateAll3DDataSets;
Public procedure ClearDeletedDataSets;
Public procedure UnlinkDeletedDataSets;
Public procedure HandleAddedDataArrays(AddedDataSetList: TList);
Public procedure HandleDeletedDataArrays(DeletedDataSetList: TList);
Public procedure UpdateClassifications;

Properties

Public property RiverDataSets: TList read FRiverDataSets;
Public property StoreCachedData: boolean read FStoreCachedData write FStoreCachedData;
Public property DataSetCount: integer read GetDataSetCount;
Public property DataSets[constIndex:integer]: TDataArray read GetDataSet;
Public property BoundaryDataSetCount: integer read GetBoundaryDataSetCount;
Public property BoundaryDataSets[constIndex:integer]: TDataArray read GetBoundaryDataSets;
Public property DataSetsCapacity: integer read GetDataSetsCapacity write SetDataSetsCapacity;
Public property ChildDataArrayManagerCount: integer read GetChildDataArrayManagerCount;
Public property ChildDataArrayManagers[Index:integer]: TDataArrayManager read GetChildDataArrayManager;

Description

Fields

Private FCustomModel: TCustomModel;
 
Private FDataSets: TObjectList;

FDataSets is used to store the TDataArrays in the model that are defined throughout the grid. An example is the data set for the hydraulic conductivity in the X direction.

Private FDataSetsToCache: TList;
 
Private FBoundaryDataSets: TObjectList;

FBoundaryDataSets is used to store TDataArrays that are related to boundary conditions but which do not vary with time.

Private FDataSetLookUpList: THashTableFacade;
 
Private FRiverDataSets: TList;
 
Private FStoreCachedData: boolean;
 
Private FDeletedDataSets: TList;

FDeletedDataSets is used to store TDataArrays that have been deleted so that they can be restored later.

Private FDispersivityIndex: Integer;
 
Private FPorosityIndex: Integer;
 
Public FDataArrayCreationRecords: array of TDataSetCreationData;
 

Methods

Private function GetDataSetCount: integer;

See DataSetCount.

Private function GetDataSet(const Index: integer): TDataArray;

See DataSets.

Private function GetBoundaryDataSetCount: integer;

See BoundaryDataSetCount.

Private function GetBoundaryDataSets(const Index: integer): TDataArray;

See BoundaryDataSets.

Private function IndexOfDataSetInList(DataSetName: string; const List: TObjectList): integer;

IndexOfDataSetInList returns the position of the TDataArray whose name is DataSetName in List. IndexOfDataSetInList is used in IndexOfBoundaryDataSet and IndexOfDataSet.

Private function GetDataSetsCapacity: integer;
 
Private procedure SetDataSetsCapacity(const Value: integer);
 
Private procedure Invalidate;
 
Private procedure DefinePackageDataArrays;
 
Private procedure InvalidateDataSetLookupList;
 
Private function DataArrayHeld(DataArray: TDataArray): boolean;
 
Private function GetChildDataArrayManager(Index: integer): TDataArrayManager;
 
Private function GetChildDataArrayManagerCount: integer;
 
Private function LocalCount: integer;
 
Private function AddDataSet(const DataSet: TDataArray): Integer;

AddDataSet adds DataSet to FDataSets and calls AddDataSetToLookUpList;

Private procedure UpdateDataSetDimensions;
 
Public procedure Assign(Source: TDataArrayManager);
 
Public procedure AddDataSetToLookUpList(const DataSet: TDataArray);
 
Public Constructor Create(Model: TCustomModel);
 
Public Destructor Destroy; override;
 
Public procedure ClearDataSetsToCache;
 
Public procedure ClearAllDataSets;
 
Public procedure AddDataSetToCache(DataArray: TDataArray);
 
Public procedure DontCache(DataArray: TDataArray);
 
Public procedure CacheDataArrays;
 
Public function CreateNewDataArray(const ClassType: TDataArrayType; const Name, Formula, DisplayName: string; Lock: TDataLock; DataType: TRbwDataType; EvaluatedAt: TEvaluatedAt; Orientation: TDataSetOrientation; const Classification: string): TDataArray;

CreateNewDataArray creates a new TDataArray and adds it to DataSets.

Public function GetDataSetByName(const DataSetName: string): TDataArray;

GetDataSetByName retrieves a TDataArray from DataSets based on its name.

Public procedure CreateInitialDataSets;
 
Public procedure RemoveDataSetFromLookUpList(const DataSet: TDataArray);
 
Public function AddBoundaryDataSet(const DataSet: TDataArray): Integer;

AddBoundaryDataSet creates non-transient TDataArrays for boundary conditions. AddBoundaryDataSet is used to store DataSet in FBoundaryDataSets.

Public procedure CreateInitialBoundaryDataSets;

CreateInitialBoundaryDataSets creates non-transient TDataArrays for boundary conditions.

Public procedure ExtractDataSet(const DataSet: TDataArray);

ExtractDataSet removes DataSet from DataSets without freeing it.

Public function IndexOfDataSet(DataSetName: string): integer;

IndexOfDataSet returns the position of the TDataArray in DataSets whose Name is DataSetName. If none has that name, IndexOfDataSet returns -1.

Public function IndexOfBoundaryDataSet(DataSetName: string): integer;

IndexOfBoundaryDataSet returns the position of the TDataArray in BoundaryDataSets whose Name is DataSetName. If none has that name, IndexOfBoundaryDataSet returns -1.

Public procedure InvalidateAllDataSets;
 
Public procedure InvalidateAll3DDataSets;
 
Public procedure ClearDeletedDataSets;
 
Public procedure UnlinkDeletedDataSets;
 
Public procedure HandleAddedDataArrays(AddedDataSetList: TList);
 
Public procedure HandleDeletedDataArrays(DeletedDataSetList: TList);
 
Public procedure UpdateClassifications;
 

Properties

Public property RiverDataSets: TList read FRiverDataSets;

RiverDataSets holds all the TDataArrays that are related to the river boundary but which are not transient.

Public property StoreCachedData: boolean read FStoreCachedData write FStoreCachedData;
 
Public property DataSetCount: integer read GetDataSetCount;

DataSetCount indicates the number of TDataArrays in DataSetCount.

Public property DataSets[constIndex:integer]: TDataArray read GetDataSet;

DataSets is used to access the TDataArrays that are defined throughout the grid.

Public property BoundaryDataSetCount: integer read GetBoundaryDataSetCount;

BoundaryDataSetCount is used to determine the number of TDataArrays in BoundaryDataSets. Only data sets that don't vary with time yet are related to boundary conditions are in BoundaryDataSets.

Public property BoundaryDataSets[constIndex:integer]: TDataArray read GetBoundaryDataSets;

BoundaryDataSets is used to access TDataArrays in FBoundaryDataSets. Only data sets that don't vary with time yet are related to boundary conditions are in FBoundaryDataSets.

Public property DataSetsCapacity: integer read GetDataSetsCapacity write SetDataSetsCapacity;
 
Public property ChildDataArrayManagerCount: integer read GetChildDataArrayManagerCount;
 
Public property ChildDataArrayManagers[Index:integer]: TDataArrayManager read GetChildDataArrayManager;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:56