Interactive.src.Interfaces

Connectors and interfaces

Information

Interfaces package

Interfaces package includes the connectors and interfaces of the interactive graphic elements. These packages contain classes describing the interactive graphic elements and the base classes of these elements. There are four type of connectors.

The ParentL and ChildL connectors have the following pair of variables: nodeReference and GridLayout. The nodeReference variable is an integer number that identifies one of the interactive graphic elements of the class describing the virtual-lab view. The gridLayout variable is a boolean variable. The value of this variable is true only if the component identified by the nodeReference variable of this connector has the layout policy GridLayout.

The Parent and Child connectors have the following variables: nodeReference. The meaning of this variable is the same as the nodeReference variable of the ParentL and ChildL connectors.

The interfaces included in the Interfaces package are the following: IContainer, IContainerDrawables, IDrawables and IViewElements.

The description of these four interfaces includes the declaration of an integer variable named num. The value of this variable, which is obtained during the model initialization process, identifies one of the interactive graphic elements of the Modelica view description.

        

Package Content

Name Description
Interactive.src.Interfaces.Parent Parent Connector of drawables components - Parent information
Interactive.src.Interfaces.Child Child Connector of drawables components
Interactive.src.Interfaces.ParentL ParentL Connector of non drawable components - Parent information
Interactive.src.Interfaces.ChildL ChildL Connector of non drawable components
Interactive.src.Interfaces.IContainer IContainer Interfaces of the classes describing containers that can't host drawable elements
Interactive.src.Interfaces.IContainerDrawables IContainerDrawables Interfaces of the classes describing containers that only can host drawable elements
Interactive.src.Interfaces.IDrawable IDrawable Interfaces of the classes describing drawable elements
Interactive.src.Interfaces.IViewElement IViewElement Interfaces of the classes describing interactive elements

Interactive.src.Interfaces.Parent Interactive.src.Interfaces.Parent

Connector of drawables components - Parent information

Information


This connector is used only by components included in the Drawable package.

Contents

NameDescription
nodeReference 
vec[50] 
ind 
c 

Interactive.src.Interfaces.Child Interactive.src.Interfaces.Child

Connector of drawables components

Information


This connector is used by components included in the Drawable package and by containers that can host drawables.
It is used to transmit the number indentifying a container that can host drawables.
If the component is a container, this number is the number of the component. But if the component is a drawable, this number is the number of its container.

Contents

NameDescription
nodeReference 
vec[50] 
ind 
c 

Interactive.src.Interfaces.ParentL Interactive.src.Interfaces.ParentL

Connector of non drawable components - Parent information

Information


This connector is used by components included in the following packages: Containers, InteractiveControls and BasicElements.
This connector is used to obtain the number indentifying the component hosting the element.

Contents

NameDescription
nodeReference 
vec[50] 
ind 
gridLayoutTrue if the component hosting the element has the Grid layout policy
c 

Interactive.src.Interfaces.ChildL Interactive.src.Interfaces.ChildL

Connector of non drawable components

Information


This connector is used by components included in the following packages: Containers, InteractiveControls and BasicElements.
Components included in the Containers package have two connectors of this type, whereas the components included in the other packages have only one connector of this type.

Contents

NameDescription
nodeReference 
vec[50] 
ind 
gridLayoutTrue if the component has the Grid layout policy
c 

Interactive.src.Interfaces.IContainer Interactive.src.Interfaces.IContainer

Interfaces of the classes describing containers that can't host drawable elements

Information


The IContainer interface is inherited from classes describing containers that don't host drawable elements.
It contains the following two connectors on one side (''left'' connectors): pLLeft and cLLeft.
And it contains the following connector on the other side (''right'' connector): cLRight.
This interface includes the definition of a String parameter, named LayoutPolicy. The value of this parameter sets the layout policy of the container (i.e. HBox, VBox or Grid).
According to the connection rules, only a component hosted inside a container with this interface should be connected to the ''right'' connector. The ''right'' connector transmit the two following variables:

According to the connection rules, only the container hosting the container with this interface or a component hosted inside the same container should be connected to its pLLeft connector. And only a component hosted inside the same container should be connected to its cLLeft connector. The variables nodeReference and gridLayout of the cLLeft connector have the same value than the variables with the same name of the pLLeft connector.

Parameters

NameDescription
LayoutPolicyLayout policy

Connectors

NameDescription
pLLeftConnector of non drawable components - Parent information
cLRightConnector of non drawable components - Child information
cLLeftConnector of non drawable components - Parent information

Interactive.src.Interfaces.IContainerDrawables Interactive.src.Interfaces.IContainerDrawables

Interfaces of the classes describing containers that only can host drawable elements

Information


The IContainerDrawable interface is inherited from classes describing containers that host drawable elements.

It contains the following two connectors on one side (''left'' connectors): pLLeft and cLLeft. And it contains the following connector on the other side (''right'' connector): cRight.

According to the connection rules, only a component hosted inside the container with this interface should be connected to the ''right'' connector. The ''right'' connector transmit the following variables:

According to the connection rules, only a container hosting the container with this interface or a component hosted inside the same container should be connected to its pLLeft connector. And only a component hosted inside the same container should be connected to its cLLeft connector. The variables nodeReference and gridLayout of the cLLeft connector have the same value than the variables with the same name of the pLLeft connector.

Connectors

NameDescription
pLLeftConnector of non drawable components - Parent information
cLLeftConnector of non drawable components - Parent information
cRightConnector of drawable components - Child information

Interactive.src.Interfaces.IDrawable Interactive.src.Interfaces.IDrawable

Interfaces of the classes describing drawable elements

Information


The IDrawable interface is inherited from classes describing drawable elements. It contains the following two ''left'' connectors: pLeft and cLeft.

According to the connection rules, only the container hosting the drawable with this interface or a drawable element hosted inside the same container should be connected to its pLeft connector. And only a drawable element hosted inside the same container should be connected to its cLeft connector. The variable nodeReference of the cLeft connector has the same value than the variable nodeReference of the pLeft connector.

Connectors

NameDescription
pLeftConnector of drawable components
cLeftConnector of drawable components

Interactive.src.Interfaces.IViewElement Interactive.src.Interfaces.IViewElement

Interfaces of the classes describing interactive elements

Information

The IViewElement interface is inherited from classes describing basic and interactive elements. It contains the following two ''left'' connectors: pLLeft and cLLeft.

According to the connection rules, only the container hosting the element with this interface or an element hosted inside the same container should be connected to its pLLeft connector. And only an element hosted inside the same container should be connected to its cLLeft connector. The variable nodeReference and gridLayout of the cLeft connector has the same value than the variable nodeReference and gridLayout of the pLLeft connector.

Connectors

NameDescription
pLLeftConnector of non drawable components
cLLeftConnector of non drawable components
Automatically generated Thu Apr 28 12:24:24 2022.