Interactive.src.ViewElements.InteractiveControls

Interactive controls and base classes

Information

InteractiveControls package

InteractiveControls package includes the interactive elements and the base classes that the library developer has to extend to create new interactive elements.

Package Content

Name	Description
ControlElement	Base class of the classes describing interactive elements
NumberField	Allows editing a numeric value. Interactive var.: var, Enable.
RadioButton	Creates a radio-button. Interactive var.: var.
DisplayDouble	Allows displaying a numeric value. Variable linked to the model: value.
SendElement	Base class of some classes describing interactive elements

Interactive.src.ViewElements.InteractiveControls.ControlElement

Base class of the classes describing interactive elements

Information

ControlElement class has to be inherited from the classes describing interactive elements. This class inherits from the IViewElement class.

The ControlElement class includes the code required to:

Obtain the data sent from every view connected to the model server.
Perform the state re-initialization event that re-initializes the value of the variable defining the state of the element (var). This event takes place when the virtual-lab user manipulates the interactive element changing its state variable value to a new value.

This class includes the following variables:

var variable: input variable that has to be linked to a model variable. The value of this variable can be interactively set by the user.
index variable: the value of this variable is unique for each element of the Modelica view description.
CK[:] and Inew[:] variables: globals variables whose values are transmitted from the PartialView class. The value of CK[index] is true only if the variable associated to the interactive element has been modified due to a user action. In that case, the new variable value is contained in Inew[index]
event variable: boolean variable whose value is set to true only when the interactive element has been manipulated by the user (event = CK[index]>0). When the event variable value is true a when is triggered. This when include the code to re-initialize the value of the var variable to Inew[index].

Extends from Interfaces.IViewElement (Interfaces of the classes describing interactive elements).

Connectors

Name	Description
pLLeft	Connector of non drawable components
cLLeft	Connector of non drawable components

Interactive.src.ViewElements.InteractiveControls.NumberField

Allows editing a numeric value. Interactive var.: var, Enable.

Information

This class inherits from the ControlElement class.
Creates an element that allows editing a numeric value.

Extends from ControlElement (Base class of the classes describing interactive elements).

Parameters

Name	Description
minValue
maxValue
step
initialValue
numberOfDecimals
row
column
rowSpan
columnSpan
EnableInt
Enablep
Initialization
event

Connectors

Name	Description
pLLeft	Connector of non drawable components
cLLeft	Connector of non drawable components

Interactive.src.ViewElements.InteractiveControls.RadioButton

Creates a radio-button. Interactive var.: var.

Information

This class inherits from the ControlElement class.
Creates a radio-button. The var variable of this element can have the value 0 or 1.

Extends from ControlElement (Base class of the classes describing interactive elements).

Parameters

Name	Description
buttonValue	Initial value
text	Text displayed by the element
buttonGroup	The radio-button belongs to this group
row
column
rowSpan
columnSpan
Initialization
event

Connectors

Name	Description
pLLeft	Connector of non drawable components
cLLeft	Connector of non drawable components

Interactive.src.ViewElements.InteractiveControls.DisplayDouble

Allows displaying a numeric value. Variable linked to the model: value.

Information

This class inherits from the SendElement class.
Creates an element that allows displaying a numeric value.

Extends from SendElement (Base class of some classes describing interactive elements).

Parameters

Name	Description
format	Numeric format
precision	Number of digits after the decimal point
alignment	Alignment
prefix	Text inserted before the displayed value
sufix	Text inserted after the displayed value
row
column
rowSpan
columnSpan
Initialization
sdStatus1

Connectors

Name	Description
pLLeft	Connector of non drawable components
cLLeft	Connector of non drawable components

Interactive.src.ViewElements.InteractiveControls.SendElement

Base class of some classes describing interactive elements

Information

SendElement class has to be inherited from classes describing interactive elements that allows to display a variable value in the view. This class inherits from the IViewElement class.

The SendElement class includes the code required to:

Send the value of the num variable corresponding to the interactive element.
Send the interactive variable value.

This information is sent at each communication interval, when the following two conditions are satisfied: (1) the refreshView variable value has changed; and (2) the windowClosed variable value is false.

Finish the simulation when the C++ view is closed. A when is triggered when the drawable element sends data to the view and doesn't receive any reception confirmation after waiting T_Max seconds for it. This when includes the following code: (1) a call to the Modelica built-in operator terminate(...), which finishes the simulation; (2) a call to the shutDownConnection external function included in the CServer package; and (3) the windowClosed boolean variable is set to true.

Extends from Interfaces.IViewElement (Interfaces of the classes describing interactive elements).

Connectors

Name	Description
pLLeft	Connector of non drawable components
cLLeft	Connector of non drawable components

Automatically generated Thu Apr 28 12:24:23 2022.