Class TTimeList

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastDataSets

Declaration

type TTimeList = class(TObject)

Description

TTimeList is used to manage boundary condition data that varies with time.

The Items property provides access to a series of TSparseArrayPhastDataSets that define how the data vary with time. Each represents the boundary condition data at a different time. The number of such TSparseArrayPhastDataSets is specified by the Count property. The Times property gives the time for each TSparseArrayPhastDataSet.

New data sets are added to TTimeList in TCustomPhastBoundaryCollection.GetDataSet

Hierarchy

Overview

Fields

Private FBoundaryType: TBoundaryTypes;
Private FBoundaryTypeDataSets: TBoundaryTypeList;
Private FData: TList;
Private FDataType: TRbwDataType;
Private FDirection: TDataSetOrientation;
Private FLimits: TColoringLimits;
Private FName: string;
Private FOrientation: TDataSetOrientation;
Private FTimes: TRealList;
Private FUpToDate: boolean;

Methods

Private function GetCount: integer;
Private function GetItems(const Index: integer): TSparseArrayPhastDataSet;
Private function GetTimes(const Index: integer): double;
Private function GetUpToDate: boolean;
Private procedure SetItems(const Index: integer; const Value: TSparseArrayPhastDataSet);
Private procedure SetLimits(const Value: TColoringLimits);
Private procedure SetName(const Value: string);
Private procedure SetOrientation(const Value: TDataSetOrientation);
Private procedure SetUpToDate(const Value: boolean);
Public function Add(const ATime: double; const Data: TSparseArrayPhastDataSet): integer;
Public procedure Changed(Sender: TObject);
Public procedure Clear;
Public constructor Create;
Public destructor Destroy; override;
Public function FirstTimeGreaterThan(const ATime: double): integer;
Public function IndexOf(const ATime: double): integer;
Public function IndexOfDataSet(const Data: TSparseArrayPhastDataSet): integer;
Public procedure Initialize;
Public procedure Invalidate;
Public procedure Loaded;
Public procedure UpDateLimits;

Properties

Public property BoundaryType: TBoundaryTypes read FBoundaryType write FBoundaryType;
Public property BoundaryTypeDataSets: TBoundaryTypeList read FBoundaryTypeDataSets;
Public property Count: integer read GetCount;
Public property DataType: TRbwDataType read FDataType write FDataType;
Public property Direction: TDataSetOrientation read FDirection write FDirection;
Public property Items[const Index: integer]: TSparseArrayPhastDataSet read GetItems write SetItems;
Public property Limits: TColoringLimits read FLimits write SetLimits;
Public property Name: string read FName write SetName;
Public property Orientation: TDataSetOrientation read FOrientation write SetOrientation;
Public property Times[const Index: integer]: double read GetTimes;
Public property UpToDate: boolean read GetUpToDate;

Description

Fields

Private FBoundaryType: TBoundaryTypes;

FBoundaryType: TBoundaryTypes; See BoundaryType.

Private FBoundaryTypeDataSets: TBoundaryTypeList;

FBoundaryTypeDataSets: TBoundaryTypeList; See BoundaryTypeDataSets.

Private FData: TList;

FData: TList; FData stores the TSparseArrayPhastDataSets. FData is instantiated as a TObjectList.

Private FDataType: TRbwDataType;

FDataType: TRbwDataType; See DataType.

Private FDirection: TDataSetOrientation;

FDirection: TDataSetOrientation; See Direction.

Private FLimits: TColoringLimits;

FLimits: TColoringLimits; See Limits.

Private FName: string;

FName: string; See Name.

Private FOrientation: TDataSetOrientation;

FOrientation: TDataSetOrientation; See Orientation.

Private FTimes: TRealList;

FTimes: TRealList; See Times.

Private FUpToDate: boolean;

FUpToDate: boolean; See UpToDate.

Methods

Private function GetCount: integer;

See Count.

Private function GetItems(const Index: integer): TSparseArrayPhastDataSet;

See Items.

Private function GetTimes(const Index: integer): double;

See Times.

Private function GetUpToDate: boolean;

See UpToDate.

Private procedure SetItems(const Index: integer; const Value: TSparseArrayPhastDataSet);

See Items.

Private procedure SetLimits(const Value: TColoringLimits);

See Limits.

Private procedure SetName(const Value: string);

See Name.

Private procedure SetOrientation(const Value: TDataSetOrientation);

See Orientation.

Private procedure SetUpToDate(const Value: boolean);

See UpToDate.

Public function Add(const ATime: double; const Data: TSparseArrayPhastDataSet): integer;

Add adds a TSparseArrayPhastDataSet and its associated time to the TTimeList.

Public procedure Changed(Sender: TObject);

Changed is an event handler. One place it is used is TCustomPhastBoundaryCondition. AddMixtureSubscriptions.

Public procedure Clear;

Clear removes all the TSparseArrayPhastDataSets from the TTimeList.

Public constructor Create;

Create creates an instance of TTimeList.

Public destructor Destroy; override;

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

Public function FirstTimeGreaterThan(const ATime: double): integer;

FirstTimeGreaterThan returns the position in Times of the first time that is greater than ATime.

Public function IndexOf(const ATime: double): integer;

IndexOf returns the position of ATime in Times.

Public function IndexOfDataSet(const Data: TSparseArrayPhastDataSet): integer;

IndexOfDataSet returns the position of Data in Items.

Public procedure Initialize;

Initialize initializes all the data sets related to the TTimeList.

Public procedure Invalidate;

Invalidate sets UpToDate to false;

Public procedure Loaded;

Loaded is called after the model is loaded. It updates subscriptions.

Public procedure UpDateLimits;

UpDateLimits applies Limits to each of the TSparseArrayPhastDataSet in TTimeList.

Properties

Public property BoundaryType: TBoundaryTypes read FBoundaryType write FBoundaryType;

BoundaryType specifies the type of boundary condition being specified by this TTimeList.

Public property BoundaryTypeDataSets: TBoundaryTypeList read FBoundaryTypeDataSets;

BoundaryTypeDataSets holds a series of TIntegerSparseDataSets that indicate the type of boundary condition that applies at each location.

Public property Count: integer read GetCount;

Count is the number of TSparseArrayPhastDataSets stored in the TTimeList.

Public property DataType: TRbwDataType read FDataType write FDataType;

DataType specifies the type of data stored in the TSparseArrayPhastDataSet.

Public property Direction: TDataSetOrientation read FDirection write FDirection;

Direction specifies the TDataSetOrientation of the TSparseArrayPhastDataSets in the TTimeList.

Public property Items[const Index: integer]: TSparseArrayPhastDataSet read GetItems write SetItems;

Items provides access to the TSparseArrayPhastDataSets stored in TTimeList.

Public property Limits: TColoringLimits read FLimits write SetLimits;

Limits represents the TColoringLimits to be applied to the data sets in TTimeList when the grid is colored by one of those data sets.

Public property Name: string read FName write SetName;

Name is the Name of the TTimeList.

Public property Orientation: TDataSetOrientation read FOrientation write SetOrientation;

Orientation is the TDataSetOrientation of the TSparseArrayPhastDataSets in the TTimeList.

Public property Times[const Index: integer]: double read GetTimes;

Times provides access to the time for each TSparseArrayPhastDataSet in Items.

Public property UpToDate: boolean read GetUpToDate;

UpToDate indicates whether all of the TSparseArrayPhastDataSets are up-to-date.

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