CapFast Command Reference
Table of Contents
1. Align
2. Copy
3. Edit
4. File
5. Get Parts
6. Hierarchy
7. Locate
8. Move
9. Options
10. Properties
11. Redraw
12. Select
13. Text
14. Undo
15. View
16. Wire
17. Zoom
18. Draw Area
19. Pan
20. Esc
This document describes a number of commands for the Capfast schematic editor (Xschedit) that are of interest to both operators and system developers. Those that aren’t of interest to operators will say so.
Most of the numbered, boldfaced headings below are menus. The heading Typical use illustrates what an actual command would be, and look like. Under the heading Example, if there is one, appears further information on what a command might consist of. Some of the bolfaced headings are commands themselves; that is, they do not have sub-menus, but immediately perform a command. The body paragraph will make clear whether it describes one immediate command or a group of commands. The paragraph also describes what the command or commands within the menu do. All commands in this reference are in the format command:subcommand1:subcommand2 . . ., where each command or subcommand represents a menu or submenu, with the command last. Many commands require input from the keyboard: this input appears either in italics or between square brackets [ ].Some commands are more immediate than others; that is, you don’t have to bring up as many submenus to reach it.
Usually, you can bring up the menu or submenus, or execute the command, by middle-clicking (clicking the middle button) the mouse. The white bar at the top of the screen tells the functions of the mouse buttons as they change. What is far easier, however, is to simply press the key of the first letter of the command on the keyboard, though this shortcut does not work in every menu or on every command.
Many commands require that an object (or objects), either a symbol or a wire, be selected before it can perform its function. If a command or a group of related commands require a selected object, the heading Typical use will say so before the command. For more information, see the Select command.
In most cases, this reference only describes the most common operations. This is NOT an exhaustive reference, but a quick aid to those yet unfamiliar with the tool. Please refer to the Capfast Manual for a complete reference on the schematic editor’s functions and capabilities. It can be borrowed from AOT-8. A tutorial for EPICS applications is available on-line.
1. Align
Typical use: Align:Snap grid:[1-256]
Examples: Align:Snap grid:16 or Align:Snap grid:1
The Align:Snap grid command sets the alignment of objects to the nearest specified number of points. (The white grid pips on the screen are 32 points apart.) It positions and lines up objects quickly and precisely. The command prompts the user if the change is to be saved, always answer no (type n). This command is of no use to operators.
2. Copy
Copies selected symbol(s) and/or wire(s).
Typical use: first select the symbol(s) or wire(s), then Copy:Copy with instance properties
The commands under this menu copy selected objects, allowing portions of the schematic to be easily duplicated. The various commands duplicate objects with various levels of information from the master. The most common invocation is Copy with instance properties, which causes the duplicates to inherit all instance-specific information with the exception of the symbol name. This command is of no use to operators.
3. Edit
Erases or changes orientation of selected symbol(s) or wire(s).
Typical use: first select symbol(s) or wire(s), then Edit:Erase
With the commands under the Edit menu, selected symbols and/or wires can be erased, rotated, or mirrored. The most common invocations are Edit:Erase, and Edit:Y-mirror, which flips a symbol along the vertical axis. This command is of no use to operators.
4. File
Performs various operations on files, exits the program, and escapes the operating system.
Typical use: File:Edit schematic
Example: File:Edit schematic:designRoot — edits the schematic designRoot.
The commands in the File menu edit schematics, save them, run selected external programs, and exit the editor. The most common invocations are File:Edit schematic, and File:Write schematic. If the exact name of a schematic in the hierarchy is known, these two commands allow the user to shortcut through the hierarchy and are of general interest to developers and operators.
5. Get Parts
Retrieves a symbol from a library.
Typical use: Get Parts:EPICS library:analog in (small) – gets an EPICS record symbol, in this case, an analog input.
This menu contains a number of libraries from which the user can retrieve a symbol. The schematic editor supports several libraries. Since the editor can be used for many purposes, there are hundreds of symbols available. The designer must choose symbols that are appropriate for the task, since the editor imposes no limitations. Get Parts is of no use to operators.
6. Hierarchy
Moves through the levels of a schematic.
Typical use: first select a symbol, then Hierarchy:Subedit — navigates downward to the sub-schematic within a symbol.
Example: Hierarchy:Return from subedit — moves up one level on the schematic.
The commands in the Hierarchy menu allow movement through a hierarchical design. The most common invocations are Hierarchy:Subedit, which allows movement downward through the hierarchy, and Hierarchy:Return from subedit, which allows movement upward through the hierarchy. The commands in this menu are essential in order for both developers and operators to navigate through large designs.
7. Locate
Locates a symbol or wire.
Typical use: Locate:Symbol:symbolname — finds the specified symbol.
This command locates symbols and wires on a schematic. If found, the symbol or wire is selected. This command does not search through a hierarchy, so its usefulness is limited. In addition, the record names of EPICS symbols and wires are formed in most cases by concatenating the hierarchical path to the local name, so the symbol’s local name and hierarchical name differ. For example, a record named inj:turbo:dnavac will have the local name dnavac on the turbo schematic, a sub-schematic of inj. The Locate menu commands are of general but limited interest to developers and operators.
8. Move
Moves wire(s) and/or symbol(s).
Typical use: first select symbol(s) or wire(s), then Move — moves selected object(s).
This command moves whatever is selected, either a single symbol and/or wire, or a group of symbols and/or wires. If both ends of a wire are included in the selection region, the wire will be moved and its connection broken. If only one end is in the selection region, the connection will be maintained and the wire rerouted automatically, though poorly. Poorly routed wires can be fixed with the Wire:Rewire command. This Move command is of no use to operators.
9. Options
Sets the editor’s options.
Typical use: Options:Library Options:Change current directory: newdirectory — changes current directory to the one specified by user.
The commands in this menu allow the operation of the editor to be modified in many ways. Only experienced users should use them. An important exception is the Library Options command that changes the working directory. While Library Options is generally not necessary for operators, it can be useful to access schematics that are generally not available.
10. Properties
Lists/modifies symbol properties.
Typical use: first select a symbol, then Properties
This command brings up the properties window/editor for the selected symbol. Properties convey symbol specific information, and are used extensively in EPICS and wiring symbols. Examples are the fields of EPICS records, which are implemented as properties in EPICS symbols. Properties are associated with both generic symbol types and individual instances of symbols. Unlike any other command, the property editor can only be exited by pressing the center mouse button. The property information is of interest to both developers and operators in determining the configuration details of EPICS records.
11. Redraw
Updates the editor screen.
Typical use: Redraw
This command forces an update of the editor screen. It is mainly of interest to developers, since the screen clutter it removes is only generated by deleting, inserting, and editing symbols and wires.
12. Select
Selects wire(s) and/or symbol(s).
Typical use: Select:Select items
The Select commands select symbol(s) and/or wire(s) for an operation, such as another command. Most of the schematic editor commands require an object or a set of objects to be selected before they perform the command. If no objects are selected, most commands will show the prompt No object selected. The user can then select objects by middle-clicking the mouse. Typical modes of selection are Select:Select items, which selects objects one at a time by left-clicking on them; Select:Region, which selects all objects within a region defined by the mouse; and Select:Clear selection, which de-selects all selections. The user should also remember to exit the Select menu before performing whatever operation. Exiting the menu will not de-select the object. This command is of limited interest to operators.
13. Text
Adds/edits text.
Typical use: first select a symbol, then Text:Relabel – changes the symbols name.
The commands under this menu add text to wires and symbols, and change the text associated with wires or symbols. The most important use is the Text:Relabel command that renames symbols and wires. The Text commands are of no use to operators.
14. Undo
Undoes the previous command.
Typical use: Undo
This command erases the effect of the last command that was executed, and restores the schematic to its previous state. This command is of general use to both operators and developers.
15. View
Changes the displayed area.
Typical use: View:View area
The View menu commands change the displayed portion of the schematic. Typical uses are View:View area, which allows the user to select an area of the schematic, or View:Center specified point, which centers the display wherever the user middle-click the mouse. The View:View area command zooms in on an area of interest, usually more quickly than the Zoom command. Other View commands split the screen into multiple windows (on the same schematic) and are most useful on large page sizes (D and E size). This command is of general use to both operators and developers.
16. Wire
Creates a wire or bus
Typical use: first place two points where both ends of the wire will connect to (place a point by left-clicking the mouse),then Wire:Wire
The commands in the Wire menu place wires or busses (bundles of wires), on the schematic. Typical uses are Wire:Wire, which places a wire, and Wire:Rewire, which reroutes a selected wire(s). Two or more points placed with the mouse before invoking Wire:Wire will define the wire path. This command is of no interest to operators.
17. Zoom
Magnifies display.
Typical use: Zoom:Zoom in under cursor
The commands in the Zoom menu increase or reduce the scale of the display area. Typically, they zoom into an area of interest. A shortcut for zooming out is the 5 key on the numeric keypad. This key centers the drawing and zooms out far enough so that the entire drawing is visible. The Zoom:Zoom in under cursor command is best executed by keystrokes (z,z). The zoom commands are of general interest to all users.
18. Draw Area
Redraws a portion of the display.
Typical use: Draw Area
This command redraws an area that the user specifies by enclosing the area with a box. It is most useful on large drawings (D and E size) or very cluttered drawings on slower machines. It is of limited interest to operators.
19. Pan
Pans displayed region.
Typical use: press arrow keys on numeric keypad (4=left, 6=right, 8=up, 2=down)
These keyboard commands pan the display in all directions. Diagonal moves are possible with the 1,3,7,and 9 keys. The amount that a single press of the key pans can be set with the Options:Other Options:Viewing options:Pan:newamount command. It is of general interest to all users.
20. Esc
Aborts current command.
Typical use: Escape key (Esc), or Esc
This command cancels the current command and returns the editor to the normal edit mode. The only exception to this is while in the property editor window, which must be exited by clicking the middle mouse button. It is of general use to all users.