Class TSutraTimeSchedule

DescriptionHierarchyFieldsMethodsProperties

Unit

SutraTimeScheduleUnit

Declaration

type TSutraTimeSchedule = class(TGoPhastPersistent)

Description

no description available, TGoPhastPersistent description follows

Hierarchy

Overview

Fields

Private FName: AnsiString;
Private FScheduleType: TScheduleType;
Private FInitialTimeStep: integer;
Private FIncrementUpdateCount: integer;
Private FMaxTimeCycle: integer;
Private FTimeMultiplierStored: TRealStorage;
Private FTimes: TRealCollection;
Private FLimitingTimeStep: integer;
Private FMaxIncrementStored: TRealStorage;
Private FInitialTimeStored: TRealStorage;
Private FSteps: TIntegerCollection;
Private FTimeStepIncrement: integer;
Private FMaxSteps: integer;
Private FInitialTimeIncrementStored: TRealStorage;
Private FLimitingTimeStored: TRealStorage;
Private FMinIncrementStored: TRealStorage;
Private FScaleFactorStored: TRealStorage;
Private FSutraTimeChoice: TSutraTimeChoice;

Methods

Private procedure SetIncrementUpdateCount(const Value: integer);
Private procedure SetInitialTime(const Value: double);
Private procedure SetInitialTimeIncrement(const Value: double);
Private procedure SetInitialTimeIncrementStored(const Value: TRealStorage);
Private procedure SetInitialTimeStep(const Value: integer);
Private procedure SetInitialTimeStored(const Value: TRealStorage);
Private procedure SetLimitingTime(const Value: double);
Private procedure SetLimitingTimeStep(const Value: integer);
Private procedure SetLimitingTimeStored(const Value: TRealStorage);
Private procedure SetMaxIncrement(const Value: double);
Private procedure SetMaxIncrementStored(const Value: TRealStorage);
Private procedure SetMaxSteps(const Value: integer);
Private procedure SetMaxTimeCycle(const Value: integer);
Private procedure SetMinIncrement(const Value: double);
Private procedure SetMinIncrementStored(const Value: TRealStorage);
Private procedure SetName(Value: AnsiString);
Private procedure SetScaleFactor(const Value: double);
Private procedure SetScaleFactorStored(const Value: TRealStorage);
Private procedure SetScheduleType(const Value: TScheduleType);
Private procedure SetSteps(const Value: TIntegerCollection);
Private procedure SetTimeMultiplier(const Value: double);
Private procedure SetTimeMultiplierStored(const Value: TRealStorage);
Private procedure SetTimes(const Value: TRealCollection);
Private procedure SetTimeStepIncrement(const Value: integer);
Private function GetInitialTime: double;
Private function GetInitialTimeIncrement: double;
Private function GetLimitingTime: double;
Private function GetMaxIncrement: double;
Private function GetMinIncrement: double;
Private function GetScaleFactor: double;
Private function GetTimeMultiplier: double;
Private procedure ValueChanged(Sender: TObject);
Private procedure SetSutraTimeChoice(const Value: TSutraTimeChoice);
Private procedure Initialize(Index: integer); overload;
Private procedure Initialize; overload;
Public procedure Assign(Source: TPersistent); override;
Public constructor Create(Model: TBaseModel);
Public destructor Destroy; override;
Public function TimeValues(InitialTime: double; AllSchedules: TSutraTimeSchedules) : TOneDRealArray;

Properties

Public property ScaleFactor: double read GetScaleFactor write SetScaleFactor;
Public property InitialTime: double read GetInitialTime write SetInitialTime;
Public property LimitingTime: double read GetLimitingTime write SetLimitingTime;
Public property InitialTimeIncrement: double read GetInitialTimeIncrement write SetInitialTimeIncrement;
Public property TimeMultiplier: double read GetTimeMultiplier write SetTimeMultiplier;
Public property MinIncrement: double read GetMinIncrement write SetMinIncrement;
Public property MaxIncrement: double read GetMaxIncrement write SetMaxIncrement;
Published property Name: AnsiString read FName write SetName;
Published property ScheduleType: TScheduleType read FScheduleType write SetScheduleType;
Published property ScaleFactorStored: TRealStorage read FScaleFactorStored write SetScaleFactorStored;
Published property SutraTimeChoice: TSutraTimeChoice read FSutraTimeChoice write SetSutraTimeChoice;
Published property Times: TRealCollection read FTimes write SetTimes;
Published property MaxTimeCycle: integer read FMaxTimeCycle write SetMaxTimeCycle;
Published property InitialTimeStored: TRealStorage read FInitialTimeStored write SetInitialTimeStored;
Published property LimitingTimeStored: TRealStorage read FLimitingTimeStored write SetLimitingTimeStored;
Published property InitialTimeIncrementStored: TRealStorage read FInitialTimeIncrementStored write SetInitialTimeIncrementStored;
Published property IncrementUpdateCount: integer read FIncrementUpdateCount write SetIncrementUpdateCount;
Published property TimeMultiplierStored: TRealStorage read FTimeMultiplierStored write SetTimeMultiplierStored;
Published property MinIncrementStored: TRealStorage read FMinIncrementStored write SetMinIncrementStored;
Published property MaxIncrementStored: TRealStorage read FMaxIncrementStored write SetMaxIncrementStored;
Published property Steps: TIntegerCollection read FSteps write SetSteps;
Published property MaxSteps: integer read FMaxSteps write SetMaxSteps;
Published property InitialTimeStep: integer read FInitialTimeStep write SetInitialTimeStep;
Published property LimitingTimeStep: integer read FLimitingTimeStep write SetLimitingTimeStep;
Published property TimeStepIncrement: integer read FTimeStepIncrement write SetTimeStepIncrement;

Description

Fields

Private FName: AnsiString;
 
Private FScheduleType: TScheduleType;
 
Private FInitialTimeStep: integer;
 
Private FIncrementUpdateCount: integer;
 
Private FMaxTimeCycle: integer;
 
Private FTimeMultiplierStored: TRealStorage;
 
Private FTimes: TRealCollection;
 
Private FLimitingTimeStep: integer;
 
Private FMaxIncrementStored: TRealStorage;
 
Private FInitialTimeStored: TRealStorage;
 
Private FSteps: TIntegerCollection;
 
Private FTimeStepIncrement: integer;
 
Private FMaxSteps: integer;
 
Private FInitialTimeIncrementStored: TRealStorage;
 
Private FLimitingTimeStored: TRealStorage;
 
Private FMinIncrementStored: TRealStorage;
 
Private FScaleFactorStored: TRealStorage;
 
Private FSutraTimeChoice: TSutraTimeChoice;
 

Methods

Private procedure SetIncrementUpdateCount(const Value: integer);
 
Private procedure SetInitialTime(const Value: double);
 
Private procedure SetInitialTimeIncrement(const Value: double);
 
Private procedure SetInitialTimeIncrementStored(const Value: TRealStorage);
 
Private procedure SetInitialTimeStep(const Value: integer);
 
Private procedure SetInitialTimeStored(const Value: TRealStorage);
 
Private procedure SetLimitingTime(const Value: double);
 
Private procedure SetLimitingTimeStep(const Value: integer);
 
Private procedure SetLimitingTimeStored(const Value: TRealStorage);
 
Private procedure SetMaxIncrement(const Value: double);
 
Private procedure SetMaxIncrementStored(const Value: TRealStorage);
 
Private procedure SetMaxSteps(const Value: integer);
 
Private procedure SetMaxTimeCycle(const Value: integer);
 
Private procedure SetMinIncrement(const Value: double);
 
Private procedure SetMinIncrementStored(const Value: TRealStorage);
 
Private procedure SetName(Value: AnsiString);
 
Private procedure SetScaleFactor(const Value: double);
 
Private procedure SetScaleFactorStored(const Value: TRealStorage);
 
Private procedure SetScheduleType(const Value: TScheduleType);
 
Private procedure SetSteps(const Value: TIntegerCollection);
 
Private procedure SetTimeMultiplier(const Value: double);
 
Private procedure SetTimeMultiplierStored(const Value: TRealStorage);
 
Private procedure SetTimes(const Value: TRealCollection);
 
Private procedure SetTimeStepIncrement(const Value: integer);
 
Private function GetInitialTime: double;
 
Private function GetInitialTimeIncrement: double;
 
Private function GetLimitingTime: double;
 
Private function GetMaxIncrement: double;
 
Private function GetMinIncrement: double;
 
Private function GetScaleFactor: double;
 
Private function GetTimeMultiplier: double;
 
Private procedure ValueChanged(Sender: TObject);
 
Private procedure SetSutraTimeChoice(const Value: TSutraTimeChoice);
 
Private procedure Initialize(Index: integer); overload;
 
Private procedure Initialize; overload;
 
Public procedure Assign(Source: TPersistent); override;
 
Public constructor Create(Model: TBaseModel);
 
Public destructor Destroy; override;
 
Public function TimeValues(InitialTime: double; AllSchedules: TSutraTimeSchedules) : TOneDRealArray;
 

Properties

Public property ScaleFactor: double read GetScaleFactor write SetScaleFactor;

SCALT Scale factor to be applied to each time value in the list.

Public property InitialTime: double read GetInitialTime write SetInitialTime;

TIMEI

Public property LimitingTime: double read GetLimitingTime write SetLimitingTime;

TIMEL

Public property InitialTimeIncrement: double read GetInitialTimeIncrement write SetInitialTimeIncrement;

TIMEC

Public property TimeMultiplier: double read GetTimeMultiplier write SetTimeMultiplier;

TCMULT

Public property MinIncrement: double read GetMinIncrement write SetMinIncrement;

TCMIN

Public property MaxIncrement: double read GetMaxIncrement write SetMaxIncrement;

TCMAX

Published property Name: AnsiString read FName write SetName;

SCHNAM - maximum 10 characters, spaces are allowed.

Published property ScheduleType: TScheduleType read FScheduleType write SetScheduleType;

SCHTYP

Published property ScaleFactorStored: TRealStorage read FScaleFactorStored write SetScaleFactorStored;

For Time List and Time Cycle schedules SCALT Scale factor to be applied to each time value in the list.

Published property SutraTimeChoice: TSutraTimeChoice read FSutraTimeChoice write SetSutraTimeChoice;

CREFT

Published property Times: TRealCollection read FTimes write SetTimes;

For Time List schedules TLIST The list of times. (May be continued over multiple lines of input.)

Published property MaxTimeCycle: integer read FMaxTimeCycle write SetMaxTimeCycle;

For Time Cycle schedules NTMAX Maximum number of time cycles allowed, i.e., the maximum number of times allowed in the schedule, not including the initial time.

Published property InitialTimeStored: TRealStorage read FInitialTimeStored write SetInitialTimeStored;

TIMEI Initial time. Cycling begins at time = TIMEI.

Published property LimitingTimeStored: TRealStorage read FLimitingTimeStored write SetLimitingTimeStored;

TIMEL Limiting time. Cycling continues until time >= TIMEL.

Published property InitialTimeIncrementStored: TRealStorage read FInitialTimeIncrementStored write SetInitialTimeIncrementStored;

TIMEC Initial time increment.

Published property IncrementUpdateCount: integer read FIncrementUpdateCount write SetIncrementUpdateCount;

NTCYC - minimum value = 1. Number of cycles after which the time increment is updated. The current time increment is multiplied by TCMULT (see below) after every NTCYC cycles. (The value of the time increment is limited by TCMIN and TCMAX; see below.)

Published property TimeMultiplierStored: TRealStorage read FTimeMultiplierStored write SetTimeMultiplierStored;

TCMULT Factor by which the time increment is multiplied after every NTCYC cycles.

Published property MinIncrementStored: TRealStorage read FMinIncrementStored write SetMinIncrementStored;

TCMIN Minimum time increment allowed.

Published property MaxIncrementStored: TRealStorage read FMaxIncrementStored write SetMaxIncrementStored;

TCMAX Maximum time increment allowed.

Published property Steps: TIntegerCollection read FSteps write SetSteps;

For Step list schedules ISLIST The list of (integer) time steps. (May be continued over multiple lines of input.)

Published property MaxSteps: integer read FMaxSteps write SetMaxSteps;

for Step Cycle schedules NSMAX Max time steps not including initial time step. Maximum number of time step cycles allowed, i.e., the maximum number of time steps allowed in the schedule, not including the initial time step.

Published property InitialTimeStep: integer read FInitialTimeStep write SetInitialTimeStep;

ISTEPI Cycling begins at time step ISTEPI. Initial time step. Cycling begins at time step = ISTEPI.

Published property LimitingTimeStep: integer read FLimitingTimeStep write SetLimitingTimeStep;

ISTEPL Cycling continues until time step >= ISTEPL Limiting time step. Cycling continues until time step >= ISTEPL.

Published property TimeStepIncrement: integer read FTimeStepIncrement write SetTimeStepIncrement;

ISTEPC Time step increment.

Generated by PasDoc 0.12.1 on 2013-05-13 15:42:05