Interactive.src.VLabModel

Classes to describe the virtual-lab view and to set-up the virtual-lab

Information

VLabModel package includes the PartialView, Root and VirtualLab classes. PartialView and VirtualLab classes are inhereted from the classes with the same name contained in the VLabModel package included in the Interactive library.

Package Content

Name	Description
PartialView	Partial model required as base class for the view description model
Root	Root element of the view description
VirtualLab	Class describing the complete virtual-lab
NULL	Null class

Interactive.src.VLabModel.PartialView

Partial model required as base class for the view description model

Information

PartialView class includes an instance of the Root component. The Root component is the root element for the view description. The following tasks are performed by the PartialView class:

Server set-up during the model initialization process.
The startNClientCserver external function, included in the CServer package, is called to perform this task.
This function makes the simulation program (the server) to wait until numberGUI clients has asked for a connection. The function output is a vector containing the socket description for each established connection.
PartialView generates time events at each communication interval T_com using the sample built-in Modelica operator. At each time event the following two tasks are performed:
- Call to the getVarValues external function included in the CServer package.
  This function receives and processes the data sent by each C++ view. Only one view is allowed to perform changes at the same time instant.
  The C++ view sends the data in a string with the following format: nChanges,index₁,value₁,...,index_nChanges,value_nChanges#.
  Where nChanges is the number of interactive variables modified due to a user action and value_i is the new value of the var variable of the interactive control element identified by the index_i number.
  The getVarValues function receives these data and generates as output the CK[:] and I_new[:] arrays. These two arrays are global variables (inner to PartialView and outer to the ControlElement class).
  The value of CK[index_i] has value 1 only if index_i is within the string sent by the view and has value 0 otherwise.
  The value of I_new[index_i] is equal to value_i only if index_i is within the string sent by the Cpp view and is 0 otherwise.
- Change the value of the boolean variable refreshView (from false to true or vice-versa). This is a global variable (inner to PartialView and outer to Drawable class).

Parameters

Name	Description
Tcom	Communication interval
serverPort	Server Port number
launchView	0/1 not/yes launch the view
ipAddress	ip Address
sourceCodePath	Path where the C-functions, Library.dll and pRun.exe are located
numberGUI	Number of GUIs
fileName	Cpp file name
compilation

Interactive.src.VLabModel.Root

Root element of the view description

Information

The Root component is the root element for the view description.

Parameters

Name	Description
ipAddress
serverPort	Server Port number
numberGUI	Number of GUIs

Connectors

Name	Description
cLLeft	Connector

Interactive.src.VLabModel.VirtualLab

Class describing the complete virtual-lab

Information

The class describing the complete virtual-lab has to contain an instance of VirtualLab class. The virtual-lab designer has to set the name of the model and the view classes.

VirtualLab class has the following parameters:

Model-to-view communication interval (T_com).
Name of the C++ file (the content of this file is generated during the model initialization process).
Number of the interactive views running simultaneously.
Parameter to indicate whether lauch the view or not.
IP address and port of the computer where is running the model.
Class describing the virtual-lab model.
Class describing the virtual-lab view.

Parameters

Name	Description
Tcom	Communication interval
fileName	Name of the view file
sourceCodePath	Path where the C-functions, dll library with the view components and delayrun.exe are located
compilation	The C++ GUI must be compiled using Visual C++ 64 bits
launchView	0/1 not/yes launch the view
numberGUI	Number of GUI running simultaneously
ipAddress	IP of the simulation server
serverPort	Server Port number
replaceable model ViewI	Class describing the virtual-lab view
replaceable model ModelI	Class describing the virtual-lab model

Connectors

Name	Description
replaceable model ViewI	Class describing the virtual-lab view
replaceable model ModelI	Class describing the virtual-lab model

Interactive.src.VLabModel.NULL

Null class

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