Class TRiverBoundary

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastScreenObjectUnit

Declaration

type TRiverBoundary = class(TCustomPhastBoundary)

Description

TRiverBoundary represents a river boundary in PHAST for one TPhastScreenObject.

Hierarchy

Overview

Fields

Private FAssociatedSolution: TIntegerPhastBoundaries;
Private FBedHydraulicConductivity: string;
Private FBedThickness: string;
Private FDepth: string;
Private FDescription: string;
Private FHead: TRealPhastBoundaries;
Private FWidth: string;

Methods

Private procedure SetAssociatedSolution(const Value: TIntegerPhastBoundaries);
Private procedure SetBedHydraulicConductivity(const Value: string);
Private procedure SetBedThickness(const Value: string);
Private procedure SetDepth(const Value: string);
Private procedure SetDescription(const Value: string);
Private procedure SetHead(const Value: TRealPhastBoundaries);
Private procedure SetWidth(const Value: string);
Protected procedure SetScreenObject(const Value: TPhastScreenObject); override;
Protected procedure UpdateMixtureExpression; override;
Public procedure Assign(Source: TPersistent); override;
Public procedure Clear; override;
Public constructor Create;
Public destructor Destroy; override;
Public function IsBoundary: boolean;
Public procedure PartialAssign(Source: TPersistent);

Properties

Published property AssociatedSolution: TIntegerPhastBoundaries read FAssociatedSolution write SetAssociatedSolution;
Published property BedHydraulicConductivity: string read FBedHydraulicConductivity write SetBedHydraulicConductivity;
Published property BedThickness: string read FBedThickness write SetBedThickness;
Published property Depth: string read FDepth write SetDepth;
Published property Description: string read FDescription write SetDescription;
Published property Head: TRealPhastBoundaries read FHead write SetHead;
Published property Width: string read FWidth write SetWidth;

Description

Fields

Private FAssociatedSolution: TIntegerPhastBoundaries;

FAssociatedSolution: TIntegerPhastBoundaries; See AssociatedSolution.

Private FBedHydraulicConductivity: string;

FBedHydraulicConductivity: string; See BedHydraulicConductivity.

Private FBedThickness: string;

FBedThickness: string; See BedThickness.

Private FDepth: string;

FDepth: string; See Depth.

Private FDescription: string;

FDescription: string; See Description.

Private FHead: TRealPhastBoundaries;

FHead: TRealPhastBoundaries; See Head.

Private FWidth: string;

FWidth: string; See Width.

Methods

Private procedure SetAssociatedSolution(const Value: TIntegerPhastBoundaries);

See AssociatedSolution.

Private procedure SetBedHydraulicConductivity(const Value: string);

See BedHydraulicConductivity.

Private procedure SetBedThickness(const Value: string);

See BedThickness.

Private procedure SetDepth(const Value: string);

See Depth.

Private procedure SetDescription(const Value: string);

See Description.

Private procedure SetHead(const Value: TRealPhastBoundaries);

See Head.

Private procedure SetWidth(const Value: string);

See Width.

Protected procedure SetScreenObject(const Value: TPhastScreenObject); override;

See ScreenObject.

Protected procedure UpdateMixtureExpression; override;

UpdateMixtureExpression calls AssociatedSolution.UpdateMixtureExpression and Head.UpdateMixtureExpression.

Public procedure Assign(Source: TPersistent); override;

If Source is a TRiverBoundary, Assign copies AssociatedSolution, BedHydraulicConductivity, BedThickness, Depth, Description, Head, and Width.

Public procedure Clear; override;

Clear clears AssociatedSolution and Head.

Public constructor Create;

Create creates an instance of TRiverBoundary.

Public destructor Destroy; override;

Destroy destroys the current instance of TRiverBoundary. Do not call Destroy directly. Call Free instead.

Public function IsBoundary: boolean;

IsBoundary returns true if all the published properties have been set to values that indicate that a river boundary is present.

Public procedure PartialAssign(Source: TPersistent);

If Source is a TRiverBoundary, PartialAssign copies AssociatedSolution, and Head but not BedHydraulicConductivity, BedThickness, Depth, Description, and Width. PartialAssign is used in TUndoSetPhastScreenObjectProperties.

Properties

Published property AssociatedSolution: TIntegerPhastBoundaries read FAssociatedSolution write SetAssociatedSolution;

AssociatedSolution defines how the associated solution for this TRiverBoundary varies through time for its ScreenObject.

Published property BedHydraulicConductivity: string read FBedHydraulicConductivity write SetBedHydraulicConductivity;

BedHydraulicConductivity is the formula for specifying the river bed hydraulic conductivity for this ScreenObject.

Published property BedThickness: string read FBedThickness write SetBedThickness;

BedThickness is the formula for specifying the river bed thickness for this ScreenObject.

Published property Depth: string read FDepth write SetDepth;

Depth is the formula for specifying the river depth for this ScreenObject.

Published property Description: string read FDescription write SetDescription;

Description is the description of the river for this ScreenObject.

Published property Head: TRealPhastBoundaries read FHead write SetHead;

Head defines how the head for this TRiverBoundary varies through time for its ScreenObject.

Published property Width: string read FWidth write SetWidth;

Width is the formula for specifying the river width for this ScreenObject.

Generated by PasDoc 0.10.0 on 2006-10-31 09:56:42