36 6 Model file format

6.2.16 Explicit variables

These variables are not part of the equation system; but they can be plotted and saved with the dynamic and static variables. In other words: explicit variables are variables that can be calculated explicitly.

AddExplicit adds information about an explicit variable.

Heading

function AddExplicit(var Variable : TFloat; Name : PChar; DoPlot : TBoolean) : TInteger;

function AddExplicitExt(var Variable : TFloat; Name : PChar; DoPlot : TBoolean; ALabel : PChar) : TInteger;

Parameters
Variable	The declared pascal variable, which represents the variable in the model.
Name	Text that appears in the Simulation Interface program.
DoPlot	True:	The variable is plotted.
	False:	The variable is added to the Results page when calculation is done.

Return value

The number assigned to the variable. Can be used to identify the variable in calls to

SetUIValue.

Example

AddExtraExt(Bi,'Biot number',False,'');

6.2.17 Action buttons

Action buttons are buttons you can place on the user-interface. You are responsible for writing code, which responds when the user presses the button – this should be done in OnUIValueChange (see 6.11). You install buttons by calling AddActionBtn.

Heading

function AddActionBtn(Caption : PChar; ParamPage : TInteger) : TInteger;

function AddActionBtnExt(Caption : PChar; ParamPage : TInteger;

ALabel : PChar) : TInteger;

Parameters
Caption	The caption of the action button.
ParamPage	The number of the parameter page to place the button on.
ALabel	See 5.1.
Return value

The number assigned to the button. Can be used to identify the button in calls to SetUIValue.

Example

AddActionBtnExt('Load properties',1,'Press to load parameters');

Will create a button, which looks like this:

WinDali

Morten Juel Skovrup

6 Model file format

37

6.2.18 Info Labels

Info labels are labels you can place on the user-interface, displaying some information to the user. You install info labels by calling AddInfoLabel.

Heading

procedure AddInfoLabel(Caption : PChar; ParamPage : TInteger) : TInteger;

procedure AddInfoLabelExt(Caption : PChar; ParamPage : TInteger;

ALabel : PChar) : TInteger;

Parameters
Caption	The caption of the info label.
ParamPage	The number of the parameter page to place the info label on.
ALabel	See 5.1.
Return value

The number assigned to the label. Can be used to identify the label in calls to SetUIValue.

Example

AddInfoLabelExt('This is a message',1,'');

6.2.19 HideSampleTime

HideSampleTime can be used to hide information about fixed sample in the simulation program from the user.

On the Solver page in the simulation program the used can select to run the simulation with fixed sample time. If you do not want the user to have this possibility you should call HideSampleTime. This could for example be the case if you want the user to input the sample time together with other parameters for a controller and not on the Solver page. In this case you should also call SetSampleTime in PreCalc (see chapter 6.3 and 6.8).

Heading

procedure HideSampleTime;

Parameters

None

Example

HideSampleTime;

WinDali

Morten Juel Skovrup