Class TModflowParameters

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TModflowParameters = class(TEnhancedOrderedCollection)

Description

TModflowParameters stores a series of MODFLOW boundaries associated with a series of MODFLOW parameters.

See also
TModflowParamItem
Each TModflowParamItem stores a TCustomMF_BoundColl.

Hierarchy

Overview

Fields

Private FScreenObject: TObject;
Private FBoundary: TModflowParamBoundary;

Methods

Private function GetItem(Index: Integer): TModflowParamItem;
Private procedure SetItem(Index: Integer; const Value: TModflowParamItem);
Public procedure EvaluateArrayBoundaries(AModel: TBaseModel);
Public procedure EvaluateListBoundaries(AModel: TBaseModel);
Public function Add: TModflowParamItem;
Public constructor Create(Boundary: TModflowParamBoundary; ItemClass: TModflowParamItemClass; Model: TBaseModel; ScreenObject: TObject); virtual;
Public function GetParamByName(const AName: string): TModflowParamItem;
Public function Insert(Index: Integer): TModflowParamItem;
Public function IndexOfParam(AParam: TModflowTransientListParameter): integer;
Public function Used: boolean;
Public function DataSetUsed(DataArray: TDataArray; AModel: TBaseModel): boolean; virtual;

Properties

Public property Items[Index:Integer]: TModflowParamItem read GetItem write SetItem;
Public property ScreenObject: TObject read FScreenObject;

Description

Fields

Private FScreenObject: TObject;

See ScreenObject.

Private FBoundary: TModflowParamBoundary;

FBoundary is the TModflowBoundary that owns TModflowParameters.

Methods

Private function GetItem(Index: Integer): TModflowParamItem;

See Items.

Private procedure SetItem(Index: Integer; const Value: TModflowParamItem);

See Items.

Public procedure EvaluateArrayBoundaries(AModel: TBaseModel);

EvaluateArrayBoundaries calls TCustomMF_ArrayBoundColl.EvaluateArrayBoundaries for each Items[Index].Param.

Public procedure EvaluateListBoundaries(AModel: TBaseModel);
 
Public function Add: TModflowParamItem;

Add adds as new descendant of TModflowParamItem;

Public constructor Create(Boundary: TModflowParamBoundary; ItemClass: TModflowParamItemClass; Model: TBaseModel; ScreenObject: TObject); virtual;

Create creates an instance of TModflowParameters.

Public function GetParamByName(const AName: string): TModflowParamItem;

GetParamByName returns the TModflowParamItem whose TModflowParamItem.Param.ParamName matches AName.

Public function Insert(Index: Integer): TModflowParamItem;

Insert inserts a new TModflowParamItem at the position specified by Index.

Public function IndexOfParam(AParam: TModflowTransientListParameter): integer;

IndexOfParam returns the position of the TModflowParamItem associated with the TModflowTransientListParameter. It is used in TModflowParamBoundary.DeleteParam.

Public function Used: boolean;

Used returns True if any TModflowParamItem in Items returns True.

Public function DataSetUsed(DataArray: TDataArray; AModel: TBaseModel): boolean; virtual;
 

Properties

Public property Items[Index:Integer]: TModflowParamItem read GetItem write SetItem;

Items provides access to the TModflowParamItems stored by this TModflowParameters

Public property ScreenObject: TObject read FScreenObject;

ScreenObject is Nil or the TScreenObject that owns this TModflowParameters.


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