Class TCustomSparseDataSet

DescriptionHierarchyFieldsMethodsProperties

Unit

DataSetUnit

Declaration

type TCustomSparseDataSet = class(TDataArray)

Description

TCustomSparseDataSet is the abstract ancestor of classes that use descendants of T3DSparsePointerArray to store data.

These data sets won't necessarily have a value defined at all locations. Related data such as Annotation are affected too so those are stored in a T3DSparseStringArray. The Formula is not used; only TScreenObjects are used to assign values.

Hierarchy

Overview

Fields

Private FBoundaryTypeDataSet: TDataArray;
Private FAnnotation: T3DSparseStringArray;
Private FPriorLayer: Integer;
Private FPriorRow: Integer;
Private FPriorCol: Integer;
Private FPriorResult: Boolean;

Methods

Protected procedure Clear; override;
Protected function GetAnnotation(const Layer, Row, Col: integer): string; override;
Protected function GetIsValue(const Layer, Row, Col: Integer): boolean; override;
Protected procedure SetAnnotation(const Layer, Row, Col: integer; const Value: string); override;
Protected procedure SetDimensions(const SetToZero: boolean); override;
Protected procedure SetIsValue(const Layer, Row, Col: Integer; const Value: boolean); override;
Protected function IsSparseArray: boolean; override;
Public procedure Invalidate; override;
Public constructor Create(AnOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Initialize; override;

Properties

Public property BoundaryTypeDataSet: TDataArray read FBoundaryTypeDataSet write FBoundaryTypeDataSet;

Description

Fields

Private FBoundaryTypeDataSet: TDataArray;

See BoundaryTypeDataSet.

Private FAnnotation: T3DSparseStringArray;

FAnnotation is used to store the Annotation at each location.

Private FPriorLayer: Integer;
 
Private FPriorRow: Integer;
 
Private FPriorCol: Integer;
 
Private FPriorResult: Boolean;
 

Methods

Protected procedure Clear; override;
 
Protected function GetAnnotation(const Layer, Row, Col: integer): string; override;

See Annotation.

Protected function GetIsValue(const Layer, Row, Col: Integer): boolean; override;

GetIsValue checks whether Annotation has been assigned at Layer, Row, Col. If BoundaryTypeDataSet has been assigned, it checks it too.

Protected procedure SetAnnotation(const Layer, Row, Col: integer; const Value: string); override;

See Annotation.

Protected procedure SetDimensions(const SetToZero: boolean); override;

SetDimensions clears FAnnotation.

Protected procedure SetIsValue(const Layer, Row, Col: Integer; const Value: boolean); override;

If BoundaryTypeDataSet is assigned, SetIsValue sets BoundaryTypeDataSet.IsValue to true at Layer, Row, Col.

Protected function IsSparseArray: boolean; override;
 
Public procedure Invalidate; override;
 
Public constructor Create(AnOwner: TComponent); override;

Create creates an instance of TCustomSparseDataSet and sets EvaluatedAt to eaNodes.

Public destructor Destroy; override;

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

Public procedure Initialize; override;

Initialize assigns values to some location in RealData, IntegerData, BooleanData, or StringData in TCustomSparseDataSet. Unlike TDataArray It doesn't uses either Formula or TwoDInterpolator to assign values. It only assigns values using TScreenObjects.

Properties

Public property BoundaryTypeDataSet: TDataArray read FBoundaryTypeDataSet write FBoundaryTypeDataSet;

If this data set is used with a boundary condition and several boundary conditions are mutually exclusive. BoundaryTypeDataSet is used to check that the correct type of boundary condition is stored at a location when determining IsValue.

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