VirtualLabBuilder.ViewElements.Containers

Information

Containers package

Containers package has those graphic elements that are intended to host other graphic elements. The container properties are set in the view definition and they can not be modified during the simulation run.

Package Content

Name	Description
MainFrame	Main window
Dialog	Dialog window
Panel	Panel container
DrawingPanel	Drawing-panel
PlottingPanel	Plotting-panel

VirtualLabBuilder.ViewElements.Containers.MainFrame

Information

Creates a window where containers and interactive controls can be placed. The view can contain only one MainFrame object. The user can stop the simulation by closing this window.

Parameters

Type	Name	Default	Description
LayoutPolicy	LayoutPolicy	"BorderLayout()"	Layout policy
String	title	"MainFrame"	Text display as title
Integer	xPosition	0	X coordinate of the window upper left corner in pixels
Integer	yPosition	0	Y coordinate of the window upper left corner in pixels
Integer	Width	400	Window width in pixels
Integer	Height	400	Window height in pixels
Integer	nRows	1	Number of rows when GridLayout policy is selected
Integer	nColumns	1	Number of columns when GridLayout policy is selected

Connectors

Type	Name	Description
ParentL	pLLeft	Connector of non drawable components - Parent information
ChildL	cLRight	Connector of non drawable components - Child information
ChildL	cLLeft	Connector of non drawable components - Parent information

Modelica definition

model MainFrame "Main window" 
          extends src.ViewElements.Containers.MainFrame;
end MainFrame;

VirtualLabBuilder.ViewElements.Containers.Dialog

Information

This class, like MainFrame, creates a window where containers and interactive controls can be placed. This class has only two differences with MainFrame class: simulation run doesn't stop by closing this window and there can be more than one Dialog object.

Parameters

Type	Name	Default	Description
LayoutPolicy	LayoutPolicy	"BorderLayout()"	Layout policy
String	title	"Dialog"	Text display as title
Integer	xPosition	0	X coordinate of the window upper left corner in pixels
Integer	yPosition	0	Y coordinate of the window upper left corner in pixels
Integer	Width	400	Window width in pixels
Integer	Height	400	Window height in pixels
Integer	nRows	1	Number of rows when GridLayout policy is selected
Integer	nColumns	1	Number of columns when GridLayout policy is selected
String	varName	""	String variable that can be linked to the corresponding variable of a check-box in order to show and hide the window by clicking on the check-box

Connectors

Type	Name	Description
ParentL	pLLeft	Connector of non drawable components - Parent information
ChildL	cLRight	Connector of non drawable components - Child information
ChildL	cLLeft	Connector of non drawable components - Parent information

Modelica definition

model Dialog "Dialog window" 
            extends src.ViewElements.Containers.Dialog;
  
end Dialog;

VirtualLabBuilder.ViewElements.Containers.Panel

Information

Panel model creates a panel where containers, basic elements and interactive controls can be placed.

Parameters

Type	Name	Default	Description
LayoutPolicy	LayoutPolicy	"BorderLayout()"	Layout policy
positioninLayout	position	"SOUTH"	If the element hosting the panel has BorderLayout policy, this parameter sets the panel location respect to its container (i.e., north, south, west or east)
Integer	nRows	1	Number of rows if GridLayout policy is selected
Integer	nColumns	1	Number of columns if GridLayout policy is selected

Connectors

Type	Name	Description
ParentL	pLLeft	Connector of non drawable components - Parent information
ChildL	cLRight	Connector of non drawable components - Child information
ChildL	cLLeft	Connector of non drawable components - Parent information

Modelica definition

model Panel "Panel container" 
            extends src.ViewElements.Containers.Panel;
end Panel;

VirtualLabBuilder.ViewElements.Containers.DrawingPanel

Information

DrawingPanel model creates a two-dimensional container that only can contain drawable objects. It represents a rectangular region of the plane which is defined by means of two points: (XMin, YMin) and (Xmax, YMax). The coordinates of these two points (i.e., the value of (XMin, YMin) and (Xmax, YMax) ) are parameters of the class whose value can be set by the user.

Parameters

Type	Name	Default	Description
positioninLayout	position	"CENTER"	Position inside its container when this container has the BorderLayout layout policy
Real	XMin	-1	Minimum X
Real	XMax	1	Maximum X
Real	YMin	-1	Minimum Y
Real	YMax	1	Maximum Y

Connectors

Type	Name	Description
ParentL	pLLeft	Connector of non drawable components - Parent information
ChildL	cLLeft	Connector of non drawable components - Parent information
Child	cRight	Connector of drawable components - Child information

Modelica definition

model DrawingPanel "Drawing-panel" 
                    extends src.ViewElements.Containers.DrawingPanel;
end DrawingPanel;

VirtualLabBuilder.ViewElements.Containers.PlottingPanel

Information

PlottingPanel model creates a two-dimensional container with coordinate axes that only can contain drawable objects.

Parameters

Type	Name	Default	Description
positioninLayout	position	"CENTER"	Position inside its container when this container has the BorderLayout layout policy
String	title	""	Title to display at the top
fontType	font_name	"Dialog"	Title font
Integer	font_size	14	Size of the title font
fontStyle	font_style	"BOLD"	Style of the title font
axesType	axesType	"cartesian2"	The type of axis to be displayed
String	titleX	""	Label of the x axis
xyaxesType	xAxisType	"linear"	The type (linear or log) for cartesian X axis
booleanValue	gridX	"true"	Whether to display the grid for the x axis
String	titleY	""	Label of the y axis
xyaxesType	yAxisType	"linear"	The type (linear or log) for cartesian y axis
booleanValue	gridY	"true"	Whether to display the grid for the y axis
Real	deltaR	2	The separation in R for the polar axis
Real	deltaTheta	3.14159/8	The separation in Theta for polar axis
booleanValue	autoScaleX	"true"	Whether to automatically adjust X scale
Real	marginX	0	Margin to be left in the X scale
booleanValue	autoScaleY	"true"	Whether to automatically adjust Y scale
Real	marginY	0	Margin to be left in the Y scale
Real	minX	0	The minimum x value that can be displayed
Real	maxX	1	The maximum x value that can be displayed
Real	minY	0	The minimum y value that can be displayed
Real	maxY	1	The maximum y valued taht can be displayed
booleanValue	coordinates	"true"	Whether to display coordinates when the mouse is pressed
booleanValue	showGrid	"true"	Whether to show or not the grid

Connectors

Type	Name	Description
ParentL	pLLeft	Connector of non drawable components - Parent information
ChildL	cLLeft	Connector of non drawable components - Parent information
Child	cRight	Connector of drawable components - Child information

Modelica definition

model PlottingPanel "Plotting-panel" 
                   extends src.ViewElements.Containers.PlottingPanel;
end PlottingPanel;