Class TCustomTimeList

DescriptionHierarchyFieldsMethodsProperties

Unit

DataSetUnit

Declaration

type TCustomTimeList = class(TObject)

Description

TCustomTimeList is used to store a series of TDataArrays. Each is associated with a specific time.

Hierarchy

Overview

Fields

Private FModel: TBaseModel;
Private FData: TList;
Private FTimes: TRealList;
Private FDirection: TDataSetOrientation;
Private FLimits: TColoringLimits;
Private FName: string;
Private FOrientation: TDataSetOrientation;
Private FUpToDate: boolean;
Private FClassification: string;
Private FCheckMax: boolean;
Private FMax: double;
Private FCheckMin: boolean;
Private FMin: double;
Private FDataType: TRbwDataType;
Private FOnTimeListUsed: TObjectUsedEvent;

Methods

Private function GetCount: integer;
Private function GetItems(const Index: integer): TDataArray;
Private function GetTimes(const Index: integer): double;
Private procedure SetItems(const Index: integer; const Value: TDataArray);
Private procedure SetLimits(const Value: TColoringLimits);
Private procedure SetName(const Value: string);
Private procedure SetOrientation(const Value: TDataSetOrientation);
Private procedure SetClassification(const Value: string);
Private function GetClassification: string;
Private procedure SetCheckMax(const Value: boolean);
Private procedure SetCheckMin(const Value: boolean);
Private procedure SetMax(const Value: double);
Private procedure SetMin(const Value: double);
Private function GetBoundaryType: TBoundaryType;
Protected function GetUpToDate: boolean; virtual;
Protected procedure SetUpToDate(const Value: boolean); virtual;
Protected procedure CheckSameModel(const Data: TDataArray); virtual;
Public function UsedByModel: boolean;
Public function Add(const ATime: double; const Data: TDataArray): integer;
Public procedure Clear; virtual;
Public constructor Create(AModel: TBaseModel);
Public destructor Destroy; override;
Public function FirstTimeGreaterThan(const ATime: double): integer;
Public function IndexOf(const ATime: double): integer;
Public function IndexOfDataSet(const Data: TDataArray): integer;
Public procedure Initialize; virtual; abstract;
Public procedure Invalidate; virtual;
Public procedure Changed(Sender: TObject);
Public procedure FreeItem(Index: integer);
Public procedure UpDateLimits;
Public function MaxValue(Time: double): string;
Public function MinValue(Time: double): string;

Properties

Protected property Model: TBaseModel read FModel;
Public property OnTimeListUsed: TObjectUsedEvent read FOnTimeListUsed write FOnTimeListUsed;
Public property Count: integer read GetCount;
Public property Name: string read FName write SetName;
Public property Times[constIndex:integer]: double read GetTimes;
Public property UpToDate: boolean read GetUpToDate;
Public property Orientation: TDataSetOrientation read FOrientation write SetOrientation;
Public property Items[constIndex:integer]: TDataArray read GetItems write SetItems;
Public property Limits: TColoringLimits read FLimits write SetLimits;
Public property Direction: TDataSetOrientation read FDirection write FDirection;
Public property Classification: string read GetClassification write SetClassification;
Public property BoundaryType: TBoundaryType read GetBoundaryType;
Public property Max: double read FMax write SetMax;
Public property Min: double read FMin write SetMin;
Public property CheckMax: boolean read FCheckMax write SetCheckMax;
Public property CheckMin: boolean read FCheckMin write SetCheckMin;
Public property DataType: TRbwDataType read FDataType write FDataType;

Description

Fields

Private FModel: TBaseModel;

FModel is either nil or a TCustomModel.

Private FData: TList;

FData stores the TDataArrays. FData is instantiated as a TObjectList.

Private FTimes: TRealList;

See Times.

Private FDirection: TDataSetOrientation;

See Direction.

Private FLimits: TColoringLimits;

See Limits.

Private FName: string;

See Name.

Private FOrientation: TDataSetOrientation;

See Orientation.

Private FUpToDate: boolean;

See UpToDate.

Private FClassification: string;

See Classification.

Private FCheckMax: boolean;

See CheckMax.

Private FMax: double;

See Max.

Private FCheckMin: boolean;

See CheckMin.

Private FMin: double;

See Min.

Private FDataType: TRbwDataType;

See DataType.

Private FOnTimeListUsed: TObjectUsedEvent;

See OnTimeListUsed.

Methods

Private function GetCount: integer;

See Count.

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

See Items.

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

See Times.

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

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 SetClassification(const Value: string);

See Classification.

Private function GetClassification: string;

See Classification.

Private procedure SetCheckMax(const Value: boolean);

See CheckMax.

Private procedure SetCheckMin(const Value: boolean);

See CheckMin.

Private procedure SetMax(const Value: double);

See Max.

Private procedure SetMin(const Value: double);

See Min.

Private function GetBoundaryType: TBoundaryType;
 
Protected function GetUpToDate: boolean; virtual;

See UpToDate.

Protected procedure SetUpToDate(const Value: boolean); virtual;

See UpToDate.

Protected procedure CheckSameModel(const Data: TDataArray); virtual;

CheckSameModel checks that there is not a conflict between the Model and Model.

Public function UsedByModel: boolean;

If OnTimeListUsed is assigned, UsedByModel calls OnTimeListUsed and returns its result. Otherwise UsedByModel returns True.

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

Add adds a TDataArray and its associated time to the TCustomTimeList.

Public procedure Clear; virtual;

Clear removes all the TDataArrays from the TCustomTimeList.

Public constructor Create(AModel: TBaseModel);

Create creates an instance of TCustomTimeList.

Public destructor Destroy; override;

Destroy destroys the current instance of TCustomTimeList. 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: TDataArray): integer;

IndexOfDataSet returns the position of Data in Items.

Public procedure Initialize; virtual; abstract;

Initialize assigns values to all the TDataArrays in TCustomTimeList.

Public procedure Invalidate; virtual;

Invalidate sets UpToDate to false;

Public procedure Changed(Sender: TObject);

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

Public procedure FreeItem(Index: integer);

FreeItem sets the item at Index to nil. Because FData is a TObjectList, this also destroys the item at Index.

Public procedure UpDateLimits;

UpDateLimits applies Limits to each of the TSparseArrayPhastInterpolationDataSet in TCustomTimeList.

Public function MaxValue(Time: double): string;

MaxValue is a string representation of the maximum value of the TDataArray ast Time.

Public function MinValue(Time: double): string;

MinValue is a string representation of the minimum value of the TDataArray ast Time.

Properties

Protected property Model: TBaseModel read FModel;
 
Public property OnTimeListUsed: TObjectUsedEvent read FOnTimeListUsed write FOnTimeListUsed;

OnTimeListUsed is used to indicate whether or not a particular TCustomTimeList is used by the model. See UsedByModel.

Public property Count: integer read GetCount;

Count is the number of TDataArrays stored in the TCustomTimeList.

Public property Name: string read FName write SetName;

Name is the Name of the TCustomTimeList.

Public property Times[constIndex:integer]: double read GetTimes;

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

Public property UpToDate: boolean read GetUpToDate;

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

Public property Orientation: TDataSetOrientation read FOrientation write SetOrientation;

Orientation is the TDataSetOrientation of the TSparseArrayPhastInterpolationDataSets in the TCustomTimeList.

Public property Items[constIndex:integer]: TDataArray read GetItems write SetItems;

Items provides access to the TDataArrays stored in TCustomTimeList.

Public property Limits: TColoringLimits read FLimits write SetLimits;

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

Public property Direction: TDataSetOrientation read FDirection write FDirection;

Direction specifies the TDataSetOrientation of the TSparseArrayPhastInterpolationDataSets in the TCustomTimeList.

Public property Classification: string read GetClassification write SetClassification;

Classification is used as as suggestion to a GUI on how to select a particular // TCustomTimeList from a hierarchical list of TCustomTimeList's

Public property BoundaryType: TBoundaryType read GetBoundaryType;
 
Public property Max: double read FMax write SetMax;

Max is used to set the Max property of any TDataArrays stored in TCustomTimeList

Public property Min: double read FMin write SetMin;

Min is used to set the Min property of any TDataArrays stored in TCustomTimeList

Public property CheckMax: boolean read FCheckMax write SetCheckMax;

CheckMax is used to set the CheckMax property of any TDataArrays stored in TCustomTimeList

Public property CheckMin: boolean read FCheckMin write SetCheckMin;

CheckMin is used to set the CheckMin property of any TDataArrays stored in TCustomTimeList

Public property DataType: TRbwDataType read FDataType write FDataType;

DataType specifies the type of data stored in the TDataArrays stored in TCustomTimeList.

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