OptiSys_Design - GUI Reference Manual

GUI Reference Manual

OptiSys_Design

Optical Communication System Design Software

Version 1.0 for Windows® 98/Me/2000 and Windows NTTM

Optiwave Corporation 7 Capella Court

Ottawa, Ontario, CanadaK2E 7X1

tel.: (613) 224-4700 fax.: (613) 224-4706

e-mail: [email protected] web: http://www.optiwave.com

Notice All OptiSys_Design documents, including this one, and the information contained therein, is copyright material and may not be duplicated or reproduced, in whole or in part, without the prior written approval of Optiwave Corporation.

Copyright © 2001 Optiwave Corporation All rights reserved. No part of this document may be reproduced, stored in a retrieval system or transmitted in any form or by any means whatsoever, including recording, photocopying, faxing, etc., without prior written approval of Optiwave Corporation.

Disclaimer Optiwave Corporation makes no representation or warranty with respect to the adequacy of this documentation or the programs which it describes for any particular purpose or with respect to its adequacy to produce any particular result. In no event shall Optiwave Corporation, its employees, its contractors or the authors of this documentation be liable for special, direct, indirect or consequential damages, losses, costs, charges, claims, demands, or claim for lost profits, fees or expenses of any nature or kind.

TABLE OF CONTENTS

INTRODUCTION ........................................................................................................................................ 1 MENU BAR .................................................................................................................................................. 1 FILE MENU .................................................................................................................................................. 2 NEW PROJECT.............................................................................................................................................. 4

File > New .......................................................................................................................................... 4 Starting a new project ......................................................................................................................... 4 Main Window ..................................................................................................................................... 6 Main Window – Sub-tabs ................................................................................................................... 7

LAYOUT VIEW ........................................................................................................................................... 13

Placing components in the Layout View work area.......................................................................... 13 Subsystems ............................................................................................................................................ 14

Creating a subsystem ........................................................................................................................ 14 Creating an empty subsystem ........................................................................................................... 14 Placing components in subsystems ................................................................................................... 15 Closing a subsystem window............................................................................................................ 15

Component properties........................................................................................................................... 16 Component parameters......................................................................................................................... 17 Design Version properties .................................................................................................................... 22 Design Version parameters................................................................................................................... 24

Adding new parameters to the Design Version................................................................................. 26 Accessing a new Design Version parameter for scripting ................................................................ 28 Removing new parameters from the Design Version ....................................................................... 29 Editing existing parameters in the Design Version ........................................................................... 29

Subsystems ............................................................................................................................................ 31 Creating a subsystem ........................................................................................................................ 31 Creating an empty subsystem ........................................................................................................... 31 Opening a subsystem layout ............................................................................................................. 32 Closing a subsystem layout............................................................................................................... 32 Giving a subsystem an input or output port ...................................................................................... 33 Subsystem Port Properties ................................................................................................................ 34 Modifying subsystem port properties................................................................................................ 34 Subsystem properties ........................................................................................................................ 36 Viewing a subsystem’s properties..................................................................................................... 36 Adding new parameters to a subsystem ............................................................................................ 37 Removing new parameters from a subsystem................................................................................... 39 Removing a new Design Version parameter..................................................................................... 39 Editing new parameters in the subsystem ......................................................................................... 39 Changing a subsystem icon............................................................................................................... 41

Layout Depth Order.............................................................................................................................. 41 Choosing the layout depth order position ......................................................................................... 41

Layout Size............................................................................................................................................ 45 Changing the size of the layout......................................................................................................... 45

PARAMETER SWEEPS VIEW........................................................................................................................ 46

Changing the Laser Power ................................................................................................................... 46 Changing power values..................................................................................................................... 46

Changing Sweep Iteration Values......................................................................................................... 47 Changing the sweep iteration values................................................................................................. 47

Sweep Mode .......................................................................................................................................... 48 Selecting the Sweep Mode................................................................................................................ 48 Editing the parameter sweep iteration values.................................................................................... 48 Assigning sweep iteration values ...................................................................................................... 49 Generating sweep iteration values .................................................................................................... 49 Changing the sweep mode ................................................................................................................ 50

VIEWS VIEW.............................................................................................................................................. 51

Views Tab.............................................................................................................................................. 51 Combining graphs............................................................................................................................. 51 Splitter View Tab.............................................................................................................................. 53 Grouping graphs................................................................................................................................ 53

RESULTS VIEW .......................................................................................................................................... 55

Viewing Results ................................................................................................................................ 55 REPORT VIEW............................................................................................................................................ 56

Report Tab ............................................................................................................................................ 56 Assigning a specific cost................................................................................................................... 57

TOOLBARS ................................................................................................................................................. 58

Standard toolbar ................................................................................................................................... 58 Stop On Calculation Error................................................................................................................. 59 Show Output Window....................................................................................................................... 59 Run Optimizations ............................................................................................................................ 59 Number of calculation threads .......................................................................................................... 60 Setting parameters............................................................................................................................. 60 Minimizing OptiSys_Design............................................................................................................. 61

Design Version toolbar ......................................................................................................................... 63 Adding a new design version ............................................................................................................ 63 Switching between design versions .................................................................................................. 64 Deleting the design version from the Main menu or Project Browser .............................................. 65 Setting the number of Sweep Iterations for a Design Version .......................................................... 66

Dockers toolbar .................................................................................................................................... 67 Accessing the Dockers toolbar.......................................................................................................... 67 Docker functions............................................................................................................................... 68

Layout Tools toolbar............................................................................................................................. 69 Using the Layout tool........................................................................................................................ 69 Selecting multiple components ......................................................................................................... 70 Duplicating components ................................................................................................................... 71 Linking components.......................................................................................................................... 71 Connecting ports ............................................................................................................................... 71 Selecting links................................................................................................................................... 72 Deleting links .................................................................................................................................... 72 Non-compatible connections............................................................................................................. 72 Standard right click ........................................................................................................................... 73 Port properties................................................................................................................................... 74 Changing the size of the layout......................................................................................................... 75

Monitor tool .......................................................................................................................................... 76 Adding a monitor to a port................................................................................................................ 76 Removing a monitor from a port....................................................................................................... 77

Draw Output Port Tool......................................................................................................................... 78 Looking inside a subsystem .............................................................................................................. 78 Drawing an output port ..................................................................................................................... 78

Draw Input Port Tool............................................................................................................................ 80 Drawing an Input Port....................................................................................................................... 80

Draw Rectangle Tool ............................................................................................................................ 81 Creating a Rectangle ......................................................................................................................... 81 Accessing the properties of the rectangle.......................................................................................... 82

Circle Tool ............................................................................................................................................ 83 Drawing a circle................................................................................................................................ 83

Line Arrow Tool.................................................................................................................................... 84 Drawing a line................................................................................................................................... 84

Draw Text Label Tool ........................................................................................................................... 85 Adding text to the layout................................................................................................................... 85

Draw BitMap Tool ................................................................................................................................ 86 Drawing a Bitmap ............................................................................................................................. 86

Zoom Tool............................................................................................................................................. 87 Zooming in and out of layout............................................................................................................ 87

APPENDIX.................................................................................................................................................. 88 OPTI2D GRAPH CONTROL........................................................................................................................ 88

User Interface Features ........................................................................................................................ 88 Help Text: ......................................................................................................................................... 89 Pop up Toolbar: ................................................................................................................................ 89 Information Windows: ...................................................................................................................... 90 Graph Information Window:............................................................................................................. 90 Legend .............................................................................................................................................. 91 Pop Up Tool Menu............................................................................................................................ 92 Tools Description.............................................................................................................................. 93 Graph Menu ...................................................................................................................................... 97

DIALOGS.................................................................................................................................................. 102

Properties Dialog: ........................................................................................................................... 102

1

INTRODUCTION Menu Bar

Figure 1 - Menu bar

When you start OptiSys_Design, you have four menus to work with: File, View, Tools and Help.

Figure 2 - File drop down menu

However, when you create a new project or open an existing one, you will notice that there are seven menus that contain all the commands you will need to do your work effectively.

Figure 3 - Project menu bar

2

File Menu

Figure 4 - File menu - expanded

Once you create a new project or open an existing one, you are given an expanded list of options from the File menu, shown in Figure 4.

New

Opens a new project.

Open…

Opens an existing project

Close

Closes the active project. The program prompts you to save changes before closing the project.

Save

Save the active project under the current name and in the default location.

Save As…

Saves the current project with a different name and in a location of your choice.

Print…

Prints the active project window

3

Print Setup

Allows you to set up the printer, the page size, and orientation, and offers you other printing options.

Calculate

Calculates the active project.

Recently Opened Files

This section lists the most recent files you worked on.

Exit

Allows you to exit the program. The program prompts you to save any changes to the project before it exits.

4

New Project File > New

Using the New Command

The New command allows you to create a new project that appears in the Main Window work area.

Starting a new project

File > New

Basic Overview of Project Structure

The OptiSys_Design project consists of a maximum of fifteen design versions and views. A design version can be thought of as a layout. Within the same project file you can have multiple layouts with different components and component properties.

Sweep Iterations Each design version can have certain component parameters assigned to be in the sweep mode. In this case we can define the number of sweep iterations to be performed on the selected parameters. Through each sweep iteration the parameter value is changed producing a different calculation results upon calculation. The parameter sweep dependant elements of a design version are: Parameters, Results and Graphs.

Optimizations Each design version also has optimizations. Optimizations are used to change the values of a certain parameter during calculation so that we reach a desired state of the system. The optimizations are independent of parameter sweeps, but can be performed for each individual parameter sweep iteration.

Views As each design version provides a set of graphs (from different components, visualizers for different parameter sweep iterations), graphs from different design versions can be combined into views. A view is a collection of graphs. This is a very useful feature when comparing different design solutions for the same problem using different system layouts.

5

Figure 5 - Project structure

The parameter sweep dependant elements of a design version are: Parameters, Results and Graphs.

6

Main Window

Figure 6 - Main window

The Main Window is the largest area in the OptiSys_Design application. When OptiSys_Design is initially opened, the Main Window area is empty. Once a new project is created or an existing project is opened, the Main Window area will display the contents of that project.

7

A new project opened in the Main Window.

Figure 7 - Main window – New project

Main Window – Sub-tabs

Once a new project has been opened in the Main Window, several sub-tabs become visible at the bottom of the work area:

Figure 8 - Main Layout – Sub-tabs

Project tab

The first level of tabs shows the project’s name. In the image above, there is only one project open and it is called “Project 1”.

8

When more than one project is open at the same time, you can use the tabs to switch between them. In the image above, there are two projects, “Project 1” and “Project 2”. “Project 2” is currently selected.

Figure 9 - Main Layout – multiple project tabs

Layout tab

Figure 10 - Layout tab

The Layout tab shows all of the components that are in the project. The Layout tab itself has several sub-tabs that are located directly above it, including the Main Layout tab as well as any tabs for subsystems that have been created and opened.

Main Layout tab

Figure 11 - Main Layout tab

The Main Layout tab will always display the top level of the project in the Main Window. NOTE: The Layout tab must be selected before the Main Layout tab can be accessed.

9

Parameter Sweeps tab

Figure 12 - Parameter Sweeps tab

Select “Parameter Sweeps” tab to open a parameter sweeps view. This will display the values of each sweep iteration. This tab displays the values of each sweep iteration for all the parameters that are in sweep mode. The user can also use this tab to edit the values of the sweep iterations for each parameter in a table format.

10

Views tab

Figure 13 - Views tab

When selected, the Views tab displays either a single or multiple graphs in the work area. Similar to the Layout, the Views also has sub-tabs. The Splitter View sub-tab is always displayed when the Views tab is selected. When a new View is created, additional sub-tabs are added to the right of the Splitter View tab.

Splitter View tab

Figure 14 - Splitter View tab

The Splitter View sub-tab is always displayed when the Views tab is selected.

11

Figure 15 - Splitter View

Results tab

Figure 16 - Results tab

The Results tab shows the values of selected results from the project browser for each sweep iteration.

12

Report tab

Figure 17 - Report tab

The Report tab is automatically generated by OptiSys_Design and displays the name of the design version, the number of iterations, the breakdown of the cost of each component, and the overall cost of the complete design version.

13

Layout View Placing components in the Layout View work area Placing components into the Layout View work area is quite simple.

1. Click and hold the mouse on a component in the Component Library; 2. Drag the component to the Main Layout work area; 3. Release the mouse button to place the component.

Figure 18 - Placing components in layout view

Drag and drop to place a component in the Main Layout work area.

14

Subsystems

Figure 19 - Subsystem

The purpose of a subsystem is to simplify the layout. There can be any number of components in the layout but by grouping certain ones into subsystems, the user will get a better overview of their functionality within the system.

Figure 20 - Create subsystem menu selection

Creating a subsystem 1. Left click and hold in the Main Layout work area; 2. Drag the selection box over the components you want in the subsystem; 3. Right click inside the selection box that has now formed around the components; 4. Select “Create subsystem” from the menu.

The user can also create an empty subsystem and place the specific components they want inside of it.

Creating an empty subsystem 1. Right click in the Main Layout work area; 2. Select “Create subsystem” from the menu; 3. Left click on the newly-created subsystem icon in the Main Layout work area to highlight

it; 4. Once the icon is highlighted, right click on it; 5. Select “Look inside” from menu; 6. Drag and drop desired components from library into subsystem work area.

15

Placing components in subsystems When a subsystem has been created, additional components can be added to it.

1. Select the subsystem tab at the bottom of the work area; 2. Click and hold the mouse on a component in the Component Library; 3. Drag the component onto the Subsystem work area and release the mouse to place the

component.

Figure 21 - Placing components in a subsystem

To place a component in a subsystem, drag and drop it. NOTE: The subsystem tab is only visible if you have first opened the subsystem by highlighting it, right clicking on it and then selecting “Look Inside” from the menu.

Closing a subsystem window

To close a subsystem window and eliminate its tab at the bottom of the work area, do the following:

1. Ensure the Subsystem tab is selected; 2. Right click in an open section of the Subsystem layout work area; 3. Select “Close subsystem” from menu.

This will bring you back to the top level of the layout.

16

Component properties Each component has a number of different properties. To view these properties, do the following:

1. Select the component; 2. Once highlighted, right click on it; 3. From the menu, select “Component Properties.” Or 1. Double click on the component. Or 1. Select Main Menu 2. Edit 3. Component 4. Component Properties Or From the Project Browser, select Component, then Component Properties

This will produce a Properties window much like the one shown below:

Figure 22 - Component properties window

17

NOTE: Double clicking on Visualizer components will NOT open the Properties window. Instead, doubling clicking on a Visualizer component will open a Visualizer window. To open a Visualizer component’s Properties’ window, select the component, right click on it, then select “Component properties” from the menu.

Component Properties Window

The Component Properties window shows you the following information:

Label The name of the component

Cost The cost of the component

Component parameters The component parameters are contained in the Properties Window. The parameters are grouped into different categories for easy reference.

Figure 23 - Properties window – component parameters

In the image above, it shows a component with four different parameter categories – Main, Chirp, Polarization, and Simulation. You can switch between the categories by selecting the different category tabs. Within these categories there are a number of different but related component parameters.

Display column Contains a check box. When a box is checked, that particular parameter’s name and value will be displayed beneath the component in the Main Layout work area.

18

Figure 24 - Main Layout – parameter display

To add other parameters to the Main Layout display;

1. Check the box beside the desired parameter; 2. Click OK.

Name column This column lists the component’s parameter names. This is a read-only column and cannot be changed.

Value column Shows the value of the parameter. The user can edit the value of the parameter from this column. To change the value of a parameter:

1. Click in the Value column beside the parameter you wish to change; 2. Enter the new, desired figure; 3. Click OK.

NOTE: If the value the user enters is invalid, the Value column beside the parameter the user is changing will turn red when the user clicks OK. In addition, the status box will indicate the entered value is invalid and will give you the value range.

Units column This column displays the units available for each parameter. To change the unit for the parameter:

1. Click in the Unit column of the unit you wish to change; 2. If there are other units available, they will be shown in a drop-down menu. Choose one; 3. Press Enter.

After the user presses Enter, the number in the Value column will automatically be recalculated to show the appropriate value.

19

NOTE: The units available will vary from parameter to parameter. If there is only one unit available for a particular parameter, the user will not get any options when it is clicked.

Mode column This column indicates what mode the parameter is in. A parameter can be in one of four possible modes – Normal, Sweep, Script, and Optimized. The user can only select from Normal, Sweep, and Script. A parameter is set to Optimized Mode by optimizing the component in the project browser.

Mode column – Normal

Figure 25 - Mode column - Normal

When the Mode is set to Normal, it means the parameter has a single value for every sweep iteration. Normal is the default setting for the Mode column.

Mode Column – Sweep

Figure 26 - Mode column - Sweep

When the Mode is set to Sweep, it means the parameter can have a different value for each sweep Iteration. To select Sweep:

1. Right click in the Mode column for the parameter you wish to change; 2. Select “Sweep” from the menu; 3. Press ENTER.

The parameter name will change to red to indicate it is now in Sweep mode. The sweep values can be observed and/or changed using the Parameter Sweeps tab.

20

Mode Column – Script

Figure 27 - Mode column - Script

When the Mode is set to Script, it means that the user is allowed to enter a script text in the parameter’s Value field. To select Script:

1. Click the drop down box in the Mode column for the parameter you wish to change; 2. Select “Script” from the menu; 3. Press ENTER; 4. Input desired script text into empty Value column of parameter you wish to change; 5. Press ENTER.

The parameter name changes to orange, indicating that it is now in Script mode. NOTE: The script text value can only be a single value for every sweep iteration. However, if the script string references different parameters that do change across sweep iterations, the value of the scripted parameter will automatically change. If the user right clicks in the Value column once Script mode has been selected, they will be shown a drop-down box of available parameters that can be used for scripting:

Figure 28 - Scripting parameters

The user can select from any one of the above options and then edit that expression in a Visual Basic script form.

Verify Scripts To see the value of the parameter after making these changes in Script mode, click on “Verify Scripts” in the Component Properties window. The results will be displayed at the bottom of the window in the Status box:

21

Figure 29 - Verify Scripts – status box

Legend

Figure 30 - Legend

The Legend in the bottom right hand corner of the Properties window is there to illustrate when the parameters are Enabled, Disabled or Read Only.

Help

Figure 31 - Help button

The Help button is located in the bottom right corner of the Properties window.

22

Design Version properties The user can access the Design Version Properties by several methods:

1. Right click on the Main Layout work area; 2. Select “Design Version Properties” from the menu. Or 1. Right click on the version name on the Project Browser. This will display the context

menu; 2. Select Properties > Design version properties. Or 1. In the Project browser select any component; 2. Right click where a context menu with “Design Version Properties”.

Figure 32 - Context-sensitive menu – Design Version Properties selection

Or 1. Select a component from the layout; 2. Right Click where it will display a context menu with “Design Version Properties”

available.

23

Or, from the top menu bar:

DesignVersion > Properties.

Figure 33 - Menu bar – Design Version

Figure 34 - Design version properties window

Name This is the name of the Design version. The user can input the name of the scripted design version here.

Author The name of the user who has created and/or modified this design version.

Date The date. The date can be changed with the arrow buttons on the right. The large arrow button opens up a drop down calendar.

24

Description This field allows the user to enter a more elaborate description of the design version they are working on.

Design Version Properties Header

Figure 35 - Design Version properties header

The Design Version properties can also be seen in the header at the top of the Main Layout work area. The properties cannot be edited from here. One the far right end of the Design Version Properties header, the current sweep iteration as well as the total number of sweep iterations for that design version.

Design Version parameters In addition to the generic properties, parameters may be assigned to the design version. To access the design version parameters, the user can do one of two things:

Double click in the Main Layout work area.

Or, from the menu bar,

DesignVersion > Parameters.

25

Figure 36 - Design Version Parameters window

The Design Version Parameters window is very similar to the Component Parameters window. The parameters are grouped into different categories for easy reference. Figure 36 shows the design version with three different parameter categories – Simulation, Signals and Noise. The user can switch between the categories by selecting the different category tabs. Within these categories there are several different but related design version parameters.

Display column Contains a vertical list of check boxes. These are the boxes that the user will check or uncheck regarding the parameter of the component. If the user chooses to check this box, the parameter and its value will be displayed in the main layout.

Name column This column shows the design version’s parameter names. This is a read-only column and cannot be changed.

Value column Shows the value of the parameters. The user can edit the value of the parameters from this column. To change the value of a parameter:

1. Click in the Value column beside the parameter you wish to change; 2. Enter the new, desired figure; 3. Click OK.

26

NOTE: If the value the user enters is invalid, the Value column beside the parameter the user is changing will turn red when the user clicks OK. In addition, the status box will indicate the entered value is invalid and will display the value range.


1. Click in the Unit column of the unit you wish to change; 2. If there are other units available, they will be shown in a drop-down menu; 3. Select one; 4. Press Enter.

After the user presses Enter, the number in the Value column will automatically be recalculated to show the appropriate value. NOTE: The units available will vary from parameter to parameter. If there is only one unit available for a particular parameter, the user will not get any options when they click on it.

Mode column This column indicates what mode the parameter is in. The Mode option is limited in the Design Version Parameters window since these settings are created by the system. For this reason, the user cannot change the Mode of the parameters. However, users can choose between Normal and Sweep with new Design Version Parameters that they add.

Adding new parameters to the Design Version

Figure 37 - Add Parameter button

OptiSys_Design allows the user to enter additional parameters into the Design Version Parameters window. Once a new parameter has been added to the Design Version, it becomes a top-level parameter. It is then available for scripting by any of the components within the Design Version.

27

Figure 38 - Parameters window

New parameters can be added under any of the Design Version Parameter categories. As an option, users can also add their own category tab for new parameters.

Name This is the name of the new parameter

Type User can select from the following list of parameter types:

Figure 39 - Parameter types

Category Allows the user to choose from Simulation, Signals and Noise.

28

Minimum Value The minimum value of the parameter.

Maximum Value The maximum value of the parameter. NOTE: OptiSys_Design will not allow the user to set either the Minimum or Maximum values outside the valid range of the parameter.

Current Value The default value of the parameter. The Current value must fall between the Minimum and Maximum values.

Units User-created parameters can only have one unit. OptiSys_Design does not allow changing between different units for user-created parameters.

Accessing a new Design Version parameter for scripting Now that a new parameter has been created, it can be accessed from the design version’s components window.

Figure 40 - New parameter – access for scripting

1. From the Main Layout, double click on a component to show its parameters; 2. Select on of the parameter category tabs; 3. Select “Script” from the Mode column; 4. Press Enter; 5. Right click in the parameter’s now-empty Value column; 6. Select the new parameter script from the drop-down menu to access its value; 7. Press “Verify Script”.

NOTE: When the user presses “Verify Script”, they will see the value of the new parameter in the dialog box at the bottom of the Component Properties window.

29

Removing new parameters from the Design Version

Figure 41 - Remove Parameter button

The user may remove parameters that they have created in the Design Version Parameters window.

1. Click on the parameter’s box in the “Value” column; 2. Press “Remove Par”.

NOTE: The user cannot remove system parameters.

Editing existing parameters in the Design Version

Figure 42 - Edit Parameter button

The user may edit the parameters they create in the Design Version Parameters window.

1. Click on the parameter’s box in the “Value” column; 2. Press “Edit Param…” bottom on right hand side of window.

Figure 43 - Edit parameter window

This window is similar to the Add Parameter window.

Name This is the name of the parameter to be edited.

Type Users cannot change the type of parameter in the editing option.

30

Category Allows the user to choose from Simulation, Signals and Noise.




Units User-created parameters can only have one unit. OptiSys_Design does not allow changing between different units for user-created parameters. NOTE: OptiSys_Design does not allow the user to edit the system parameters.

31

Subsystems

Figure 44 - Subsystem

The purpose of a subsystem is to simplify the layout. A designated amount of components can be in the layout but by grouping certain ones into subsystems, the user will get a better overview of their functionality within the system.

Creating a subsystem

Figure 45 - Create subsystem menu selection

While using the Layout Tool:

1. Left click and hold in the Main Layout work area; 2. Drag the selection box over the components you want in the subsystem; 3. Right click inside the selection box that has now formed around the components; 4. Select “Create subsystem” from the menu.

The user can also create an empty subsystem and place the specific components they want inside of it.

Creating an empty subsystem

1. Right click in the Main Layout work area; 2. Select “Create subsystem” from the menu; 3. Left click on the newly-created subsystem icon in the Main Layout work area to highlight

it;

32

4. Once icon is highlighted, right click on it; 5. Select “Look inside” from menu; 6. Drag and drop desired components from library into subsystem work area. Or 1. Select Main Menu 2. Edit 3. Component

Now a subsystem will be created

Opening a subsystem layout Once a subsystem has been created in the project, it is possible to open that subsystem to view and work with the components inside it.

1. Select Main menu 2. Edit 3. Component 4. Look inside Or

1. Create a subsystem; 2. Left click on the subsystem in the Main Layout work area to highlight it; 3. Right click on it to display the menu; 4. Choose “Look inside” from the menu choices;

Figure 46 - Subsystem tab

Once opened, a Subsystem tab will automatically appear beside the Main Layout tab at the bottom of the work area, as seen in the image above. If there are more than one subsystems, these tabs will also appear to the right of the Main Layout tab once steps 1-4 are repeated. NOTE: The Layout tab must be selected before the Subsystem tabs can be accessed.

Closing a subsystem layout Closing a subsystem does not mean the user is deleting it. Closing a subsystem merely closes the subsystem work area and removes the Subsystem tab from beside the Main Layout tab. The subsystem itself will remain in the Main Layout work area.

1. Right click in the Subsystem work area; 2. Select “Close subsystem” from the menu.

Or

33

1. Main Menu 2. Edit 3. Component 4. Close Subsystem

Subsystem input and output port tools When the user is working in the Subsystem work area, two new tools are active on the far-right tool bar – the Input and Output Port tools. These two draw tools allow the user to put input and/or output ports into subsystems.

Figure 47 - Subsystem Input and Output port tools

Giving a subsystem an input or output port

1. In the Main Layout work area, left click on the subsystem icon to highlight it; 2. Once the subsystem is highlighted, right click on it; 3. Select “Look inside” from the menu. If this option disables the menu, it means the

subsystem is already open. Instead, click on the “Subsystem” tab at the bottom of the Main Layout work area;

4. Click on either the input or output draw tools in the tool bar on the right hand side of the screen;

Figure 48 - Subsystem Input and Output port tools

5. Move your cursor over to the subsystem work area near the edge. You will notice that the pointer now changes to either the word “Out” or “In”. This will change to an input or output icon when it is near an edge where it can be applied. Once you see the icon, press the left mouse button to place it;

Figure 49 - Subsystem Input and Output ports

NOTE: For the subsystem to work properly, a component inside of it must have an output port if you want the subsystem to have an output port. Likewise, a component inside the subsystem must have an input port if you want the subsystem itself to have an input port.

6. Click on the pointer symbol in the tool bar on the right hand side of the screen.

34

7. Click on the component’s output/input port and drag it to the subsystem’s new output/input port. The link is created.

Figure 50 - Subsystem Input and Output ports – created link

8. Select the “Main Layout” tab at the bottom of the work area to see and work with the subsystem at the design version level.

Subsystem Port Properties

Modifying subsystem port properties Once a port has been added to a subsystem, the user can change its properties. There are two ways to modify a subsystem’s port properties:

1. Double click on the subsystem port you wish to modify. Or…

1. Right click on the subsystem port you wish to modify; 2. Select “Port properties” from the menu.

Figure 51 - Output Port Properties dialog box

Edge Allows the user to set the port on either the top, bottom, left, or right edge of the subsystem icon.

35

Position Allows the user to set at what point on the chosen edge the port will be. 0.0 is one corner, 0.5 is the halfway point and 1.0 is the far corner.

Label This box allows the user to change the name of the port. Once changed, the new name will appear when the mouse is brought over the port in the project browser.

Figure 52 - Renamed port

In the image above, the output port has been renamed “Output port 1”.

36

Subsystem properties

Subsystem properties are very similar to Design Version parameters and Component properties.

Viewing a subsystem’s properties

1. Double click on the subsystem icon in the Main Layout work area.

Figure 53 – Subsystem properties dialog box

Or

1. Main menu 2. Edit 3. Component 4. Component properties Or 1. Project Browser 2. Select subsystem 3. Right click to open menu 4. Component properties

Display column Contains a check box.

37

Name column This column shows the subsystem’s parameter names. This is a read-only column and cannot be changed.

Value column Shows the value of the parameters. The user can edit the value of the parameters from this column. To change the value of a parameter:

1. Click in the Value column beside the parameter you wish to change; 2. Enter the new figure; 3. Click OK.

NOTE: If the value the user enters is invalid, the Value column beside the parameter the user is changing will turn red when the user clicks OK. In addition, the status box will indicate the entered value is invalid and will display the value range.


1. Click in the Unit column of the unit you wish to change; 2. If there are other units available, they will be shown in a drop-down menu. Choose one; 3. Press ENTER.

After the user presses ENTER, the number in the Value column will automatically be recalculated to show the appropriate value. NOTE: The units available will vary from parameter to parameter. If there is only one unit available for a particular parameter, the user will not get any options when they click on it.

Mode column This column indicates what mode the parameter is in. The Mode option is limited in the subsystem parameters window since these settings are created by the system. For this reason, the user cannot change the Mode of the parameters. However, users can choose between Normal and Sweep with new subsystem parameters that they add.

Adding new parameters to a subsystem

Figure 54 - Add Parameter button

OptiSys_Design allows the user to enter additional parameters into the Subsystem Properties window.

38

Figure 55 - Add Parameter window

Name This is the name of the new parameter

Type User can select from the following list of parameter types:

Figure 56 - Parameter types

Category The user can only add parameters to the Image category.




Units User-created parameters can only have one unit. OpitSys_Design does not allow changing between different units for user-created parameters.

39

Removing new parameters from a subsystem

Figure 57 - Remove Parameter button

The user may remove parameters that they have created in the Subsystem Properties window.

Removing a new Design Version parameter

1. Click on the parameter’s box in the “Value” column; 2. Press “Remove Par”.

NOTE: The user cannot remove system parameters.

Editing new parameters in the subsystem

Figure 58 - Edit Parameter button

The user may edit the new parameters they create in the Subsystem Properties window.

1 Click on the parameter’s box in the “Value” column. 2 Press “Edit Param…” bottom on right hand side of window.

Figure 59 – Edit parameter window

This window is similar to the Add Parameter window.

Name This is the name of the parameter to be edited.

40

Type Users cannot change the type of parameter in the editing option.

Category The user only has the Image category to work with.




Units User-created parameters can only have one unit. OpitSys_Design does not allow changing between different units for user-created parameters. NOTE: The OptiSys_Design system parameters cannot be edited. If the user attempts to do so, they will be shown the following screen:

Figure 60 – Edit system parameters window

41

Changing a subsystem icon

The user can customize the subsystem’s icon in the Main Layout work area.

1. Left click on the subsystem in the Main Layout work area to highlight it; 2. Once highlighted, right click on it; 3. Select “Component Properties” from the menu; 4. In the Subsystem Properties window, check the Use Image checkbox in the Value

column; 5. Left click in the Filename Value column. This will bring up a drop-down menu arrow in the

right hand side of the cell; 6. Click on the drop-down menu arrow; 7. Select the bitmap image you would like to make a subsystem icon out of; 8. Click OK.

Layout Depth Order Sometimes, components are placed in the same position in the Main Layout work area, a situation that can become quite confusing if it is a particularly complicated layout.

Figure 61 - Layout Depth Order

Choosing the layout depth order position The user can choose which components are on the top and which are on the bottom by:

1. Left click on the component you wish move back or to the top; 2. Once highlighted, right click on it; 3. Select “Back one” or “Forward one” to move it down or up a layer or “To back” or “To

front” to put it behind or on top of all other components;

42

Figure 62 - Layout Depth Order – position selection

Or

1. Select Main menu 2. Edit 3. Component (as displayed in the following graphic).

Figure 63 - Layout Depth Order – main menu access

Or From Project Browser 1. Select component 2. Right click 3. Open menu

43

This feature is more effective when used in collaboration with the rectangle tool.

1. Click on the rectangle tool in the tool bar on the right hand side of the work area; 2. Draw a rectangle over the components you wish to visually set apart in the work area;

Figure 64 - Rectangle Tool – selected components

3. Select the pointer arrow in the tool bar;

4. Click on the rectangle outline to highlight it;

Figure 65 - Rectangle Tool – highlighted components

5. Double click inside of the rectangle to get the following window; Rectangle Properties

window.

44

Figure 66 - Rectangle properties window

6. Click on the button to select a color for the rectangle; 7. Check the Filled Rectangle checkbox; 8. Press OK. 9. Left click on the now-solid rectangle to highlight it; 10. Right click on the rectangle in the layout work area; 11. Select “To back” from menu to produce the following effect;

Figure 67 - Layout Order – highlighted

45

Layout Size

Figure 68 - Layout size

The Main Layout work area is initially set to 640 X 480 units. This is not a fixed size and can be changed to suit the needs of different systems projects, larger ones in particular. There are several ways to change the size of the layout.

Changing the size of the layout

1. Edit > Layout Size;

Figure 69 - Enter layout size dialog box

2. Change Width and/or Height to desired sizes; 3. Press OK.

Or… 1. Select the pointer arrow from the tool bar on the right hand side of the layout work area; 2. Press and hold the SHIFT and CONTROL keys together; 3. Click in the work area; 4. Drag the mouse in different directions to manipulate the size of the work area;

NOTE: The user can use the same methods to change the size of the work area in a subsystem.

46

Parameter Sweeps View Changing the Laser Power The parameter sweeps view displays the value for each parameter sweeps iteration. In order to change the CW laser’s power value across the sweep iteration, in a single CW laser layout, the user would first need to define how many sweep iterations there will be. This can be accomplished by following the next steps.

Changing power values

Click on the “Set Total Sweep Iterations” button on the top toolbar.

Figure 70 - Set Total Sweep Iterations button

Or… Click the “Design version tab” and then select the “Set Total Sweeps Iteration” icon on the toolbar.

Figure 71 - Total Sweeps Iterations – main menu access

The “Total Parameter Sweep Iterations “ pop-up screen will appear indicating its current values.

Figure 72 - Total Parameter Sweep Iterations dialog box

47

Changing Sweep Iteration Values Here, the user selects the number of sweep iterations for all the parameters in the layout.

Changing the sweep iteration values

For this example, the user will enter the number 5.

1. Enter the number 5 in the Sweep Iteration box. This change reflects the numeric value in the right hand corner of the tool bar, indicating its new current value of 5.

2. Change the Sweep Iterations using the drop down box on the toolbar,

Figure 73 - Sweep Interations drop down box

OR By using the “previous and next” buttons located to the right of the Sweep iterations drop down box.

.

Figure 74 - Previous/Next buttons

3. Click on the “Parameter Sweeps Tab” (the second tab at the bottom of the design layout), to bring up an empty work space.

NOTE: The Parameter Sweeps Design layout will remain empty until the parameters have been defined or set to sweep mode.

4. To set the parameter to sweep mode, double click the “Components Property Dialog”

Figure 75 - Components Property dialog box

Here the user can choose the desired parameter to sweep. In this example, the “Power parameter of the CW Laser” component was randomly chosen as the test subject.

48

Sweep Mode Selecting the Sweep Mode

1. Here the user will select the “Sweep” mode from the drop down box in the Mode section.

Figure 76 - Sweep mode

By changing the selection from Normal to Sweep, the colour of the Power Parameter in the Name box becomes RED. This colour coding indicates that the “Power” Parameter has been selected to sweep mode.

2. Next, the user will click on the “Parameter Sweeps Tab” at the bottom of the work area,

where the CW Laser 1.0 Parameter will be displayed.

Figure 77 - Component Parameter Sweep Iterations list

It has five values, which represent the power parameters of the CW Laser across the five sweep iterations.

Editing the parameter sweep iteration values Now the user can edit these values by entering data into each field manually

OR

By using one of the sweep iteration tools from the toolbar to automatically assign values.

49

Assigning sweep iteration values To do this, the user will go to the “Tools” menu 1. From the sub-menu select “Sweep Iteration Spread”, which will then display three more

sub-choices. These are: A- Linear B- Inverse log and C- Logarithmic spread.

Figure 78 - Sweep Iteration Spread – main menu access

When the user selects one of these options- either A, B, or C, the program will select the first and last values, and then create a spread of values for the remaining equations, based on the linear, inverse log and logarythmic algorithm values. The user will try the following example.

Generating sweep iteration values 1. Enter the number zero (in the first field) 2. Enter -40 (in the last field).

Figure 79 - Parameters Tab – generating values

1. Click the “Tools” menu, > 2. Sweep Iteration, > 3. Linear (A).

50

The program has generated these values:

-10 -20 -30 -40.

NOTE: More than one parameter can be set to Sweep mode.

Changing the sweep mode In this example,

1. The user will select “Frequency” and change the mode from Normal to Sweep in either the component parameters window or by using the group window.

2. Clicking the Parameters Tab will display the changes that have occurred.

Figure 80 - Parameters tab – mode change

The 1.0 Frequency Parameter has been added. Here we can simultaneously devise as many parameters as required from the layout.

51

Views View Views Tab The Views tab, at the bottom of the design layout, allows the user to display views in the system. The view window can be defined as being the collection of one or more graphs. Graphs are generated by components, although not all components generate graphs. The user can combine graphs from same components, different components, or even different design versions to create views. For example, these three components would be a good start for the user to practice: • CW Laser 1.0 • Optical Power Meter Visualizer 1.0 • Optical Spectrum Analyzer 1.0

Combining graphs

1. The user can create these views by going to the project browser “Graph” Tab (located on the far left parameter).

Figure 81 - Project Browser – Graph tab

(This figure represents all the graphs that are compatible with the components already in the main layout. All the graphs represented by a blue graphic icon are those that can be carried into the main layout for testing. In this figure the “Optical Spectrum Analyzer 1.0” is the component.)

2. Select a graph to add. 3. Right click to display the context menu. Options: “Quick View” or “Add to view”.

52

Figure 82 - Graph tab – context menu

4. By clicking “Add to view”, the views tab will automatically open and display added graphs. The user will note that a sub-tab has been created underneath the design layout view. This new tab indicates the title of the image on the screen.

Figure 83 - Multi-Graph view

Even though the user only selected one view, each view created in this example has five different colours, indicating that the chart includes five different graphs. The reason it has created five different graphs is due to the fact that the user in the past example chose 5 sweep iterations to be added. Across sweep iteration value, parameters change, producing different graphs and different components. Therefore the graphs are displayed in different colours on the view. One view will always display as many curves per graph as there are sweep iterations. In this particular example, the user chose one graph and five sweep iterations, which produces five curves in the view. The curves are conveniently displayed in distinctive colours, creating clear and concise lines.

53

Several graphs can be selected to add to the view by holding the Ctrl key and selecting the graphs. This is called multiple selection.

Figure 84 - Graph tab – Multiple view selection

Splitter View Tab

The purpose of this tab is to allow the grouping of multiple views in the four way split window.

Grouping graphs 1. The user can view these graphs by clicking the Project Browser Views tab.

Figure 85 - Project Browser – Views tab

2. From the Views tab in the project browser, the user selects the graph they would like added to the view.

3. Once selected, the user then right-clicks creating another sub-menu

4. Right click displays the menu with the option to add the graph to the splitter view

For this example, the user will select “Add To Splitter 1” from the sub-menu.

5. After adding graphs to the splitter view, click the “Splitter view” Tab from the bottom of the

work area.

54

Figure 86 - Views tab – Splitter View

Here the user will see that the view has been added to the first section of the four-way splitter window. The order in which these views will appear are as follows:

Splitter 1 = top left Splitter 2 = top right Splitter 3 = bottom left Splitter 4 = bottom right

We can switch between views by clicking any of the bottom view tabs, displaying different variations of the views.

55

Results View The Results view tab allows the user to display the values of selected results in a layout across sweep iterations. In order to do this, there must be a component that will produce results in the layout. For this example, we will refer to the same component that is currently displayed in the work area: “Optical Power Meter Visualizer 1.0”.

Viewing Results

1. Here, the user will select the “Results Tab” on the project browser.

Figure 87 - Project Browser - Results tab

2. Next, the user will expand the list of results by clicking on the + symbol, (left of the name). Select (for this example) “Total Power (dBm) = -40

3. Right Click it to display the menu 4. Select “Add to Display Table”.

Figure 88 - Results Tab – Add to Display Table

Once these steps have been taken, the user will then switch to the “Results View” (under the work area) where the Total Power results will be displayed. In other words, it displays the result values for all iterations. NOTE: In the results view window, the data cannot be changed or edited, only viewed.

Admin

Pencil

Admin

Pencil

56

Report View Report Tab Clicking on the report tab allows the user to view a summarization of the report. Some of the things listed are:

• Name of the design versions • Number of sweep iterations • Cost of each component • Total cost of project

Figure 89 - Report tab

It must be noted that this is a read-only view; no data can be edited or changed. However, if the user changed the project name or design version name or number of sweep iterations, the values would be reflected in the report view. If the user decides to assign a specific cost amount to a component, they can do so by clicking the Layout tab (bottom left), then double clicking a component in the window.

57

Assigning a specific cost For this example, the user will change the cost box to 1500 (located at top right of the component properties window).

Figure 90 - Component Properties dialog box – Cost box

In the component properties window, place cursor in the cost box. The user will note that once the box is selected, the cursor changes from an arrow to a line.

1. Enter 1500 in this box. 2. Click on the “Report View” tab (bottom right) where the display has been changed to

reflect the amount difference. The Report view shows that the cost of the component has been changed to fifteen hundred, and the total cost of the project has been updated.

This is a particularly useful tool for the user who is designing a system based on a budget. This tool allows the user to closely monitor costs while getting the best value.

58

Toolbars Standard toolbar The standard toolbar is very similar to the toolbar in most multi-document based applications.

Figure 91 - Standard toolbar

The toolbar includes the following buttons:

• “New” button, which creates new documents. • “Open” button, which opens exiting projects saved to the disk. • “Save” button, which saves the current project to disk. • “Print” button. • “Cut” button • “Copy” button • “Paste” button • “Undo” button • “Redo” button • “Calculate” button

NOTE: The “Redo and “Undo” buttons in OptiSys_Design can be used an indefinite amount of times. The user can go back as far as the very first step in the project, or forward to the end of the project. Also, the Delete design version cannot be undone. The calculate button is used to perform different calculations. This will most likely be one of the most common tools applied.

Calculate Button For this example,

1. The user will now click on the “Calculate” button. Here the OptiSys_Design calculation dialog box will pop up.

Figure 92 - OptiSys_Design Calculations dialog box

59

In the Calculations dialog box, the user can specify several parameters. The user has the choice of firstly calculating the whole project, secondly calculating all iterations in the current design version or thirdly calculating the current iterations. If the user selects “Calculate the whole project”, OptiSys_Design will calculate all the design versions and all the sweep iterations within each design version. If the user selects “Calculate all iterations in current design version”, OptiSys_Design will calculate all the sweep iterations within the current active design version only. If the user selects “Calculate current iteration”, OptiSys_Design will only calculate the currently selected sweep iteration in the currently selected design version.

Stop On Calculation Error

Another option the user can set is the “Stop on calculation errors” (refer to last graphic). If OptiSys_Design encounters a calculation error, (e.g. an invalid signal type entered in the components) the program will automatically stop the calculation. Otherwise, if this option is not selected, the system will continue calculating, regardless of the reported error.

Show Output Window

Figure 93 - OptiSys_Design Calculations - Show Output window

The “Show Output Window” allows the user to show “Calculation Output ” when they are doing calculations. By activating this button, in the beginning stages of calculations, a window will display reports of each component being calculated, their status and all the details about the calculations.

Run Optimizations

The “run optimizations” check box is used to enable and disable optimizations on a project. OptiSys_Design allows a very flexible way of defining optimizations in a project. Optimizations are a functionality that allows the modification of parameters in a layout in order to achieve a desired goal.

60

Number of calculation threads

Another feature in this program is the “Number of calculation threads” located near the bottom left hand side.

Figure 94 - OptiSys_Design Calculations – number of calculation threads

This feature allows the user to set the number of calculation threads.

Setting parameters For this example, the user will increase the “number of calculation threads” in the dialog box to 6.

The calculations dialog box expands according to the new data input, displaying the new status of each thread once the calculation is complete. The first line reports the overall progress of all calculations. The ensuing lines will indicate the progress for each component that is calculated on each calculation thread. By selecting multiple calculation threads, the user can usually speed up the calculation if there is a layout, which allows concurrent calculations. There is no rule, which defines what exact layout is needed for concurrent calculations. However, it usually consists of WDM system, where multiple channels are calculated in parallel paths in the system. The maximum number of calculation threads allowed is 20. The minimum amount of calculation threads allowed is 1. There must always be at least one for the number of calculation threads, in order for the program to calculate the components.

Play Button

In the top right corner of the dialogue box are the control buttons. The green triangle is the Play button, which starts the calculation. Here the user will select the Play button, which begins the calculation, and displays the progress of the calculations at the bottom of the work area. If at any time the user would like to stop this calculation, simply press the red Stop button.

61

During the calculation, the user will notice that once the Play button is clicked it becomes a Red Stop button.

Pause

Underneath the Play button is the Pause button, which when activated will block all the running calculation threads. This will put the program in a suspended state. At this point, the calculations are not aborted, they are only paused. NOTE: This is particularly useful if the user starts an OptiSys_Design calculation, which can sometimes use a great amount of processing power on the system, then would like to use another application. The pause button will suspend the calculation without losing any of the results and allow the user to go to another application, returning later to resume the calculation.

Minimize Arrow

The down arrow button is used to minimize OptiSys_Design during calculations.

Figure 95 - OptiSys_Design Calculations – Down Arrow button

Minimizing OptiSys_Design For this example,

1. Select the “Play” button, 2. Then select the “Down Arrow” button.

OptiSys_Design will be minimized into a task bar.

3. Double click the OptiSys_Design in the taskbar, the window returns. If the user is running extremely lengthy calculations, the user can use this button to preserve desktop space and minimize OptiSys_Design into a taskbar. This allows the user to occasionally check the status of the calculation, by double clicking this icon and viewing the window. NOTE: When OptiSys_Design is minimized to an icon in the taskbar, the user can distinguish its state by checking its colour.

62

White arrows The icon will have white arrows when it is in an idle state and is done calculations. Red arrows The icon will display red arrows when it is in the process of calculation.

Stop The last button in the dialogue box is the red stop symbol, indicating the “Close” button. If this is selected, the dialogue closes.

63

Design Version toolbar The design version toolbar allows the user to:

1. Add design version 2. Duplicate design versions 3. Set current design version 4. Set total sweep iterations 5. Set current iterations

This is also accessible by selecting the Main menu, then clicking on Design version.

Adding a new design version

The first button is the “Add Design Version”.

Figure 96 - Design Version toolbar – Add Design Version button

1. Clicking “Add Design Version” button, a new design version will be added to the project. 2. The user can now select the “Layout” tab in project browser. This will show the initial

design layout as well as the new one (version 2).

Figure 97 - Layout tab – added design version

The design layout is currently empty since there have not been any components added yet. Here the user can choose which component they will want, and then drag them into the work area as instructed earlier in this guide. Whenever a new design version is created it will be active. NOTE: There must be at least one design version in a project; the user cannot delete all the design versions in a project.

64

A more interesting way of creating a new design version is by selecting the “Duplicate Design Version” button available from the main menu > Project Browser.

Figure 98 - Design Version toolbar – Duplicate Design Version button

This will create the new design version based on the currently selected design version. It will copy all the components, parameters, views, results, etc. into the currently selected design version. Now the user will see in the project browser that the new design version has been added.

Figure 99 - Layout tab – copied design version

The new design “version 3” has been created based on the design “version 1”. As we can see, version 1 and 3 have the same components since they are copied versions of each other. Version 2 has an empty work window.

Switching between design versions

An alternative way of switching between design versions is by selecting the design version from the drop down box, located on the toolbar.

Figure 100 - Design Version drop down box

This allows the user to click on whichever design version they would like to view. Another way to switch between design versions is by clicking on the desired item in the project browser layout tab. (bottom right).

65

The user will notice that as they switch between project versions, the number of sweep iteration changes, as well as the design version in the layout. This is located at the top right hand corner of the work area.

Figure 101 - Project Browser – Design Version tab

NOTE: We should note that the number of sweep iterations is per design version. Each design version can have a different number of sweep iterations.

Deleting the design version from the Main menu or Project Browser

To delete the design version, the user must select the design version they would like to delete. 1. To delete, the user must select the design using the Project Browser or set design

versions 2. Click on delete button Or If deleting from the Project Browser: 1. Right click > Delete

Figure 102 - Delete Current Design Version button

Once this button has been selected, the user is warned to make sure this information is correct.

Figure 103 - Delete Current Design Version – warning dialog

If the user selects “Yes” the design will be permanently deleted. NOTE: This operation cannot be undone.

66

Setting the number of Sweep Iterations for a Design Version

1. Click the “Set Total Sweep Iterations” button. This has previously been described in the “Parameter sweeps view” section.

Figure 104 - Set Total Sweep Iterations button

To switch between sweep iterations, the user will select the “Sweep iteration drop down box” and select the sweep iteration desired. The user will note that any parameters that have been previously set in sweep mode will change values as the Sweep iteration drop down box is open and is being scrolled through. In this example, it is the Power Parameter of the laser, which is being changed.

Figure 105 - Change in Sweep Iteration values

We can also change the sweep iterations for the design version, by clicking the previous and next buttons on the toolbar.

Figure 106 - Previous/Next buttons

Again the user will note that any parameter set in sweep mode will change values as the previous and next button are selected.

67

Dockers toolbar The docker’s toolbar is not initially visible.

Accessing the Dockers toolbar

1. The user must select “View” from the toolbar, > 2. “Toolbars” > 3. “Dockers”.

Figure 107 - View Dockers menu selection

Once this has been selected, a new section of the toolbar will appear on the right hand side.

Figure 108 - Dockers toolbar

It should also be noted here that any toolbar can be enabled and disabled through this manner. The Dockers toolbar displays an icon for every docker in the system:

1. Component Library 2. Project Browser 3. Calculation Output 4. Project Overview 5. Parameter Groups

68

Docker functions

Component Library docker

Displays all the components available in the component library folders. It also allows the user to drag and drop the components from the libraries into the layout area and vice versa.

Project browser docker

Displays the structural view of a project in all of its different aspects. For example, the user can view the layout, results, graphs views and optimizations.

Calculation Output docker

Displays the progress of the calculation. This is a read-only function.

Project Overview docker

Displays a ‘bird’s eye view. It allows zoom and pan operations on the layout.

Parameter Groups docker

Displays parameter groups. Certain parameters can be functionally grouped. For example, the frequency parameter of different components, have the same meaning. These parameters are grouped in the frequency group, and they will all be displayed in the same list in the parameter group’s docker. The purpose for this is to allow more flexibility for changing the values of parameters in the components. The user can hide or display any of the dockers by clicking the buttons on the docker’s toolbar.

Figure 109 - Hide/Display Dockers using Docker toolbar

Or

Using main view > View

69

Layout Tools toolbar The layout Tools toolbar is initially active and can be located in the right hand side of the layout.

Figure 110 - Layout Tools toolbar

This tool has several features to allow different operations on the layout. The first and most commonly used tool is the “layout tool”. On the toolbar, it is located at the very top, this being the arrow. Therefore when the user brings the cursor to the work area, it will be an arrow. This tool allows the user to move the components around the layout, connect them and perform numerous operations.

Using the Layout tool

1. If the user clicks on a component using this tool, they will see that it has been selected by its new dotted outline.

2. Next, by holding the shift key, the user can select another component, which will add them together.

At any point, the user can left click a component and drag the selection anywhere into the work area. If there have been multiple components selected, then all of the components in the selection will move to the desired space.

Figure 111 - Using the Layout tool

70

Selecting multiple components

Another way of selecting multiple components is by:

1. Clicking in the background, 2. Dragging the rubber band selection over all the desired components and 3. Releasing the mouse once selected.

Figure 112 - Selecting multiple components

All the components that are within the band will be selected. The user can release this band by left clicking outside the selection in an empty area. By right clicking in different areas of the work space, a context sensitive menu will pop-up, based on the subject matter.

Figure 113 - Work area – context-sensitive menu

Right clicking can be done in the components, port, or the background of the layout, each producing a different menu.

71

Duplicating components

The layout tool also allows the duplication of components:

1. The user will hold the control key, 2. Click on the component, while simply dragging the component to another position.

The new duplicated component will contain all the same properties as the initial component.

Linking components

Looking closely at the component, the user will notice an arrow (the port). The symbol changes to a chain by placing the mouse above it

Figure 114 – Linking components symbol

This symbol indicates that this port is now available for linking. A tool tip will also pop-up indicating the type of signal that is available on this port. The user can only connect “output” to “input” ports and vice versa. The only connectable ports are those which have the same type of signal being transferred between them. The exception to this rule is the ports that can be added to a sub-system and certain components in the library that have ports, which support any type of signal. (e.g. Forks)

Connecting ports

To connect these ports, 1. The user left clicks while holding the button on the output port, 2. Then drags across to the input port, making an adjoining line.

Figure 115 - Connecting ports

When the user drags the mouse pointer from the output port over to the input port, a tool-tip is displayed indicating signal type on input port. Once the mouse is released, a connection line will appear indicating the successful linking of the two if the ports are compatible.

72

Selecting links

The user can select links in the design layout, where the link will change from its existing color to a red solid line once it has been selected. There can only be one link selected at a time.

Figure 116 - Selecting links

Deleting links

By right clicking a link, then pressing the delete button, the link will be deleted. The same operation can be preformed on a component. If the user selects a component, then presses the delete button, the component will be deleted.

Non-compatible connections

In the case of non-compatible ports, a special icon will appear.

Figure 117 - Non-compatible ports icon

The user can try to join two non-compatible ports, but the end result, once the mouse is released, will indicate that no operation has been performed. Another way to connect ports is by using the rubber band tool. This can be done by holding down the control key, and upon doing this, the user will notice the symbol change to a chain.

Figure 118 - Rubber Band cursor

This cursor represents the rubber band cursor. This means that the user can connect the two ports by dragging the band around them and releasing.

73

Standard right click

Right clicking a component will produce a standard context sensitive menu of the operations supported.

Figure 119 - Right click – display of standard context sensitive menu

• Cut and Copy: these are the standard Cut and Copy features. These will allow for cut and copying from one component to another or from one project to another.

• Delete: the user can delete components • Duplicate: the components can also be duplicated • Create Subsystems: an extremely useful tool in this program is the ability to create

subsystems. This can be done by selecting parts of a layout and grouping them into a sub-layout which is called a “Subsystem”. This is done by selecting the desired components (rubber band method), right clicking the selection and then selecting “Create subsystems” from the menu. This will now shrink the selected components into one component labeled “Subsystem”. The components are not lost; they are simply shrunk into one place. If the user would like access to these components, they will right-click the subsystem and select “Look inside” from the menu.

Figure 120 - Subsystem ‘Look Inside’ menu selection

74

This will open a new layout, showing the components added to the subsystem. In order to switch back to the main layout, the user will click on the “Main layout” tab (bottom of work area). To return to the open subsystem, simply click the “subsystem” tab. To close the sub-system, the user will right click in the background and select “Close subsystem”.

Figure 121 - Close subsystem menu selection

This will close the sub-tab and the subsystem will then return to the main layout.

Port properties

Another available function is the port properties operation. This is available only when the mouse is situated directly above the port, and the user right clicks, producing the menu containing port properties.

Figure 122 - Port properties

This box displays all the port properties. All of the ports and subsystems the user has created manually can be changed in here. The rest of the properties would be read-only. More features can be displayed by right-clicking in the background of the work area. On this menu, the user will always find the “component properties” available as well as “Design version properties”.

75

Figure 123 - Standard context-sensitive menu

These features have been discussed in previous sections of this guide.

Changing the size of the layout

Holding the control and shift key together, while left clicking and dragging will control the size of the layout.

76

Monitor tool The second tool on the layout tools toolbar is the Monitor tool.

Figure 124 - Monitor tool

The monitor tool allows us to create and remove monitors from the layout. A monitor is a module, which is placed on the port of a component, which remembers the data that passes through a port during calculations. In OptiSys_Design, the data that passes through the ports are arrays with very large amounts of data. It could not remember the data for every single port, since this would yield an overload of memory requirements. Instead, the program allows a flexible way of viewing data, where the user selects which ports in which they would like to view the remembered data. Once the port is chosen, the user can use the visualizers to connect to the ports, which have been monitored.

Adding a monitor to a port

1. The user will select the monitor tool and bring it into the work area, where they will note that the cursor has changed to a square. If the square is placed directly over the port, the frame will change from a solid black square to an empty white square. This indicates that the monitor tool is ready.

2. Next the user will left click, and the monitor is created over the port.

Figure 125 - Port with monitor

To indicate that there is a monitor in the port, a little box is created around the port.

77

If the user moves the monitor tool over ports that already have a monitor, the cursor will change to a box with an X inside.

Figure 126 - Port with monitor – cursor change of monitor tool

Removing a monitor from a port

If the user clicks on the port, it will remove the monitor from the port. Once a monitor has been added to a port, the user can connect multiple visualizers to the same port - any visualizer can be added which can visualize this type of data.

Figure 127 - Port with multiple visualizers

Normally, multiple connections cannot be made from the same port to different components. However, if a monitor has been installed on a port, multiple connections can be made to visualizers. If the user tries to delete the monitor that has visualizers connected to it, a warning will be displayed explaining that all links to the visualizers will be disconnected.

Figure 128 - Visualizer disconnection dialog

If the user chooses the “yes” option, all the links on the visualizers will disconnect. If the user connects a visualizer to an output port and releases the button, a monitor will automatically be created in order to connect the visualizer. Monitors are extremely useful because the user doesn’t need to plan how they would like to review the data. All the user has to decide is on which part of the layout they would like to view the data.

78

Draw Output Port Tool The draw output port tool is inactive in the main layout, since the user can only draw output ports when inside a sub-system.

Looking inside a subsystem

1. The user will create a subsystem out of the two selected components by rubber banding the two components.

2. Right clicking and selecting “Create subsystem”. From this point the user can look inside the subsystem by:

3. Right clicking and selecting “Look inside”. Once the user is inside, they will notice that the output port tool icon on the bar has become visible.

Figure 129 - Layout toolbar – Output Port tool

Once the “Draw output port tool” has been selected, the user will notice that the cursor has changed from its regular arrow to a cross with the word OUT.

Figure 130 - Output Port tool - cursor

Drawing an output port

1. Select the “Draw output port tool” This new cursor now indicates that the user is drawing output ports on the subsystem. If the user goes to the outside boundaries of the subsystem box, they will notice the cursor change again. It now becomes the port symbol that we have seen earlier in this guide.

79

When the user sees this symbol: 2. Click the mouse and the symbol will remain at the chosen location. Now a new output

port has been created. The new output port behaves the same way as any other port, meaning that the user can connect to it from any output port in the system. If the user now goes back to the main layout, they will see that the subsystem’s new output port has been created. If the user would like to modify the output port they have created, they can move the layout tool directly above the output port, right click to create the context menu, and select “Port properties”.

Figure 131 - Context-sensitive menu – Port Properties selection

Once this has been selected, a new box will appear called “Output Port Properties”. Here all the Port properties will be displayed.

Figure 132 - Output Port Properties dialog box

In this box we will find the type of output port, the edge on which is connected, and the position relative to that edge. It also displays the Label of the output port, where the user has the option of changing this information.

80

Draw Input Port Tool Similar to the Draw output port tool, the Draw input port tool is not available in the main layout. It is only available in the subsystem. This tool allows us to draw input ports in the subsystem.

Figure 133 - Layout toolbar – Input Port tool

Drawing an Input Port

Once the tool has been selected from the menu, the cursor becomes a cross with an IMP. Here, the user will select any boundary of the inside edge of the box and left click to place the port. This newly created input port behaves as any other port in the system.

Figure 134 - Subsystem layout – Input and Output ports

If the user now returns to the main layout, they will see that the subsystem now has an input port and an output port. The user can modify the properties of an input port the same as modifying a port anywhere else in the system. This is by placing the cursor above the port, right clicking and selecting “Port Properties” while using the layout tool.

81

Draw Rectangle Tool The draw rectangle tool is used to draw rectangles in the layout.

Figure 135 - Layout toolbar – Draw Rectangle tool

These rectangles are graphic layout objects, which are used to enhance the presentation of the layout.

Figure 136 - Layout - rectangle

Creating a Rectangle

1. Here the user will select the “Draw Rectangle Tool” and bring it into the layout. 2. Then the user left clicks the mouse and drags it across the layout, sizing the rectangle to

the desired shape. 3. Once the shape has been attained, release the mouse and the form will take a solid

colour.

82

Accessing the properties of the rectangle

1. Select the layout tool, 2. Select the rectangle, and double click.

The “Rectangle Properties” box will appear.

Figure 137 - Rectangle Properties dialog box

Here the user can change the colour of the rectangle or change the fill.

83

Circle Tool The draw circle tool is used to draw circles in the layout.

Figure 138 - Layout toolbar – Circle tool

Drawing a circle

1. The user clicks on the circle tool, 2. Brings it into the layout and 3. Left clicks to create a desired size for the circle.

Figure 139 - Layout - circle

As with the rectangle, the user will double click on the circle to reveal its properties.

Figure 140 - Circle Properties dialog box

In this box, the user can change the properties as well as changing the fill of the circle.

84

Line Arrow Tool The draw line tool allows the user to draw lines on the layout.

Figure 141 - Layout toolbar – Line Arrow tool

Drawing a line

1. Here the user will select the line arrow tool, 2. Left click somewhere in the layout and create a line.

Figure 142 - Layout - line

Once the line has been drawn, the mouse is released and the line is created with an arrowhead. To view the properties of this line, the user will double click on the line and the properties box will appear.

Figure 143 - Line Properties dialog box

Here the user has the option of changing the line colour or adding an arrowhead at the tip. If the arrowhead is not important, simply select the “Draw Arrow Head” box and it will be removed.

85

Draw Text Label Tool The “Draw Text Label Tool” allows the user to put text into the layout.

Figure 144 - Layout toolbar – Draw Text Label tool

Adding text to the layout

1. The user can add words to the layout by selecting this tool from the bar, 2. And left clicking in the layout. This will create a label properties dialogue box.

Figure 145 - Label Properties dialog box

In this box, the user will enter any text they would like to have displayed on the layout. Once some text has been added, the user can modify this by selecting the text in the layout, double clicking and selecting font. The user can change the font, font style, size, effects, colour and script.

86

Draw BitMap Tool The “Draw BitMap Tool” allows the user to place any custom bitmap in the layout.

Figure 146 - Layout toolbar – Draw BitMap tool

Drawing a Bitmap

1. Select the “Draw Bitmap” button, 2. The user then left clicks in the layout, selecting the desired area for the bitmap.

When the mouse is released, a dialog box pops up, asking what the user would like to put in the bitmap.

Figure 147 - BitMap Image dialog box

Here the user will have a variety of images to choose. There will be Jpeg, Windows Bitmap, and PC Exchange. Once the image has been created, the user can stretch and resize the image as desired.

87

Zoom Tool The zoom tool allows the user to zoom in and out in the layout.

Figure 148 - Layout toolbar – Zoom tool

Zooming in and out of layout

1. Select the “Zoom Tool”. The cursor will become a magnifying glass when in the layout. 2. Left click anywhere in the layout for a zoom in; right click to zoom back out.

Another way for the user to zoom in and out is by left clicking an area in the layout, which creates a rubber band. Here the user can select the specific area that they would like to see zoomed, then releasing the mouse for the zoom effect.

88

APPENDIX OPTI2D Graph Control

Figure 149 - Opti2D Graph Control

User Interface Features The new Graph control offers many new features. These features include:

- Moveable information windows - Info Window - Legend - Popup Tool Menu - Markers - Labels - Region Selection - Tracers - Difference Tracers - Panning - Zooming - Crosshair (for applications such as an Oscilloscope) - Large data handling. The graph control can handle millions of points.

89

- Optimized Drawing. Even with a large amount of points the drawing algorithm is optimized to allow for smooth tracing and panning.

The Graph control is a versatile and powerful tool for observing data. It is also quite simple to use. The following section of this document will give a brief description of some of these features and an explanation of how to use them.

Figure 150 - Main Title display

The user interface for the control is relatively straightforward. The main graph display is the object that the user will see first.

Help Text:

There are a variety of tools available to the user at this point. The first and most obvious is the help text that appears at the top of the graph. This help text displays useful hints explaining the different functionalities of each of the tools.

Pop up Toolbar:

Right clicking on the graph can launch the Toolbar. This will provide a variety of tools, which will allow the user to organize or analyze the graph.

90

Information Windows:

The information windows will be described in more detail in the Graph Information Window:. There are two main windows that are visible on the main display, the Legend and the Info-Window. Both can be launched from the pop-up toolbar.

Graph Information Window:

Figure 151 - Info Window

The Info-Window can be found on the main display of the graph. By default it displays the current position (in Data-Based coordinates) of the mouse cursor. As the user adds marker, tracers, and regions, the display enlarges and displays the details of these various components on the Graph. The user can also double click on the window using the select tool and the following properties dialog box will be displayed.

91

Figure 152 - Info-Window Settings dialog box

Legend

The Legend can be switched on and off using the Legend Tool, located on the Pop-up Toolbar. It displays a list of all the curves present in the graph with the corresponding line color that is used to display those curves.

Figure 153 - Legend

92

Pop Up Tool Menu

Figure 154 - Pop-up tool menu

When the user right clicks on the display, the above pop-up toolbar will appear. This toolbar holds most of the functionality accessed by the user.

93

Tools Description

Select Tool

This tool allows the user to manipulate and move most of the objects on the Graph. Double click on Objects to edit the properties of that object.

Zoom Tool

Zoom in: Select a Rectangular region or simply click for proportional zoom in. Extra Features: Zoom out: By Holding the Control Key and Clicking at the same time a zoom out will be performed. Reset Zoom Level: By Double Clicking the Graph will return to the default Zoom Level.

94

Pan Tool:

The Pan Tool allows the user to Press the Left mouse Button on the Display, (Grab) the Display, and Pan from side to side to see parts of the graph that may not be visible at the current Zoom level or Resolution. Extra Features: By Pressing the Control Key at the same time as panning, accelerated pan is engaged. The pan will be much faster. (Useful when working under a high zoom factor) Grid Tool:

The Grid tool allows the user to turn all the Grid Lines On/Off. Simply click on the Icon and it will toggle the Grid Lines. Trace Tool:

The Tracer Tool allows the user to select a curve and then trace over while seeing the exact values on the curve. Double Clicking will allow the user to select a different curve. The data values will be displayed in the Info Window that can be launched from the popup toolbar. Extra Features: By Pressing the Control Key, the tracer will freeze in its present position. Then by pressing the left mouse button a marker will be placed on that position on the curve. By Pressing the shift key and dragging the mouse, the tracer jumps into a high-resolution trace that iterates through each element in the source data array. This allows for a very detailed scan of the data and to find peaks that the standard trace may omit.

95

Difference Trace Tool:

The Tracer Tool allows the user to select a curve and then trace over it while seeing the exact values on the curve. However it differs from the Trace tool because it allows one to create a second tracer and compare values on either the same curve or on different curves. Double clicking will allow the user to select the next Curve. The data values will be displayed in the Info Window that can be launched from the popup toolbar. Extra Features: By Pressing the Control Key the tracer will freeze in its present position. Then by pressing the left mouse button a marker will be placed on that position on the curve. By Pressing the shift key and dragging the mouse the tracer jumps into a high-resolution trace that iterates through each element in the source data array. This allows for a very detailed scan of the data and to find peaks that the standard trace may omit. Marker Tool:

The Marker Tool, when selected, allows the user to place markers on the Active Display. These Markers can be horizontal, vertical or both. The position of the markers is displayed in the Info Window. Region Select Tool:

The Region Select Tool allows the user to select a horizontal, vertical or rectangular region on the Graph’s Active Display. On its own the region may only be decorative. Though the coordinates of the selection are displayed in the Info Window. Label Tool:

The Label Tool allows the user to place labels on the Graph’s Active Display.

96

Legend Tool

The Legend Tool Toggles the Legend On and Off. Info Window Tool

The Info Window Tool simply Toggles the Info Window On/Off. Layout Reset Tool

The Layout Reset Tool resets the layout and places all the windows in their default positions.

97

Graph Menu

The Graph Menu can be launched by clicking on the blue icon in the top left corner of the Graph

Figure 155 – Graph menu

Tools Launch the tools that are available from the pop-up Tool menu. Please see the Tools Description section to see the description of the tools’ functions. • Select • Zoom • Pan • Grid • Tracer • Difference Tracer • Marker • Region • Label

98

Windows Launch the Windows that are available from the pop-up Tool menu. Please see the Legend Tool, above, or above sections to see the description of the window tools’ functions. • Legend • Info-Window • Reset Layout Printing and Export to File Formats

Print Launches a print dialog and allows the user to print the an image of the Graph in its current state.

Print to BMP File Exports an image of the Graph in its current state to a File in the BMP Format.

Print To EMF File Exports an image of the Graph in its current state to File in the EMF Format.

Copy Image To Clipboard Copies the image of the Graph to the clipboard. Utilities

Tool Setup Allows the user to modify the properties of some of the tools. This will only launch the tool property dialog if the currently active tool allows settings to be changed. (Currently only valid for the Region Selection Tool)

Set Active Display Allows the user to select the active display. (See the Displays section for more information.)

Properties Launches the properties Dialog.

Table of Points Launches a dialog box that displays a list of all the curves on the graph control and displays the data coordinates of those curves. It also allows the user to export the data points to a text file.

Import Curve Allows the user to import a curve from a text file. The file must be in the format below.

X1 (tab) Y1 X2 (tab) Y2 Etc…

99

Ex: // (Beginning of file) - this line should not be in the file 123.23 123.45 123.24 124.55 123.25 555.55 123.26 222.22 //(End of file) - this line should not be in the file

100

Displays The graph is made up of layered displays. Each display has a pair of axis. By default the control contains one display with Axis X on the bottom of the display and Axis Y on the left. However for more complex graphs that require more than one pair of axis more than one display will exist.

Figure 156 - Active Display dialog box

101

Any objects that are placed on the graph are placed on the currently active display. Therefore if the user places a marker on the graph and Display 1 is active, the added marker will be based on the coordinate system of Display 1. If the user would like to add a Marker on Display 2, the main menu must be selected in the Graph menu. “Active Axis”. This will launch a dialog box, which will permit the user to select a different display. In complex graphs, they are layered one on top of the other.

Figure 157 – Displays (displays are a pair of axes)

102

Dialogs Properties Dialog:

The properties dialog allows the user to manage most of the properties of the Graph. It consists of many tabs, each of which is described below. Axis Tab

Figure 158 - Properties dialog box

The Axis Tab allows the user to set the various properties of the axis. Scale Type Value can be:

- Linear - Logarithmic - DB

Format Value can be:

- Linear - Exponential - Engineering - Scientific

Prefix The user can place a prefix string before each of the scale values. Suffix The user can place a suffix string after each of the scale values. i.e. 1000.0 nm

103

Min, Max Value, Auto Scale The user can either force the axis range to certain values or check Automatic Range, which will set the range according to the curves in the displays. Tick marks User can set the number of major and minor tick marks on the Axis. Curve Tab

Figure 159 - Properties dialog box - curves

The Curve tab allows the user to set the various properties of the curves added to the control. Curve List Displays all of the curves on the Active display. Color Allows the user to select the color of the currently selected curve. Line Style Allows the user to select the line style of the currently selected curve. Plot Style Allows the selection of the plot style.

Possible values include:

• Point • Line • Segment Left • Segment Right • Segment Center • Step Left • Step Right • Drop Line

104

Line Thickness Allows the user to select the thickness of the currently plotted curve line. Point Style Allows the selection of the style in which each point on the curve will be drawn.

Possible values include:

• None • Circle • Square • Diamond • Cross • X • Triangle • Star

Grid Tab

Figure 160 - Properties dialog box - Grid tab

The Grid tab allows the user to select which of the grid lines on the display are visible, as well as what color they are to be displayed in.

105

Fonts Tab

Figure 161 - Properties dialog box - Fonts tab

The Font Tab allows the user to select the fonts that are used for displaying titles and Axis values. Legend Tab Legend tab simply has a toggle for the Legend Visible/Invisible. More features will become available in the future.

106

Graph Tab

Figure 162 - Properties dialog box - Graph tab

The Graph Tab is used for editing the titles of any axis as well as the graph title itself.

107

Label Management Tab The Label Management tab allows the user to remove and edit labels on the graph. This functionality can also be performed using the label tool. However, for removing a large amount of labels or labels that may have been positioned at coordinates that are not in the viewable area, it would be easier to remove or edit them using the Label Management tab.

Figure 163 - Label Management tab

108

Documents

OptiSys_Design - GUI Reference Manual