Class TCustomModflowGridEdgeDisplay

DescriptionHierarchyFieldsMethodsProperties

Unit

EdgeDisplayUnit

Declaration

type TCustomModflowGridEdgeDisplay = class(TObserver)

Description

TCustomModflowGridEdgeDisplay stores but does not own a list of TCustomModflowGridEdgeFeatures. It is used to display the TCustomModflowGridEdgeFeatures.

Hierarchy

Overview

Fields

Private FList: TList;
Private FLimits: TList;
Private FDataToPlot: integer;
Private FOnNeedToUpdate: TNotifyEvent;
Private FMaxValue: string;
Private FMinValue: string;
Private FUpdatingMinMax: Boolean;
Private FModel: TBaseModel;

Methods

Private function GetRealAnnotation(X, Y, ALayer: integer): string;
Private function GetRealValue(X, Y, ALayer: integer): double;
Private function GetLimits(Index: integer): TColoringLimits;
Private procedure SetLimits(Index: integer; const Value: TColoringLimits);
Private procedure SetDataToPlot(const Value: integer);
Private function GetCount: integer;
Private function GetEdge(Index: integer): TCustomModflowGridEdgeFeature;
Private function GetMaxValue: string;
Private function GetMinValue: string;
Private procedure GetMinimumAndMaximumValues(out MinValue, MaxValue, MinPositive: Double);
Protected function GetDescription(DataIndex: integer): string; virtual; abstract;
Protected function GetRealValueTypeCount: integer; virtual; abstract;
Public function UseEdge(ActiveDataArray: TDataArray; Feature: TCustomModflowGridEdgeFeature): boolean;
Public procedure GetValueRangeToDisplay(out MinValue, MaxValue, MinPositive: Double);
Public constructor Create(AnOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Clear;
Public procedure Add(EdgeFeature: TCustomModflowGridEdgeFeature);
Public Procedure Draw(Layer: integer; Const Bitmap32: TBitmap32);
Public function Select(Const X, Y, Layer: integer): boolean;
Public procedure Invalidate; virtual;
Public procedure UpdateData;
Public procedure UpdateMinMax;

Properties

Public property Limits[Index:integer]: TColoringLimits read GetLimits write SetLimits;
Public property RealValue[X,Y,ALayer:integer]: double read GetRealValue;
Public property RealAnnotation[X,Y,ALayer:integer]: string read GetRealAnnotation;
Public property RealDescription[DataIndex:integer]: string read GetDescription;
Public property RealValueTypeCount: integer read GetRealValueTypeCount;
Public property DataToPlot: integer read FDataToPlot write SetDataToPlot;
Public property OnNeedToUpdate: TNotifyEvent read FOnNeedToUpdate write FOnNeedToUpdate;
Public property Count: integer read GetCount;
Public property Edges[Index:integer]: TCustomModflowGridEdgeFeature read GetEdge;
Public property MinValue: string read GetMinValue;
Public property MaxValue: string read GetMaxValue;

Description

Fields

Private FList: TList;

FList holds the TCustomModflowGridEdgeFeatures.

Private FLimits: TList;

FLimits holds a TColoringLimits for each type of data that can be displayed.

Private FDataToPlot: integer;

See DataToPlot.

Private FOnNeedToUpdate: TNotifyEvent;

See OnNeedToUpdate.

Private FMaxValue: string;

See MaxValue.

Private FMinValue: string;

See MinValue.

Private FUpdatingMinMax: Boolean;

FUpdatingMinMax is set to True in UpdateMinMax to prevent recursion.

Private FModel: TBaseModel;
 

Methods

Private function GetRealAnnotation(X, Y, ALayer: integer): string;

See RealAnnotation.

Private function GetRealValue(X, Y, ALayer: integer): double;

See RealValue.

Private function GetLimits(Index: integer): TColoringLimits;

See Limits.

Private procedure SetLimits(Index: integer; const Value: TColoringLimits);

See Limits.

Private procedure SetDataToPlot(const Value: integer);

See DataToPlot.

Private function GetCount: integer;

See Count.

Private function GetEdge(Index: integer): TCustomModflowGridEdgeFeature;

See Edges.

Private function GetMaxValue: string;

See MaxValue.

Private function GetMinValue: string;

See MinValue.

Private procedure GetMinimumAndMaximumValues(out MinValue, MaxValue, MinPositive: Double);

GetMinimumAndMaximumValues sets MinValue, MaxValue to the minimum and maximum value of the data indicated by DataToPlot.

Protected function GetDescription(DataIndex: integer): string; virtual; abstract;

See RealDescription.

Protected function GetRealValueTypeCount: integer; virtual; abstract;

See RealValueTypeCount.

Public function UseEdge(ActiveDataArray: TDataArray; Feature: TCustomModflowGridEdgeFeature): boolean;
 
Public procedure GetValueRangeToDisplay(out MinValue, MaxValue, MinPositive: Double);

GetValueRangeToDisplay returns the minimum and maximum value allowed when drawing the TCustomModflowGridEdgeFeatures.

Public constructor Create(AnOwner: TComponent); override;
 
Public destructor Destroy; override;
 
Public procedure Clear;

remove all the TCustomModflowGridEdgeFeatures from FList.

Public procedure Add(EdgeFeature: TCustomModflowGridEdgeFeature);

add a TCustomModflowGridEdgeFeatures to FList.

Public Procedure Draw(Layer: integer; Const Bitmap32: TBitmap32);

Draw draws the TCustomModflowGridEdgeFeatures that are on Layer on Bitmap32.

Public function Select(Const X, Y, Layer: integer): boolean;

Select returns True if any of the TCustomModflowGridEdgeFeatures would be selected by the values X, Y and Layer. See Select.

Public procedure Invalidate; virtual;

Invalidate sets UpToDate to False.

Public procedure UpdateData;

UpdateData will update the data if OnNeedToUpdate is assigned.

Public procedure UpdateMinMax;

UpdateMinMax updates MinValue and MaxValue

Properties

Public property Limits[Index:integer]: TColoringLimits read GetLimits write SetLimits;

Limits indicates the range of values that can be displayed in the data indicated by DataToPlot.

Public property RealValue[X,Y,ALayer:integer]: double read GetRealValue;

RealValue is the value at X, Y, and ALayer.

Public property RealAnnotation[X,Y,ALayer:integer]: string read GetRealAnnotation;

RealAnnotation returns the explanation of how RealValue was assigned.

Public property RealDescription[DataIndex:integer]: string read GetDescription;

RealDescription returns a description suitable for display in a GUI of the data indicated by DataIndex.

Public property RealValueTypeCount: integer read GetRealValueTypeCount;

RealValueTypeCount is the number of different types of data that can be displayed by the TCustomModflowGridEdgeDisplay.

Public property DataToPlot: integer read FDataToPlot write SetDataToPlot;

DataToPlot is used to indicate which RealValue to plot.

Public property OnNeedToUpdate: TNotifyEvent read FOnNeedToUpdate write FOnNeedToUpdate;

OnNeedToUpdate is used to update the data.

Public property Count: integer read GetCount;

Count is the number of TCustomModflowGridEdgeFeatures in TCustomModflowGridEdgeDisplay.

Public property Edges[Index:integer]: TCustomModflowGridEdgeFeature read GetEdge;

Edges is used to read the TCustomModflowGridEdgeFeatures in TCustomModflowGridEdgeDisplay.

Public property MinValue: string read GetMinValue;

MinValue is a string representation of the minimum value among the TCustomModflowGridEdgeFeatures for DataToPlot.

Public property MaxValue: string read GetMaxValue;

MaxValue is a string representation of the maximum value among the TCustomModflowGridEdgeFeatures for DataToPlot.

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