Class TCustomModflowGridEdgeFeature

DescriptionHierarchyFieldsMethodsProperties

Unit

EdgeDisplayUnit

Declaration

type TCustomModflowGridEdgeFeature = class(TObject)

Description

TCustomModflowGridEdgeFeature is a base class used in the display of model properties that are on the edges between model cells. Currently, the Horizontal Flow Barrier package is the only example of this supported in ModelMuse. .

See also
TBarrier

Hierarchy

Overview

Fields

Protected FCol1: integer;
Protected FCol2: integer;
Protected FRow1: integer;
Protected FRow2: integer;
Protected FLayer: integer;
Protected FModel: TBaseModel;

Methods

Protected function GetRealAnnotation(Index: integer): string; virtual; abstract;
Protected function GetRealValue(Index: integer): double; virtual; abstract;
Protected function StartPoint: TPoint;
Protected function EndPoint: TPoint;
Public constructor Create(AModel: TBaseModel);
Public function Select(Const X, Y, ALayer: integer): boolean;
Public function EndingLocation: TPoint2D;
Public function StartingLocation: TPoint2D;

Properties

Public property Col1: integer Read FCol1;
Public property Col2: integer Read FCol2;
Public property Row1: integer Read FRow1;
Public property Row2: integer Read FRow2;
Public property Layer: integer Read FLayer;
Public property RealValue[Index:integer]: double read GetRealValue;
Public property RealAnnotation[Index:integer]: string read GetRealAnnotation;

Description

Fields

Protected FCol1: integer;

See Col1.

Protected FCol2: integer;

See Col2.

Protected FRow1: integer;

See Row1.

Protected FRow2: integer;

See Row2.

Protected FLayer: integer;

See Layer.

Protected FModel: TBaseModel;
 

Methods

Protected function GetRealAnnotation(Index: integer): string; virtual; abstract;

See RealAnnotation.

Protected function GetRealValue(Index: integer): double; virtual; abstract;

See RealValue.

Protected function StartPoint: TPoint;

StartPoint is the starting point of the TCustomModflowGridEdgeFeature in screen coordinates.

Protected function EndPoint: TPoint;

EndPoint is the ending point of the TCustomModflowGridEdgeFeature in screen coordinates.

Public constructor Create(AModel: TBaseModel);
 
Public function Select(Const X, Y, ALayer: integer): boolean;

Select returns true if ALayer equals Layer and the point defined by X and Y is sufficiently close to the TCustomModflowGridEdgeFeature.

Public function EndingLocation: TPoint2D;

EndingLocation returns the ending location of the TCustomModflowGridEdgeFeature in real-world coordinates.

Public function StartingLocation: TPoint2D;

StartingLocation returns the starting location of the TCustomModflowGridEdgeFeature in real-world coordinates.

Properties

Public property Col1: integer Read FCol1;

Col1 is the number of the first column defining the location of TCustomModflowGridEdgeFeature.

Public property Col2: integer Read FCol2;

Col2 is the number of the second column defining the location of TCustomModflowGridEdgeFeature.

Public property Row1: integer Read FRow1;

Row1 is the number of the first row defining the location of TCustomModflowGridEdgeFeature.

Public property Row2: integer Read FRow2;

Row2 is the number of the second row defining the location of TCustomModflowGridEdgeFeature.

Public property Layer: integer Read FLayer;

Layer is the number of the layer defining the location of TCustomModflowGridEdgeFeature.

Public property RealValue[Index:integer]: double read GetRealValue;

RealValue returns a real number. Index is used to determine which value to return.

Public property RealAnnotation[Index:integer]: string read GetRealAnnotation;

RealAnnotation returns a description of how RealValue[Index] was assigned. Index is used to determine which value to return.

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