Tips tricks

This page summarizes tips for handy usage of apiMAX™

Did you know ...

Quick draw Bumping connectors You can connect two Composite Items together by bumping connectors. Select and move one Composite Item (while holding down the Shift key) to bump one of its connectors against a connector in another Composite Item. If the two connectors are compatible, a Stream Item will be created to make the connection.

Streams connecting You can verify that Streams are connected to Connectors. Click Tools|Options, click the Model tab and check Show Verify Dots. Click OK. Red and green dots are painted at each stream end point. A green dot means that the end is connected. A red dot means that the end is not connected.

Runs Running items You can Run selected Items in a Model. Select one or more Items (Click Left or Shift+Click Left or Rect Select) and click the Run button.

Set breaks You can set a break at any Composite or Sequence Item. Select one or more Items (Click Left or Shift+Click Left or Rect Select) and click the Break button. When you run the model the run will stop at the break item. Click the Continue Run or Run Step button to continue the run.

Item run code You can add Item run code. Select a single Item, right click and Create Item Code. The Item Run_Proc is run instead of the referenced Model's run code.

Run output The Run Output window shows Information, Warnings and Errors when a Model is run. Click View|Run Output or click the Run Output button to show or hide the Run Output window.

Change output You can change what is shown in the Run Output window. Click right in the Run Output window and select the type of output desired.

Execution time Run output messages continue to be recorded even when the Run Output window is closed. Run execution speed can be increased by not recording messages. Open the Run Output window, click right in the window and select No Messages. Close the Run Output window.

Unit Types Change dimensional units globally Click Tools|Options, click the Unit Types tab to change units globally. New models will default to the global set of units.

Change dimensional units locally Click right on a blank area of a model, click Properties. Click the Unit Types tab to change dimensional units for a model.

Models Types of models There are five different classes (types) of Models: (1) Case, (2) Composite, (3) Connector, (4) Stream and (5) Sequence.

Case Model The Case Model class does not have a symbol, it has a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is the only Model you can Run.

Composite Model The Composite Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code, and it is Run by another Model. A Composite Model has no specific function. Its function is defined by the developer.

Connector Model The Connector Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is never Run. The Connector Model lets you attach Streams.

Stream Model The Stream Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is never Run. The Stream Model transfers data from one Model to another.

Sequence Model The Sequence Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it can be Run. The Sequence Model Runs a set of Items in a specified order.

Models tree Re-arrange models The Project/Model tree lets you rearrange models in a Project. Select a Model and drag it to the new location in the Project. The Model is moved after the highlighted Model.

Move models The Project/Model tree lets you move Models from one Project to another. Select a Model and drag and drop it on the new Project name.

Copy models The Project/Model tree lets you make copies of Models. Select a Model, hold down the Ctrl key and drag and drop the Model on a Project.

Projects What is a project A Project is a collection of one or more Models. A Model is a collection of one or more Items.

Open Recent Projects You can open recently opened Projects and Models by clicking Files | Recent Projects or Files| Recent Models

Save projects Projects are automatically saved when hanged.

New project You can add a new Project by clicking File | New Project. Select the root directory for the new Project and enter the new Project name.

Sort projects You can sort the Projects in the project/Model tree. Click right in a blank area of the Project Window and click Sort Projects.

Items What is an item Each object in a Model's view is an Item. There are two types of Items: (1) Primitive and (2) Complex. Primitive Items are objects such as lines, polygons, text, etc. Complex Items are Model Items. Model Items refer to and use the services of a Model. One service a Model supplies is the Model's symbol drawing service.

Item classes Each class of Model (except the Case Model) has a corresponding Item class: (1) Composite Model and Composite Item, (2) Connector Model and Connector Item, (3) Stream Model and Stream Item and (4) Sequence Model and Sequence Item.

Adding items The Project/Model tree is a source for adding an Item to an open Model's view. Select a Model in the Project/Model tree and drag and drop it in the open Model's view.

Selecting Items You need to select an item before you can edit the item.

Views Splitter The Model View is a splitter view window. Click and drag the vertical sizing bar (at the top of the vertical scroll bar) and/or the horizontal sizing bar (to the left of the horizontal scroll bar) to create up to four separate Model Views.

Panning You can Pan the Model View. Point to a blank area in the Model View window, press and hold the left mouse button down (the Pan symbol is shown), move the mouse in the direction of the pan and release the left mouse button when done.

Aerial View The Aerial View shows the entire model. An inverted rectangle in the Aerial View shows the location of the Model View. Click View|Aerial or click the Aerial View button to show or hide the Aerial View window.

Pan using aerial view You can pan the Model View by moving the inverted rectangle in the Aerial View. Point to the inverted rectangle (a 4-way cursor is shown), press and hold the left mouse button down and move the inverted rectangle to a new location.

Page boundaries The Model View shows page boundaries. Pages are numbered left to right and top to bottom.

Jump to pages You can jump the Model View from page to page by clicking View|Next Page or View|Previous Page or by clicking the Next Page or Previous Page buttons.

Working with Bookmarks You can Bookmark Views of the Model. Bookmarked Views are saved views of the Model. Click right on an Item and click Properties or double click an Item, select the General tab and check the Bookmark checkbox. The current Model View is saved with the Item. The Item is Bookmarked. Note that not all Items can be bookmarked. If there's no Bookmark checkbox on the General Page the Item cannot be bookmarked.

Sizing handles You can change the size of Sizing Handles. Click Tools|Options, click the Model tab and change the Handle Size value. The value is the width/height of Sizing Handles in pixels.

Show commands Clicking right on a blank area in the Model View shows commands for the Model. Clicking right on an Item in the Model View selects the Item and shows commands for the Item.

		Did you know ...
Quick draw	Bumping connectors	You can connect two Composite Items together by bumping connectors. Select and move one Composite Item (while holding down the Shift key) to bump one of its connectors against a connector in another Composite Item. If the two connectors are compatible, a Stream Item will be created to make the connection.
Quick draw	Streams connecting	You can verify that Streams are connected to Connectors. Click Tools\|Options, click the Model tab and check Show Verify Dots. Click OK. Red and green dots are painted at each stream end point. A green dot means that the end is connected. A red dot means that the end is not connected.
Runs	Running items	You can Run selected Items in a Model. Select one or more Items (Click Left or Shift+Click Left or Rect Select) and click the Run button.
	Set breaks	You can set a break at any Composite or Sequence Item. Select one or more Items (Click Left or Shift+Click Left or Rect Select) and click the Break button. When you run the model the run will stop at the break item. Click the Continue Run or Run Step button to continue the run.
	Item run code	You can add Item run code. Select a single Item, right click and Create Item Code. The Item Run_Proc is run instead of the referenced Model's run code.
	Run output	The Run Output window shows Information, Warnings and Errors when a Model is run. Click View\|Run Output or click the Run Output button to show or hide the Run Output window.
	Change output	You can change what is shown in the Run Output window. Click right in the Run Output window and select the type of output desired.
	Execution time	Run output messages continue to be recorded even when the Run Output window is closed. Run execution speed can be increased by not recording messages. Open the Run Output window, click right in the window and select No Messages. Close the Run Output window.
Unit Types	Change dimensional units globally	Click Tools\|Options, click the Unit Types tab to change units globally. New models will default to the global set of units.
Unit Types	Change dimensional units locally	Click right on a blank area of a model, click Properties. Click the Unit Types tab to change dimensional units for a model.
Models	Types of models	There are five different classes (types) of Models: (1) Case, (2) Composite, (3) Connector, (4) Stream and (5) Sequence.
	Case Model	The Case Model class does not have a symbol, it has a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is the only Model you can Run.
	Composite Model	The Composite Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code, and it is Run by another Model. A Composite Model has no specific function. Its function is defined by the developer.
	Connector Model	The Connector Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is never Run. The Connector Model lets you attach Streams.
	Stream Model	The Stream Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it is never Run. The Stream Model transfers data from one Model to another.
	Sequence Model	The Sequence Model class has a symbol, it can have a method consisting of one or more Items, it can have Visual Basic dialogs and code and it can be Run. The Sequence Model Runs a set of Items in a specified order.
Models tree	Re-arrange models	The Project/Model tree lets you rearrange models in a Project. Select a Model and drag it to the new location in the Project. The Model is moved after the highlighted Model.
	Move models	The Project/Model tree lets you move Models from one Project to another. Select a Model and drag and drop it on the new Project name.
	Copy models	The Project/Model tree lets you make copies of Models. Select a Model, hold down the Ctrl key and drag and drop the Model on a Project.
Projects	What is a project	A Project is a collection of one or more Models. A Model is a collection of one or more Items.
	Open Recent Projects	You can open recently opened Projects and Models by clicking Files \| Recent Projects or Files\| Recent Models
	Save projects	Projects are automatically saved when hanged.
	New project	You can add a new Project by clicking File \| New Project. Select the root directory for the new Project and enter the new Project name.
	Sort projects	You can sort the Projects in the project/Model tree. Click right in a blank area of the Project Window and click Sort Projects.
Items	What is an item	Each object in a Model's view is an Item. There are two types of Items: (1) Primitive and (2) Complex. Primitive Items are objects such as lines, polygons, text, etc. Complex Items are Model Items. Model Items refer to and use the services of a Model. One service a Model supplies is the Model's symbol drawing service.
	Item classes	Each class of Model (except the Case Model) has a corresponding Item class: (1) Composite Model and Composite Item, (2) Connector Model and Connector Item, (3) Stream Model and Stream Item and (4) Sequence Model and Sequence Item.
	Adding items	The Project/Model tree is a source for adding an Item to an open Model's view. Select a Model in the Project/Model tree and drag and drop it in the open Model's view.
	Selecting Items	You need to select an item before you can edit the item.
Views	Splitter	The Model View is a splitter view window. Click and drag the vertical sizing bar (at the top of the vertical scroll bar) and/or the horizontal sizing bar (to the left of the horizontal scroll bar) to create up to four separate Model Views.
	Panning	You can Pan the Model View. Point to a blank area in the Model View window, press and hold the left mouse button down (the Pan symbol is shown), move the mouse in the direction of the pan and release the left mouse button when done.
	Aerial View	The Aerial View shows the entire model. An inverted rectangle in the Aerial View shows the location of the Model View. Click View\|Aerial or click the Aerial View button to show or hide the Aerial View window.
	Pan using aerial view	You can pan the Model View by moving the inverted rectangle in the Aerial View. Point to the inverted rectangle (a 4-way cursor is shown), press and hold the left mouse button down and move the inverted rectangle to a new location.
	Page boundaries	The Model View shows page boundaries. Pages are numbered left to right and top to bottom.
	Jump to pages	You can jump the Model View from page to page by clicking View\|Next Page or View\|Previous Page or by clicking the Next Page or Previous Page buttons.
	Working with Bookmarks	You can Bookmark Views of the Model. Bookmarked Views are saved views of the Model. Click right on an Item and click Properties or double click an Item, select the General tab and check the Bookmark checkbox. The current Model View is saved with the Item. The Item is Bookmarked. Note that not all Items can be bookmarked. If there's no Bookmark checkbox on the General Page the Item cannot be bookmarked.
	Sizing handles	You can change the size of Sizing Handles. Click Tools\|Options, click the Model tab and change the Handle Size value. The value is the width/height of Sizing Handles in pixels.
	Show commands	Clicking right on a blank area in the Model View shows commands for the Model. Clicking right on an Item in the Model View selects the Item and shows commands for the Item.