Gráficas para el diseño Urbano Autores: Bally Meeda, Neil Parkyn and David Stwart WaltonFull description
Gráficas para el diseño Urbano Autores: Bally Meeda, Neil Parkyn and David Stwart Walton
Ovation - software
Skyrim Ultimate Modding Guide for Graphics from NEXUSMODS.COM
Gas analyzer guidelineFull description
os user guideDescripción completa
Smart Plant User GuideDescription complète
User Guide to the optimization code OptistructFull description
pipesimDescripción completa
rwetrkjhgFull description
VodiaFull description
Wastewater Network Analysis and Design Software Product. SewerGEMS is a fully dynamic, multi-platform, sanitary and combined sewer modeling solution. Engineers can analyze sanitary or combi…Description complète
Descripción completa
C:\AVEVA\Plant\PDMS12.0.SP6\Manuals\Docs
Graphi cs B uil der Use r Guide for Ovatio n 3.3 OW330_90 Version 1 October 2009
What is the Ovation Graphics Builder? ...............................................................................1
2
Planning your gr aphics
2.1 2.2 2.3 2.4
2.9
What is Planning graphics?.................................................................................................3 What is the general graphic philosophy? ............................................................................4 Emerson-supplied graphics.................................................................................................5 What are the main screen displays? ...................................................................................5 2.4.1 What is the menu display? ................................................................................6 2.4.2 What is the overview display .............................................................................6 2.4.3 What is the process control display? .................................................................7 2.4.4 What are the equipment control displays? ........................................................8 2.4.5 What are the control station displays?...............................................................9 What are the Pop-Up control station windows? ..................................................................9 2.5.1 What are Ovation SmartMAs?.........................................................................10 2.5.2 What are enhanced Ovation SmartMA?..........................................................12 2.5.3 What are permissive pop-up displays?............................................................15 What is the Navigation feature? ........................................................................................16 What is determining display layout?..................................................................................17 What is the Display layout format conventions? ...............................................................17 2.8.1 What is the process value display? .................................................................18 2.8.2 What are the text alarm messages?................................................................19 2.8.3 What is selecting graphic symbols? ................................................................19 What is the diagram control strategy?...............................................................................21
3
Getting s tarte d with the Gra phics Builder
3.1
Definitions of terms?.......................................................................................................... 23 3.1.1 What is the outlining rectangle? ......................................................................23 3.1.2 What are the coordinates? ..............................................................................25 What is Licensing? ............................................................................................................30 What are the multi-network considerations? .....................................................................30 What are the rules for entering process point names? .....................................................30 3.4.1 What is a valid point name? ............................................................................30 3.4.2 What are dummy points (unresolved points)? .................................................32 3.4.3 What are the valid pointers?............................................................................32 3.4.4 What are the record fields? .............................................................................36 3.4.5 What are OPC points?..................................................................................... 37
2.5
2.6 2.7 2.8
3.2 3.3 3.4
1
3
23
3.5
What are the differences between the online and offline Graphics Builder? ....................38 3.5.1 When does the Graphics Builder communicate with the database? ...............39 3.5.2 When does the Graphics Builder Browse the OPC servers?..........................39 3.5.3 When does the Graphics Builder create a new graphic? ................................39 3.5.4 What is the Open function? .............................................................................40
OW330_90
i
Table of Contents
3.6
3.7
3.8
3.7.2 What are the Graphics Builder toolbars? ........................................................51 3.7.3 What is Error handling? ...................................................................................59 What are the Keyboard shortcuts for the Graphics Builder?.............................................60
4
Using th e View menu
4.1 4.2
What items are available on the View menu? ...................................................................64 What is the diagram Configuration window?.....................................................................65 4.2.1 Diagram configuration window fields ...............................................................66 4.2.2 To set or change the Diagram Configuration parameters ...............................67 What is the integrated source editor? ...............................................................................68 What is the generic text editor?.........................................................................................69 4.4.1 TextEdit differences......................................................................................... 70 4.4.2 To open TextEdit files ......................................................................................71 4.4.3 To save TextEdit files ......................................................................................71 4.4.4 To print a TextEdit file...................................................................................... 72 4.4.5 When do you compile a TextEdit files? ...........................................................73 4.4.6 Navigating through TextEdit files.....................................................................73 What is the Shape Library? ...............................................................................................75 What is the Zoom menu? ..................................................................................................75 4.6.1 To use Zoom by Corners.................................................................................76 4.6.2 To use Zoom by Box .......................................................................................76 4.6.3 To use Zoom In................................................................................................ 77 4.6.4 To use Zoom Out............................................................................................. 77 4.6.5 To use the Zoom In/Out Factor .......................................................................77 4.6.6 To use Recall................................................................................................... 77 4.6.7 To use Define Area.......................................................................................... 77 4.6.8 To use Zoom to Area.......................................................................................78 To use Keyboard Repaint Order .......................................................................................78 To use Handle/Drag Color................................................................................................. 79 To use Coordinate Display ................................................................................................79 What is a Grid?.................................................................................................................. 80 4.10.1 To display and define a grid ............................................................................80 4.10.2 What is a Snap? ..............................................................................................82 What is the Save Defaults function? .................................................................................82
4.3 4.4
4.5 4.6
4.7 4.8 4.9 4.10
4.11 4.12 4.13
ii
3.5.5 What is the Compile function?.........................................................................41 3.5.6 What is the Saving function? ...........................................................................42 Variables............................................................................................................................ 43 3.6.1 Naming Variables ............................................................................................43 3.6.2 To open the Variables dialog...........................................................................45 3.6.3 To add a new local or global variable..............................................................46 3.6.4 To Delete a Variable........................................................................................47 3.6.5 To Expose a Variable ......................................................................................47 3.6.6 To Increase the size of a Variable...................................................................47 3.6.7 To use the SET_VARIABLE command ...........................................................47 What is the main Graphics Builder window?.....................................................................49 3.7.1 What is the in pull-down menu panel? ............................................................50
63
4.11.1 UseBrowser?...............................................................................................83 the Save Defaults function..................................................................82 What is theTo Point 4.12.1 To use the Point Browser dialog (Filters tab) ..................................................83 What is browsing for OPC points? ....................................................................................84 4.13.1 To choose an OPC server to browse ..............................................................85
OW330_90
Table of Contents
5
Using the Options menu
5.1 5.2 5.3 5.4
What items are available on the Options menu? ..............................................................87 To use the Resize Aspect Ratio function ..........................................................................88 To use the Resize Pin Point function ................................................................................88 What is the Resize-by-Factors (Scale Factors) function?.................................................88 5.4.1 To use the Resize-by-Factors function............................................................88 What is the Drag/Draw Constraint?...................................................................................89 5.5.1 To Use Drag/Draw Constraint .........................................................................89 What is the Multi-draw mode?...........................................................................................90
5.5 5.6 5.7
87
5.8 5.9 5.10 5.11 5.12 5.13
What do unresolved points do?.........................................................................................90 5.7.1 To display Unresolved Points ..........................................................................90 5.7.2 To set an Unresolved Points Warning.............................................................91 What does AutoSave do?.................................................................................................. 92 To set AutoSave Frequency..............................................................................................92 What is Conditional Word Wrap? ......................................................................................92 What is the Macro Notes/Param Information menu? ........................................................93 To set Undefined Description Warnings............................................................................93 Option for Highlighting Selection in Tab Controls .............................................................94
6
Loading, saving, a nd comp iling gr aphics and graphics im ages
6.1 6.2 6.3
What options are available on the File menu? ..................................................................95 To displaying a new graphic (Offline)................................................................................95 What is the the Open window function?............................................................................96 6.3.1 To Open (offline) or Reload (online) an existing graphic.................................96
6.4
6.8
What is the purpose of the Save or Save As function?.....................................................97 6.4.1 To use the Save or Save As functions ............................................................97 What is the Print function? ................................................................................................99 6.5.1 What is the Print Preview window? .................................................................99 6.5.2 What is the Print Setup window?.....................................................................99 To restore the srcinal diagram ....................................................................................... 100 What is the purpose of compiling graphics (Offline)?......................................................100 6.7.1 Batch Compile Options dialog .......................................................................101 6.7.2 To Compile graphics (Offline)........................................................................107 6.7.3 What is the Compilation Output dialog? ........................................................108 6.7.4 What are image files?....................................................................................108 What is the Exit function in the Graphics Builder? ..........................................................109
7
Setting drawing attribu tes
7.1 7.2
What items are on the Drawing Attributes toolbar?.........................................................111 What is the Place function?.............................................................................................112
7.3
What is the Color dialog? ................................................................................................114 7.3.1 To set Color ...................................................................................................115 7.3.2 To use the Hide ER/Show ER button and Hide OL/Show OL button............117 7.3.3 To use the $COLORn display values dialog .................................................117 7.3.4 To use the $OL_COLORn display values dialog...........................................118
6.5
6.6 6.7
OW330_90
95
111
iii
Table of Contents
7.4
7.8
What is the Font Attributes dialog? .................................................................................120 7.4.1 To use Bitmap and Bitmap_Over text............................................................ 121 7.4.2 To use Vector and Vector_over text ..............................................................122 7.4.3 To use the Ovation Vector Font..................................................................... 123 What is the Fill Pattern dialog?........................................................................................124 7.5.1 To set Fill Pattern attributes...........................................................................125 What is the Line Patterns dialog?.................................................................................... 126 7.6.1 To Set Line Patterns......................................................................................126 What is the Line Width dialog?........................................................................................127 7.7.1 To Set Line Width ..........................................................................................128 To Set Blink .....................................................................................................................128
8
Drawing graphic Items
8.1
What items are valid in the Background, Foreground, Trigger and Macro Trigger sections? 132 What Draw Items are Valid in the Keyboard Section? ....................................................133 What are the simple draw items?....................................................................................134 8.3.1 To Draw an Arc.............................................................................................. 134 8.3.2 To Draw a Rubberband Arc...........................................................................134 8.3.3 To Draw a Line ..............................................................................................135 8.3.4 To Draw a Rubberband Line .........................................................................135 8.3.5 To Draw a Circle ............................................................................................135 8.3.6 To Draw an Ellipse......................................................................................... 136 8.3.7 To Draw a Polygon ........................................................................................136 8.3.8 To Draw a Rectangle.....................................................................................136 8.3.9 To Draw a Dot................................................................................................ 137 What is the Bar icon? ......................................................................................................137 8.4.1 To Draw a Bar................................................................................................ 137
7.5 7.6 7.7
8.2 8.3
8.4 8.5 8.6
8.7 8.8 8.9 8.10
8.11 8.12
iv
131
What is the Bitmap Image icon?...................................................................................... 139 8.5.1 To name a Bitmap file.................................................................................... 139 8.5.2 To Add a Bitmap Image to a Graphic ............................................................139 What Is the Button icon? .................................................................................................140 8.6.1 Button features ..............................................................................................141 8.6.2 Button attributes............................................................................................. 141 8.6.3 Button dialog features.................................................................................... 142 8.6.4 To create a Button .........................................................................................142 What is the Date icon? ....................................................................................................154 8.7.1 To Display the Date on a Diagram ................................................................154 What is the Dynamic Line/Polygon icon?........................................................................155 8.8.1 To Draw a Dynamic Line/Polygon .................................................................155 What is the Entry Field icon?........................................................................................... 157 8.9.1 To Create an Entry Field ...............................................................................157 What is the Function Key Command?.............................................................................159 8.10.1 To create a Function Key ..............................................................................159 8.10.2 To Modify Function Key Scrolling List Entries ...............................................161 What is the OL Button icon?............................................................................................ 161 8.11.1 To create an OL Button .................................................................................162 What is the PolyBar icon? ...............................................................................................164 8.12.1 To Draw a PolyBar......................................................................................... 165
What is the OL Check Box icon?..................................................................................... 166 8.13.1 To create an OL Check Box ..........................................................................166 What is the OL Choice icon?...........................................................................................169 8.14.1 To create an OL Choice item......................................................................... 169 What is the OL Cylinder icon?.........................................................................................172 8.15.1 To Draw an OL Cylinder ................................................................................172 What is the OL Event Menu icon?...................................................................................173 8.16.1 To create an OL Event Menu ........................................................................173 What is the OL Gauge icon? ...........................................................................................175 8.17.1 To Draw an OL Gauge ..................................................................................175 What is the OL Rectangle icon?......................................................................................176 8.18.1 To Draw an OL Rectangle .............................................................................176 What is the OL Slider icon?.............................................................................................177 8.19.1 To Create an OL Slider.................................................................................. 177 What is the Page command icon?................................................................................... 179 8.20.1 To create a Page ...........................................................................................179 What is the Plot icon?...................................................................................................... 179 8.21.1 To Draw a Plot ...............................................................................................179 What is the Point Group Text icon?................................................................................. 182 8.22.1 To Display Pont Group Text String................................................................182 What is the Poke Field icon?...........................................................................................183 8.23.1 To create a Poke Field ..................................................................................183 What is the Process Point button? ..................................................................................190 8.24.1 To Display a Process Point on a Diagram.....................................................190 What is the Shape button? ..............................................................................................193 8.25.1 To Add a Shape to a Diagram .......................................................................193 What is the Text button? .................................................................................................194 8.26.1 To use the Single Text Option .......................................................................195 8.26.2 To use use the the Text Multiple Text Option Option.....................................................................196 8.26.3 To Groups .....................................................................197 What is the Time button? ................................................................................................198 8.27.1 To Display Time on a Diagram ......................................................................198 What is the Trend button? ...............................................................................................199 8.28.1 To Draw a Trend............................................................................................ 199 What is the XY Plot button? ............................................................................................201 8.29.1 To Draw an XY Plot .......................................................................................201
9
Unde rstanding Macros
9.1
What are Macros? ...........................................................................................................205 9.1.1 What are the general rules for naming macros? ...........................................205 9.1.2 Macro Rules................................................................................................... 206 9.1.3 What is the process for inverting and rotating Macros? ................................208 What are the macro diagram tagout (substitution) parameters?.....................................209 9.2.1 What are the process point parameter ($Dn) substitutions? .........................209 9.2.2 What are the text string parameter ($Tn) substitutions? ...............................210
9.2
205
9.2.3 What are the set number parameter ($SET) substitutions?..........................210 9.2.4 What are the integer/real constant ($CONSTn) substitutions? .....................211 9.2.5 What are the status word parameter ($STATUSn) substitution? ..................212 9.2.6 What are the color parameter ($COLORn) & OL color parameter ($OL_COLORn) substitution? .........................................................................................212
OW330_90
v
Table of Contents
9.3
9.7 9.8
What is the purpose of the Macro Notes and Parameter Info dialog? ............................213 9.3.1 To Use the Macro Notes & Parameters Info Option......................................213 Specifying Default Values for Macro Point Parameters using a %s% substitution string216 9.4.1 Rules for Using ‘%s%’ substitution strings in $Dn default values .................218 9.4.2 Properties shown on the GBNT:Macro window for a Macro Defined Using ‘%s%’ default values .......................................................................................................219 What is the Macro Dialog? ..............................................................................................219 9.5.1 To Create a Macro Graphic ...........................................................................220 9.5.2 To access a Macro Graphic........................................................................... 221 9.5.3 To Add Parameter Values to the Macro Dialog.............................................222 9.5.4 To Edit a Macro File....................................................................................... 224 9.5.5 To Change an Instance of a Macro on a Parent Graphic..............................224 9.5.6 To Display Macro Notes ................................................................................225 What is an invalid parameters count error? ....................................................................225 9.6.1 To repair a macro with an invalid parameters count .....................................226 9.6.2 What is Saving a graphic containing macros with an invalid parameter count? 227 9.6.3 Editing a graphic containing macros with invalid parameter counts..............228 Local macro_triggers....................................................................................................... 229 Local Macro Entry Fields.................................................................................................230
10
Editing Graphics
10.1
What are the ways to working with selected items and groups? ....................................231 10.1.1 To Select and Deselect Items........................................................................ 231 10.1.2 To Select Overlaid Items ...............................................................................232 10.1.3 Ability to Temporarily Hide Items...................................................................233 10.1.4 To Group and Ungroup Items........................................................................235 10.1.5 Retain grouping outside GB edit session ......................................................236 10.1.6 To Move an Item or Group ............................................................................237 10.1.7 To Resize an Item or Group ..........................................................................238 10.1.8 To Resize an Item or Group by a Factor .......................................................239 10.1.9 Resize by ItemN Relative to another Graphic Object ....................................240 10.1.10 What is the Rotation Increment window? ......................................................242 10.1.11 To Delete Items and Groups .........................................................................243 10.1.12 What is Copying and Pasting items and groups?..........................................243 What are the Editing Attributes?...................................................................................... 245 10.2.1 To Display Attributes and Parameters for Editing .........................................245 10.2.2 To Change Attributes..................................................................................... 245 Editing Vertices?.............................................................................................................. 246 10.3.1 To Enter Vertex Edit Mode ............................................................................246 10.3.2 Selecting a new Item for Vertex Edit .............................................................248 10.3.3 Selecting a Target Item for Vertex Edit..........................................................249 10.3.4 Selecting a new Target Item..........................................................................250 10.3.5 To Move a Vertex ..........................................................................................250 10.3.6 To Add a Vertex............................................................................................. 250 10.3.7 To Delete a Vertex......................................................................................... 252 10.3.8 To Align the X Coordinates of a Vertex .........................................................253 10.3.9 To Align the Y Coordinates of a Vertex .........................................................253 10.3.10 To Snap One Vertex to Another ....................................................................253 10.3.11 To Force Horizontal/Vertical Movement of Vertices......................................254 10.3.12 To Undo the Last Edit in Vertex Edit Mode ...................................................254 10.3.13 To Exit Vertex Edit Mode...............................................................................254
9.4
9.5
9.6
10.2
10.3
vi
231
OW330_90
Table of Contents
10.4 10.5 10.6
10.7
To Use the Snap to Grid Option......................................................................................255 To Undo and Redo the Last Edit .....................................................................................255 What are the Aligning and Equi-Spacing functions? .......................................................256 10.6.1 To Align Using Center (x and y) ....................................................................257 10.6.2 To Align Using Center (x only).......................................................................259 10.6.3 To Align Using Left Justification ....................................................................261 10.6.4 To Align Using Right Justification ..................................................................263 10.6.5 To Align Using Center (y only).......................................................................265 10.6.6 To Align Using Top Justification ....................................................................267 10.6.7 To Align Using Bottom Justification...............................................................269 10.6.8 To Align Using Align Origin X ........................................................................270 10.6.9 To Align Using Align Origin Y ........................................................................271 10.6.10 To set Horizontal Spacing .............................................................................271 10.6.11 To set Vertical Spacing.................................................................................. 273 What is Object-to-object Snap?....................................................................................... 275 10.7.1 To Snap One Object to Another ....................................................................276 10.7.2 To Undo the Last Edit in Object Snap Mode .................................................276 10.7.3 To Exit Object Snap Mode............................................................................. 276
What is a Shape? ............................................................................................................278 What is the Shape Library file? .......................................................................................279 What are the rules for shape names? .............................................................................280 What is the Shape button? ..............................................................................................281 What is the Shape Library Editor GUI ? ..........................................................................282 Rules for Shape Category/Tab Labels ............................................................................282 To Accessing the Shape Category/Tab Labels...............................................................282 To Select Shapes on the Shape Library Editor Window: ................................................283 To Move Existing Shapes from One Tab into Another Tab ............................................284 To Copy Existing Shapes from One Tab into Another Tab .............................................284 To Remove Shapes from a Tab ......................................................................................284 To Create a New Shape in the System Shape Library ...................................................285 To Modify an Existing Shape in the System Shape Library ............................................287 To Delete an Existing Shape from the System Shape Library ........................................289 To Change the Origin on an Existing Shape in the System Shape Library ....................289 What is the Default Retain Color Setting?.......................................................................290 What is the Auto Hide/Restore On Modify check mark menu item? ...............................291 To Set Origin Color menu item........................................................................................291 To create Shapes ............................................................................................................291 What is Inverting and Rotating Shapes in the Graphics Builder? ...................................294 11.20.1 To Invert and Rotate Shapes......................................................................... 295 11.20.2 What are the shape rotation restrictions?......................................................295 To Edit (Modify) Shapes.................................................................................................. 295
11.21
11.21.1 11.21.2
OW330_90
277
To Change Renamethe a Shape To Origin.....................................................................................296 of a Shape..................................................................296
vii
Table of Contents
11.22
To Delete Shapes............................................................................................................ 297
12
Using the Integrated Source Editor
12.1 12.2
What is the Integrated Source Editor? ............................................................................299 What are the Integrated Source Editor Interfaces?.........................................................300 12.2.1 What are the Toolbar functions? ...................................................................300 12.2.2 Pull-Down Menus........................................................................................... 301 12.2.3 What are the keyboard shortcuts for the Integrated Source Editor functions? 302 12.2.4 To display the Command Syntax for graphics language commands?..........303
12.3 12.4 12.5
What and lines and commands?..................................................305 What is is selecting the current linecompiling and the current command? .......................................................306 What are the commands used to create and edit a window? .........................................306 12.5.1 To Add Commands — Before .......................................................................306 12.5.2 To Add Commands — After ..........................................................................307 12.5.3 To Add Lines within a Command — Before ..................................................307 12.5.4 To Add Lines within a Command — After .....................................................308 12.5.5 To Edit Commands........................................................................................ 308 12.5.6 To Define Blocks of Commands....................................................................308 12.5.7 To Delete Commands.................................................................................... 309 12.5.8 To Delete Lines within a Command...............................................................309 12.5.9 To Delete Characters ....................................................................................309 12.5.10 To Delete Blocks of Commands....................................................................309 12.5.11 To Undo the Last Edit....................................................................................310 12.5.12 To Comment/Uncomment Commands..........................................................310 What are the commands used to move text?..................................................................310 12.6.1 To Move Commands — Before.....................................................................310 12.6.2 To Move Commands — After ........................................................................311 12.6.3 To Move Blocks — Before.............................................................................311 12.6.4 To Move Blocks — After................................................................................311 What are the commands used to copy text?...................................................................311 12.7.1 To Copy Commands — Before .....................................................................311 12.7.2 To Copy Commands — After ........................................................................312 12.7.3 To Copy Blocks — Before .............................................................................312 12.7.4 To Copy Blocks — After ................................................................................312 What are the source file print options?............................................................................313 Navigating through the Source Editor File ......................................................................313 12.9.1 To Use the Goto Line # Function...................................................................313 12.9.2 What is the Find/Replace function?...............................................................314
12.6
12.7
12.8 12.9
13
Custom Files
13.1 13.2 13.3 13.4
What are the commands used to define custom files? ...................................................317 What are the commands used to edit the custom colors file? ........................................317 What are the commands used to editing the custom font sizes file? ..............................318 What are the commands used to edit the custom fill patterns file?.................................318
13.5
viii
299
317
13.4.1 To Edit fill_patterns.txt ...................................................................................319 What are the commands used to create custom line patterns? ......................................320 13.5.1 To Insert a new Line Pattern .........................................................................321 13.5.2 To modify a Line Pattern ...............................................................................323 13.5.3 To Delete a Line Pattern (Using the Graphics Builder) .................................323
OW330_90
Table of Contents
13.6
13.5.4 To Exit Custom Line Pattern Edit Mode ........................................................323 What are the commands used to create custom diagram background bitmaps? ...........324
14
Importing and Exporting Graphics
14.1
What is the Import Graphics Function?...........................................................................325 14.1.1 What are the required files for the Import Graphics function?.......................326 14.1.2 What are the overwrite choices for the Import Graphics function? ...............327 14.1.3 To Access the Import Graphics Window .......................................................327 14.1.4 To Import All or Part of a Graphics System...................................................328 What is the Export Graphics Function?...........................................................................330 14.2.1 To Use the Export Graphics Function ...........................................................330
14.2
Index
OW330_90
325
333
ix
S
ECTION
1
Introd uction to th e Ovation Graphics Build er
IN THIS SECTION What is the Ovation Graphics Builder? ............................................................................... 1
1. 1
Wha t is the Ova tion Gra phic s Builder? The Ovation Graphics Builder (GB) resides on the Ovation Developer Studio and is used to develop the process diagrams that are displayed in the Graphics Display System on the Ovation Operator Station. These process diagrams are software programs which display graphical images that represent actual plant process control equipment. Two diagram files (source and object) are created and edited within the Graphics Builder. The source (.src) format is a readable ASCII representation of the diagram which adheres to the syntax of the graphics language. The object (.diag) format is the corresponding “executable” diagram file that is displayed at the Ovation Operator Station. The Graphics Builder can be run online from within the Ovation Developer Studio, or it can be run offline as a standalone program. The Graphics Builder only communicates with the database when it is running online; thus, all point names are interpreted as unresolved points (see page 90) when running offline. If working offline, an import utility (see page 325) is used to import/merge graphics, macros, bitmap files, shapes, custom colors, custom line patterns, and custom fill patterns into the manual Ovation show Developer Studio environment. purposes of clarity and simplicity, the examples in this the offline Graphics BuilderFor program. Note: Do NOT use the database import function (OvPtImport) if the Graphics Builder is in use anywhere in the system. This could result in system disruption. If a disruption should accidentally occur, you must correct the disruption. (See Ovation Database User Guide.)
OW330_90
1
S
ECTION
2
Planning your g raphics
IN THIS SECTION What is Planning graphics?................................................................................................. 3 What is the generalgraphics................................................................................................. graphic philosophy? ............................................................................ 4 Emerson-supplied 5 What are the main screen displays? ................................................................................... 5 What are the Pop-Up control station windows? .................................................................. 9 What is the Navigation feature? ........................................................................................ 16 What is determining display layout?.................................................................................. 17 What is the Display layout format conventions? ...............................................................17 What is the diagram control strategy?............................................................................... 21
2. 1
Wha t is Pla nning graphics
?
Before using the Graphics Builder to create process graphics, you should understand the Emerson philosophy of building graphics, what graphics are included in your purchase of an Ovation system, and what standards are used in developing quality diagrams. Emerson Process Management offers quality graphics based on predefined standards that pinpoint alarm areas precisely and provide efficient control of plant equipment. Our goal is to help your plant operators understand the process through displays that accurately reflect the plant configuration. Emerson makes the process of designing and implementing graphics simple and efficient by using predefined standards to provide a baseline for creating quality process graphics. These standards, developed from years of graphic design experience by Emerson, provide guidelines for converting plant equipment configurations into graphical displays. Utilization of standards reduces design and implementation time and creates a common presentation of system displays.
OW330_90
3
2.2 What is the general graphic philosophy?
2. 2
Wha t is the general
graphic
philo sophy ?
The basis for creating Ovation standard graphics is derived from guidelines for diagram types, static and dynamic graphic information, control strategy and diagram navigation. All of these factors are considered when creating plant process diagrams. The graphics are developed based upon user-provided information contained in functional descriptions, sketches and P&ID representations. To effectively generate graphic displays for process control, users and Emerson engineers work together to address the following topics:
4
Hierarchical Structu re — The Ovation hierarchical structure of graphics provides a logical structure overview of plant operations. Users can navigate from top-level menus to graphics depicting major systems, then to supporting subsystems and then to plant equipment displays. Paging Criterion — Outlines navigation paths as part of the hierarchical structure for convenient access to various graphical displays. Display Types — There are three types of diagram displays: Main Screen displays, Subscreen displays, and Pop-up displays.
Main Screen displays — Main Screen diagrams display process control information at a unit/system/subsystem level. The number of main screen diagram that you receive for your plant is determined by the plant configuration and the I/O count. Main Screen displays are represented on the CRT as four windows on single-CRT workstations (W1 through W4) and as eight windows on dual-CRT workstations (W1 through W8).
Subscreen displays — displays a subwindow. On the Windows platform, subscreens are displayed within the main window in a split screen format. You can configure the subscreen to be displayed at the bottom portion of the main screen. The initial width of the subscreen corresponds to the width of the main screen. The initial height is a fixed 100 pixels. You have the ability to resize the width and height of the subscreen once displayed, but the aspect ratio of the diagram remains.
Pop-Up displays — These displays are smaller, fixed-size windows that appear on top of main screen displays. A main screen display can have only one pop-up diagram displayed at a time. To avoid hiding information, the pop-up display can be moved anywhere on the main screen display. Pop-up displays are typically used to control a specific device such as Manual/Auto Control Stations or Digital Start/Stop/Open/Close Stations, but can also be used for permissive information and/or help.
Display Layouts — Defines common elements such as title location, diagram header, and diagram footer, included on every diagram to maintain consistency.
Display Format Conve ntions — Defines a set of rules that provides definition for configuration purposes of the different objects to be used in the process displays
Building Blocks — Provides graphical representation of specific equipment selected from a standard library to ensure uniform depiction of plant elements, such as pipes, valves, and so forth.
OW330_90
2.3 Emerson-supplied graphics
2. 3
Eme rson -supplied
graphics
Emerson-supplied graphics Q UANTITY P E R O PERATOR S TATION
2. 4
D ESCRIPTION
1
Set of Alarm Displays including: Alarm List Alarm History Unacknowledged Alarm List
1
Set of Diagnostic Displays including: System Overview Controller Diagnostics Drop Status Network Error Summary
4
Set of Trend Displays including: XY Plots (8 points/trend) Trends (8 points/trend) Tabular Trends
1
Set of Miscellaneous Displays including: Point Review Screen Historical Point Review (if Historian is purchased)
What are the main scr ee n dis plays ? Main Screen diagrams display process control information at a unit/system/subsystem level. The number of main screen diagram that you receive for your plant is determined by the plant configuration and the I/O count. A maximum of eight Main Screen diagrams can be displayed on a single CRT workstation (W1 through W8). If you have dual CRTs, diagrams can be dragged from one workstation to another. Each display can be resized to fill the screen of the Operator Workstation. A Main Screen diagram can have only one pop-up diagram displayed at a given time. The following types of Main Screen displays are discussed:
Menu displays (see page 6)
Overview displays (see page 6)
Process Control displays (see page 7)
Equipment Control displays (see page 8)
Control Station displays (see page 9)
OW330_90
5
2.4 What are the main screen displays?
2.4.1 What is the menu displ ay? Menu displays show the hierarchical organization and structure of all displays. Menu displays have no functional use other than to provide links to other displays. You navigate to other screens by selecting a specific block.
Figure 1: Me nu d isplay
2.4.2 What is the overv iew dis play Overview displays provide broad views of one or more system processes. Displays included in this category are Plant Overviews and Process Overviews.
Plant Overviews -- provide general information about all of the plant processes, allowing the operator to navigate to subsystem overview displays. They do not contain control capability.
Process Overviews -- provide a subsystem-level view with con trol functions and status indication.
To illustrate how these two types of overviews are related, you typically purchase a Plant Overview diagram. From that diagram, there are subsets of overview diagrams that depict a particular process (examples may include a Feedwater Overview diagram or a Mill Overview diagram). Fromas a particular Overview diagram, another subset of diagrams can be accessed such those thatProcess may show an individual pump on the Feedwater diagram.
6
OW330_90
2.4 What are the main screen displays?
2.4.3 Wha t is the process control displ
ay?
The Process Control display provides a representation of the piping and equipment in a process system, similar to a P&ID (piping and instrumentation drawing). These displays use static and dynamic text, dynamic values, and color changes to indicate the condition and status of the process equipment. Process Control displays can range from simplified representations of one or more processes that monitor equipment to detailed process or equipment representations that provide single-device monitoring and control. Features of a standard Process Control display include lines, text, standard symbols, shapes, macros, colors, and conditionals that illustrate the condition and status of the process, pumps, valves, and so forth. A maximum of 50 point value updates or attribute connections is recommended per display. From a Process Control display, you should be able to access information on a particular piece of equipment. This information is typically shown on an Equipment Control Display.
Figure 2 : Process control d isplay
OW330_90
7
2.4 What are the main screen displays?
2.4.4 Wha t are the equipment control disp
lays?
Equipment Control displays typically show a detailed view of a major equipment component, such as a Boiler Feed Pump, including all of its auxiliaries — pump, motor, cooling water, lube oil pressures temperatures, bearing temperatures, and so forth. As a subset of Process Control displays, Equipment Control displays follow the same guidelines. Features of a standard Equipment Control display include lines, text, standard symbols, shapes, macros, colors, and conditionals that illustrate the condition and status of the process, pumps, valves, and so forth. A maximum of 50 point value updates or attribute connections is recommended per display.
Figure 3 : Equipment control
8
displays
OW330_90
2.5 What are the Pop-Up control station windows?
2.4.5 Wha t are the contro l station displays? A Control Station display provides groups of Manual/Automatic control stations on one display. The standard SmartMA control stations are utilized as the basis for all control stations. Up to eight M/A stations can be included on one display. Control of a station requires a two-step process: first the operator selects the desired individual station for control, and then clicks on the control function desired.
Figure 4 : Control station dis plays
2. 5
Wha t are the Pop-U p contr ol station
wind ows?
Pop-up displays are smaller, fixed-size diagrams that are displayed on top of main screen displays. A Main Screen display can show only one associated pop-up display at a time. To avoid hiding information, the Pop-up display can be moved anywhere on the Main Screen display. Pop-up displays are typically used to control a specific device such as Manual/Auto Control Stations or Digital Start/Stop/Open/Close Stations, but can also be used for permissive information and/or help. Types of Pop-up diagrams include:
Ovation SmartMA displays (see page 10) Enhanced Ovation SmartMA displays (see page 12)
Diagnostic/Permissive displays (see page 15)
OW330_90
9
2.5 What are the Pop-Up control station windows?
2.5.1 What are Ovation SmartMAs? Ovation SmartMAs are standard analog or digital graphical user interfaces that provide a simple method to control processes. SmartMAs are pop-up control station windows that are about an eighth of the size of main process control screen displays so the windows do not obscure important information. When displayed, pop-up windows cannot be resized, but may be moved. Using these displays for control requires a two-step process: 1. Select a device block on the Process Control display. 2. Select a control function from the pop-up display. For example, to display two- and three- transmitter select control stations, the operator selects a SEL block that is located adjacent to the process variable value. Pop-up displays are used for Manual/Automatic and Start/Stop/Open/Close stations, showing information such as control mode, device status and process values. Organization of similar control stations into one area can also emulate the grouping of a hard panel, thus placing a physical hardware arrangement directly onto a display monitor. Typically, a control station diagram consists of up to eight single control stations, but pop-up windows may also contain multiple control stations. What are S martMA com mon areas? Standard Ovation SmartMAs are made up of several common areas. Each area is designated to provide either status information, monitoring information, or control information. The four standard SmartMA areas are listed below:
Title Box — Contains up to three li nes of text with 11 characters each, which define the station type. The background color is lightcyan3 and the text is black.
Bar bar Texttext, — process Providesvalues a 12-character description of the value displayed. the will display the top and bottom of being the bar value. In addition to
Control Selection — A two-step process provides control for a grouped series of Control Stations. First the user selects the title box of the desired Control Station. The outline of the selected station is indicated by a color change from gray to red.
Button Selection — Operable control buttons appear bla ck, while disabled buttons appear gray. Errors on raising or lowering setpoint, output, bias or demands are shown in red.
On a pop-up window Control Station, the window is displayed by selecting the device on the main diagram. The outline of the window appears red to indicate that control is active and the user is able to use any of the appropriate buttons for control. Emerson uses the following colors (see page 11) as standards for Analog Stations and Analog Feedbacks. However, you may discuss different color choices with an Emerson representative. Digital entry selections, included as part of the control stations, vary depending upon the station selected. Digital entry fields include digitally entered setpoint (DE), digitally entered output (DEO), digitally entered bias (DEB) and digitally entered ratio (DER). Emerson uses the following colors (see page 11) as standards for digital entry fields. However, you may discuss different color choices with an Emerson representative.
10
OW330_90
2.5 What are the Pop-Up control station windows? SmartMA common elements - analog Analo g stat io ns F EEDBACK
C OLOR
Process Bar/Value
Green
Setpoint Bar/Value
White
Output Bar/Value
Cyan
Demand Bar/Value
Darkseagreen1
Bias Bar/Value
Yellow
Analo g f eedb ack s F EEDBACK
F G C OLOR / B G C OLOR
Default/Timed Out
Magenta/Magenta
Tracking
Black/Yellow
Manual
White/Red
Auto
White/Blue2
Local
White/Orchid4
1 or 3 Element
Black/Yellow
PLW (Priority Lower)
White/DarkOrange2
PRA (Priority Raise)
White/DarkOrange2
RLI (Raise Lower Inhibit)
White/DarkOrange2
LWI (Lower Inhibit) RAI (Raise Inhibit)
White/DarkOrange2 White/DarkOrange2
B (Bias)
White/DarkOrange2
MRE (Manual Reject)
White/DarkOrange2
ARE (Auto Reject)
White/DarkOrange2
SmartMA common elements - digital Digital stations F EEDBACK
F G C OLOR / B G C OLOR
Default
Gray50/Gray50
Tag Out
Black/Yellow
Stopped Running
Black/Green White/Red
Auto
White/Blue
OW330_90
11
2.5 What are the Pop-Up control station windows?
F EEDBACK
F G C OLOR / B G C OLOR
Manual
White/Red
Stop Trip
White/DarkOrange2
Start Trip
White/DarkOrange2
Not Ready
White/DarkOrange2
Auto Stop
White/DarkOrange2
Auto Start
White/DarkOrange2
Power Failure
White/DarkOrange2
Running Trip
White/DarkOrange2
2.5.2 What are enhanced Ova tio n SmartMA? As an option, you may choose to upgrade from SmartMA to Enhanced SmartMA. There are some major differences between the SmartMA and the Enhanced SmartMA control stations:
12
The Alarm Acknowledge (Acknowledge icon) and the Trend (Trend icon) features require matching of specific value parameters and already built trend windows.
The emulated pushbutton feature is a mimic of a button “push” with indentation to indicate that an analog ramp is in effect.
In Enhanced SmartMA, the size of analog and digital control stations is the same.
OW330_90
2.5 What are the Pop-Up control station windows? What are enhanced SmartMA common areas? Standard Ovation Enhanced SmartMAs are made up of several common areas. Each area is designated to provide either status information, monitoring information or control information. Five standard Enhanced SmartMA areas are: Title box: Defines the station type and contains up to two lines of text with 19 characters allowed for each line. Bar text: Provides a 12-character description of the value being displayed. In addition to the bar text, process values will display the top and bottom limits of the bar value. Control selection: A two-step process provides control for a grouped series of Control Stations. First, the user selects the title box of the desired Control Station. The outline of the selected station is indicated by a color change from gray to red . Then you are able to use any of the appropriate buttons to control the station. On a pop-up window control station, control is activated by selection of the station through a poke field from the main diagram. After the station has been selected, you are able to use any of the appropriate buttons for control. Button selection: Operable control buttons appear in black , while disabled buttons appear in gray . Errors on raising or lowering setpoint, output, bias or demand are shown in red . Icon selection: Two icons appear in the title section of the macro — a trend icon for selection of a pop-up trend window, and an alarm icon for indication and acknowledgement. If the macro is used in a control window and the trend icon is poked, a new window will be displayed. The new trend window contains a black icon to return to the srcinal window so that the operator can continue with the control functions. Emerson uses the following colors (see page 13) as standards for Analog Stations and Analog Feedbacks. However, you may discuss different color choices with an Emerson representative. Digital entry selections, included as part of the control stations, vary depending upon the station selected. Digital entry fields include digitally entered setpoint (DES), digitally entered output (DEO), digitally entered bias (DEB) and digitally entered ratio (DER). Emerson uses the following colors (see page 14) as standards for digital entry fields. However, you may discuss different color choices with an Emerson representative. Enhanced SmartMA common elements - analog Analo g stat io ns F EEDBACK
C OLOR
Process Bar/Value
Green
Setpoint Bar/Value
White
Output Bar/Value
Cyan
Demand Bar/Value
Darkseagreen1
Bias Bar/Value
Yellow
OW330_90
13
2.5 What are the Pop-Up control station windows? Analo g f eedb ack s F EEDBACK
F G C OLOR / B G C OLOR
Default/Timed
Magenta/Magenta
Tracking
Black/Yellow
Manual
White/Red
Auto
White/Blue2
Local
White/Orchid4
1 or 3 Element
Black/Yellow
PLW (Priority Lower) PRA (Priority Raise)
White/DarkOrange2 White/DarkOrange2
RLI (Raise Lower Inhibit)
White/DarkOrange2
LWI (Lower Inhibit)
White/DarkOrange2
RAI (Raise Inhibit)
White/DarkOrange2
B (Bias)
White/DarkOrange2
MRE (Manual Reject)
White/DarkOrange2
ARE (Auto Reject)
White/DarkOrange2
Enhanced SmartMA common elements - digital
14
F EEDBACK
F G C OLOR / B G C OLOR
Default
Gray50/Gray50
Tag Out
Black/Yellow
Stopped
Black/Green
Running
White/Red
Auto
White/Blue
Manual
White/Red
Stop Trip
White/DarkOrange2
Start Trip
White/DarkOrange2
Not Ready
White/DarkOrange2
Auto Stop
White/DarkOrange2
Auto Start
White/DarkOrange2
Power Failure
White/DarkOrange2
Running Trip
White/DarkOrange2
OW330_90
2.5 What are the Pop-Up control station windows?
2.5.3 What are permi ssi ve pop -up dis plays? Permissive pop-up displays provide a standard method for displaying feedbacks on a process or device diagram. For example, if a device fails to start, a permissive pop-up window can provide text feedback indicating what the problem is. A poke field can be added to each area requiring a permissive pop-up window. Emerson standard colors and window sizes are used. A maximum of 10 permissive conditions are permitted on each window. The following types of diagnostic/permissive pop-up displays are available:
Selection -- The displays provide a listing of permissives, overrides, interlock conditions, and so forth., and will be called from a process control display.
Functionality -- The displays provide a standard method for displaying the permissives, overrides, interlock conditions, and so forth. For example, if a device fails to start, a permissive pop-up window can provide text feedback, indicating a problem.
Ap pl ic abi li ty -- Displays will be provided for all equipment that has logical or operational conditions that must be satisfied before a status change command can be initiated. All conditions will be listed individually, for each specific device.
Diagnostic -- Accessed from a main screen display, the diagnostic pop-up display provides operating condition information, such as permissives, device status, alarm disable, tagout, help messages, manual rejects, startup and/or shutdown procedures, and so forth.
Permissive -- Provides a standard method for displaying feedbacks on a process or device diagram. For example, if a device fails to start, a permissive pop-up window can provide text feedback indicating what the problem is. A poke field can be added to each area requiring a permissive pop-up window. Emerson standard colors and window sizes are used.
Modulating Device Dia gnosti c Display -- The modulating device diagnostic display indicate all possible conditions for reject to manual mode (MRE), and all override conditions (PLW, PRA, RAI, LWI) via static text. The window is called from the Process Control display (via a poke-point surrounding the device AUTO/MAN indication, just above the device symbol), or via the control faceplate. The text describing the conditions appears black. A red check mark is displayed adjacent to the text, indicating that the condition is true. The window is customized depending on the application, and it incorporates the following categories:
Manual Reject (MRE) and Auto Reject (ARE)
Priority Lower (PLW) and Priority Raise (PRA)
Raise Inhibit (RAI) and Lower Inhibit (LWI)
Motor Control Logic Diagnostic Display (Pump, Valve, Motor, Breaker, etc.) -- The motor control device diagnostic display indicates all possible conditions for a reject to manual mode (if applicable), and all override conditions via static text. The window is called from the Process Control display (via a poke-point surrounding the device AUTO/MAN indication, just above the device symbol), or via the control faceplate. The text describing the condition appears black. A red check mark adjacent to the text indicates that the condition is true. The window is customized, depending on the application, and it incorporates the following categories:
OW330_90
Manual Reject (MRE)
Auto Start/Auto Stop and Auto Open/Auto Close
Start Permissive/Stop Permissive and Open Permissive/Close Permissive
Start Override/Stop Override and Open Override/Close Override
Trip
15
2.6 What is the Navigation feature?
Alarm
In addition, available dynamic data can be displayed. The data may include: Motor current, Number of Device Starts, Operating Days, etc.
2. 6
What is the Navigatio
n feature?
The navigation feature found in each display help the operator visualize the display hierarchy and assist with rapid access to other related displays. The following list provides a description of the different navigation features.
16
Paging -- Moves between related displays at the same level, or up and down to other display levels. Paging is defined according to display hierarchy. Paging can be activated via the menu bar “Page” buttons on the displays or from the optional Membrane Keyboard. Menu Bar Page Buttons -- Each display will have a menu bar at the top of the screen that holds 15 buttons. Fourteen customizable, project-specific buttons provide direct access to other project-specific displays. The color of project-specific buttons is light blue. The button on the far right is reserved for the Clear Control button, which is bisque.
Poke Fields -- Poke fields allow the user to quickly jump from one system display to another related system display. Poke fields are usually identified by buttons on the screen containing selectable display names.
Custom Graphics Menu -- The Custom Graphics Menu provides a standard menu interface so operators can easily reach displays within the Ovation system. Selecting the Home key on a standard keyboard accesses the Custom Graphics Menu.
Custom Keys -- Custom keys are only available if you are using an optional Membrane Keyboard. Through these 48 programmable keys, an operator has direct access to displays which can contain critical control functions. These keys can be customized to access any display on the system in just one step.
Buttons -- Buttons can be used to poke to different graphics and call pop-up windows from the system graphic.
OW330_90
2.7 What is determining display layout?
2. 7
Wha t is determining
displ ay layout?
To maintain consistency of all displays, Emerson Process Management defines standards for every diagram. You may keep the Emerson standard or discuss variations to meet your plants needs. The following display layout items must be considered:
2. 8
Size -- Emerson develops all graphic displays so that when they are enlarged to full size they do not cover the Ovation icons.
Background -- The standard background color for Main Screen displays is gray75.
Diagram header -- The Diagram Header contains the graphic title diagram number and other generic information pertinent to the system. Other items that can be included are navigation keys, unit number or global data.
Title -- The standard color for the display window title is black. The title is located at the top-center of the display, directly below the menu bar.
Engineering unit abbreviations -- Based on space limitations, the engineering units in the displays are abbreviated according to the defined table or database. Typically, the engineering units are extracted from the Engineering Units (EU) field of the point's record and the first four characters are displayed.
Font -- The standard text font is Monospace821 BT for Windows.
Display number -- The display number is located at the lower-right corner of the display, above the Process Point bar. The display number appears as gray65.
Process point b ar (dia gram footer) -- At the bottom of each display there is a Process Point bar that contains a series of nine blocks displaying customizable process point information, such as temperatures, pressures or other key values pertinent to the system. The Process Point bar appears the same on all displays. White represents point description and engineering units. The color of the point values matches the process variable values in the main screen.
Maximum diagram file size -- The maximum diagram object file si ze is 2 MB.
Wha t is the Display
layout
format
conventio
ns?
Emerson Process Management allows you to determine what your process points and equipment will appear like on process diagrams. It also provides various shapes for appearance conformity and ease in graphical implementation.
OW330_90
17
2.8 What is the Display layout format conventions?
2.8.1 What is the pro cess value dis play? The process point consists of numerical value, quality code, and engineering units. Emerson provides a standard way of displaying these values. However, you may discuss different color choices with an Emerson representative. Note: By default, numerical value, quality code, and engineering units are displayed on a black background. When a point is not in alarm, the color of the numerical value (see page 18) appears as white. When the point is in high or low alarm, the color is defined by the specific point's alarm priority, maintaining consistency with the project's database management. The quality code (see page 19) for an analog value provides an indication to the operator as to the validity of the information being displayed, and it consists of one character within the point value field. The color of the quality code is magenta. The color of the engineering units is white. Numerical value C OLOR
P RIORITY
Red
1
Orange
2
Yellow
3
White
4
Purple
5
Tan
6
Brown
7
Slate Blue
8
If the alarm is unacknowledged, the value is displayed as reverse video.
18
OW330_90
2.8 What is the Display layout format conventions? Quality code Q UALITY
D ISPLAYED C HARACTER
Good
blank
Fair
F
Poor
P
Bad
B
Timed Out
T
2.8.2 What are the te xt alarm messages? You may select the color of you text alarm messages. Emerson provides the following standard. If a condition is not in alarm, the color of the text message is gray60, which is only slightly darker than the background color, but visible. If the condition is in alarm, the color of the text message is defined by the specific point's alarm priority, which is consistent with the project's database management. If the alarm is unacknowledged, the text message is displayed in reverse video.
2.8.3 Wha t is se lecting graphic symbols? Process Control displays typically show numerous fans, pumps, valves, dampers, and so forth. as represented on the P&IDs (Piping and Instrumentation Drawings). These devices are typically created as shapes or macros for appearance and ease graphical implementation. Thus, the same pump shape/macro is used for "Boiler Feed PumpinA" on all process control displays. To ensure uniform appearance, the shape/macro library files created by Emerson Process Control will be used for all shapes. Process lines (see page 19) depict flow lines of such things as air, water, oil, gas, and so forth. Process flow (pipes) is displayed as "two-dimensional" static lines (no color or pattern change). Refer to the following table and examples for color conventions. Static text outside of equipment symbols is displayed in black letters. Static text inside equipment symbols is displayed using black letters with the same background color as the equipment. Process lines P IPING M A T E R I A L
C OLOR
Raw/Service Water
Navy
Aux Cooling Water
Cyan
Condensate Condensate Return
Dodger blue Blue3
Makeup Water
Blue
OW330_90
19
2.8 What is the Display layout format conventions?
P IPING M A T E R I A L
C OLOR
Draw-Off
Blue
LP Feedwater
Dodger blue
HP Feedwater
Dodger blue
LP Steam
Orange
IP Steam
Salmon
HP Steam
Indianred
Vacuum
Black
Lube/Control Oil
Violet red
Coal
Gray35
Fuel Oil
Lavender
Fuel Gas
Yellow
Air
Gray80
Oxygen
Sky Blue2
Hydrogen
Sky blue
Flue Gas Untreated
Saddle brown (Dark Brown)
Flue Gas Treated
Chocolate (Light Brown)
Absorber Feed
Gray25
Absorber Exit
Gray45
Lime
Lime-green
Caustic
Yellow
The following table provides the color standards for graphics that deal with electrical applications and equipment.
20
E LECTRICAL
C OLOR
480V
White
4160V or 6.9KV
Red
345KV - 500KV
Yellow
Generator outputs
Blue
OW330_90
2.9 What is the diagram control strategy?
2. 9
Wha t is the diagram
contr ol strategy?
Acquiring control of a single piece of equipment requires a two-step process. First, the operator selects the equipment to be controlled, and then initiates the control action needed (such as raise or lower set points, select mode, manually raise or lower process outputs, or control any digital on/off functions). Important items associated with control diagrams include:
Poke fie lds butto ns -- allows the operator to select an option on the display including control windows, permissive windows and point information functions. The number of poke fields on a screen may vary based on content of the diagram. Poke fields are identified by a red box when the diagram menu bar "Poke" feature is selected in the graphics application.
Control station diagrams
-- a control station, either grouped in a diagram or in a pop-up
window, is used to control valves, motor operated valves, pumps fans. The to manual/auto station allowsmodulating the operator to select manual or automatic controland of the output, manipulate the set point or output valve (depending on the selected control mode) and control any digital on/off functions.
OW330_90
21
S
ECTION
3
Getting starte d w ith the G raphics Bui lder
IN THIS SECTION Definitions of terms?.......................................................................................................... 23 What ............................................................................................................ 30 What is areLicensing? the multi-network considerations? ..................................................................... 30 What are the rules for entering process point names? .....................................................30 What are the differences between the online and offline Graphics Builder? ....................38 Variables............................................................................................................................ 43 What is the main Graphics Builder window?..................................................................... 49 What are the Keyboard shortcuts for the Graphics Builder?.............................................60
3. 1
De finiti ons of terms? This document assumes that you are already familiar with certain operating system and window manager terms. Before beginning to use Graphics Builder, it may be helpful to refer to the applicable operating system and window manager documentation.
3.1.1 Wha t is the outli ning rectangle? The outlining rectangle is the smallest rectangle that could be drawn around an item that includes every point on the item. An outlining rectangle surrounds every draw item on the Draw toolbar. When an item is selected on the drawing canvas, eight handles appear around the item as shown below:
OW330_90
23
3.1 Definitions of terms? If a line were drawn to connect these handles, it would represent the outlining rectangle around the item.
24
OW330_90
3.1 Definitions of terms?
3.1.2 What are the coo rdi nates? The Graphics Builder uses two types of coordinates to specify x and y locations and widths and heights. An explanation of each follows: Screen coordinates — Screen coordinates are used to define the location/size of the diagram windows displayed on the Ovation Operator Station monitor screen (DIAGRAM and DIAG_DISP commands). They are also used to specify the spacing between strings for the MULTI_TEXT command. Screen coordinates are classic pixels. Screen coordinates are defined by the pixel resolution of the CRT monitor screen. These coordinates are used in conjunction with the DIAGRAM, DIAG_DISP, and MULTI_TEXT commands only. Virtual coordin ates — Virtual coordinates define the drawing surface of a diagram. The drawing surface is defined to be 16,384 x 16,384 pixels. Therefore, the virtual coordinate range is 0 16,383 and 0 - 16,383 where 0, 0 is the upper left corner of the diagram, and 16,383, 16,383 is the lower right corner of the diagram. All of the graphics commands drawing items on the diagram (ARC, CIRCLE, BAR, LINE, and so forth), specify x, y, w, h parameters in terms of virtual coordinates. Virtual coordinates are required to implement software pan and zoom. For example, since it is not possible to display a diagram that is 16,384 x 16,384 pixels on a CRT screen which is only 1,152 x 900 pixels, virtual coordinates are mapped (scaled) to screen coordinates when items are displayed on the drawing surface. The current zoom level determines the number of virtual pixels which map to a single screen pixel. As you zoom in further, the number of virtual pixels mapping to a single pixel decreases until one virtual pixel maps to one screen pixel. Two types of virtual coordinates are supported:
Absolute
Relative
Ab so lute vir tu al coo rd inates specify a virtual offset from 0, 0 (upper left corner of the diagram). Relative virtual coordin ates specify a virtual offset from the previous display item (circle, bar, text, rectangle, and so forth), or from 0, 0 if there is no previous item in the diagram section. Absolute virtual coordinates are specified as 0 - 16,383. Relative virtual coordinates are specified as -16,383 - 16,383. Note that relative coordinates must be enclosed in brackets.
Refer to the following examples: Example 1: Rectangle specified with absolute virtual coordinates: RECTANGLE 4000 4000 6000 2000 1 solid solid
Example 2: Rectangle specified with relative virtual coordinates: RECTANGLE [-1000] [3000] 6000 2000 1 solid solid
For this example, the source line in Example 2 immediately follows the source line in Example 1, as shown below: BACKGROUND COLOR FG RED LINE 1000 2000 5000 5000 9000 2000 1 solid
In the example, the second rectangle would be relative to the first rectangle. The second rectangle would be 1,000 pixels left of the first, and 3,000 pixels below the first rectangle. If you interactively move the first rectangle, the position of the second automatically shifts also. If you delete the first rectangle, the second rectangle becomes relative to the line. If you then delete the line, the second rectangle becomes relative to 0, 0. If you then add a new item after the color command, the rectangle becomes relative to the new item. For those commands that have more than one x, y coordinate pair (LINE and POLYGON), only the first x, y coordinate pair is relative to the previous display item. If relative coordinates are specified for any other x, ySee pairexample (not thebelow: first pair), those relative coordinates are relative to the previous coordinate pair. LINE 1000 2000 [5000] [5000] 9000 2000 1 solid
In the example above, the relative coordinates [5000] [5000] are relative to the previous coordinate pair (1000, 2000). What are the rules for co ordinates? The following rules apply to relative coordinates: 1. Items can only be defined with relative coordinates through the source editor. You cannot interactively draw items with relative coordinates. You may interactively draw items and then change to relative coordinates by editing the command in the source editor. Once the item is created with relative coordinates, it may be edited (moved, copied, resized, rotated, inverted, and/or deleted) through the main Graphics Builder window. 2. Items specified with relative coordinates cannot be interactively grouped, and their Place cannot be changed. 3. Relative coordinates can only be used to specify the x, y position of display items. Relative coordinates cannot be used to specify size (width and height). You may specify x and y coordinates independently (x may be absolute and y may be relative). Commands with multiple x, y pairs (LINE and POLYGON) may specify any number of coordinates as relative; only the x, y position of the DYNAMIC_LINE and DYNAMIC_POLYGON may be relative (not the individual x, y coordinates). 4. Relative coordinates may only be used to specify the position of the following commands: ARC, BAR, CIRCLE, DATE, DOT, DYNAMIC_LINE, DYNAMIC_POLYGON, ELLIPSE, GTEXT, LINE, MULTI_TEXT, OL_CYLINDER, OL_GAUGE, OL_RECTANGLE, PLOT, POLYGON, PROCESS PT, RECTANGLE, SHAPE, TEXT, TIME, TREND, and XY_PLOT. See the following examples: ARC [222] [3333] 1989 9999 123 -220 1 solid unfilled BAR [2222] [3434] 1377 2401 up A100 AV 2 22 CIRCLE [1222] [1111] 898 1 solid unfilled DATE [999] [233] 1 vector 207 944 1 DOT [444] [555] large DYNAMIC_LINE [1000] [4000] 2342 1078 0 100 0 100 NOT_F ITTED NOSCALE 1 2 \A100\ AV 50 \A200 \ AV 50 1 solid
5. Items defined with relative coordinates are relative to the previous item. The point on the previous item to which an item is relative depends on the previous item. This point is defined as the srcin (see page 27). What are the srcins o f draw items? Items defined with relative coordinates are relative to the previous item. The point on the previous item to which an item is relative depends on the previous item. This point is defined as the srcin . For example, the srcin of a circle is the center. If a rectangle was specified to be relative to the circle, then the rectangle would be relative to the x, y point at the center of the circle. The srcin for each draw item is listed in the following table. Origin by draw item D RAW I T E M
R ELATIVE
ARC
Starting point of the arc.
O RIGIN
ARCPOLYGON
Starting point of the arc.
BAR
Upper left corner (down, right or bias). Lower left corner (up). Upper right corner (left).
OW330_90
27
3.1 Definitions of terms?
D RAW I T E M
R ELATIVE
ARC
Starting point of the arc.
O RIGIN
BMP_IMAGE
Upper left corner.
BUTTON
Upper left corner.
CIRCLE
Center.
DATE
Baseline position of the first character of the text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the text string (for vector and vector_over text).
DOT
x, y position.
DYNAMIC_LINE
Lower left corner of the outlining rectangle.
DYNAMIC_POLYGON
Lower left corner of the outlining rectangle.
ELLIPSE
Center.
ELLIPSEPOLYGON
Center.
ENTRY_FLD
Baseline position of the first character of the text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the text string (for vector and vector_over text).
GTEXT
Baseline position of the first character of the text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the text string (for vector and vector_over text).
LINE
First x, y coordinate of the line.
MACRO
Upper left corner of macro outlining rectangle.
MULTI_TEXT
Baseline position of the first character of the first text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the entire item (for vector and vector_over text).
OL_BUTTON
Upper left corner of button outlining rectangle (x, y from command syntax).
OL_CHECKBOX
Upper left corner of checkbox outlining rectangle (x, y from command syntax)
1,3
1,3
OL_CHOICE
Upper left corner of choice (x, y from command syntax)
OL_CYLINDER
Upper left corner of cylinder outlining rectangle (x, y from command syntax).
.
OL_EVENT_MENU
Upper left corner of event menu (x, y from command syntax).
OL_GAUGE
Upper left corner of gauge outlining rectangle (x, y from command syntax).
OL_RECTANGLE
Upper left corner (x, y from command syntax).
OL_RECTPOLYGON
Upper left corner (x, y from command syntax).
OL_SLIDER
Upper left corner of slider outlining rectangle (x, y from command syntax)
PLOT
Top of plot line (down).
1,2
.
Bottom of plot line (up). Left end of plot line (right).
28
OW330_90
.
3.1 Definitions of terms?
D RAW I T E M
R ELATIVE
ARC
Starting point of the arc.
O RIGIN
Right end of plot line (left). POKE_FLD
Upper left corner of poke field.
POLYGON
First x, y coordinate of the polygon.
POLYBAR
First x, y coordinate of the polygon.
PROCESS_PT
Baseline position of the first character of the text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the text string (for vector and vector_over text).
RECTANGLE
Upper left corner.
RECTPOLYGON
Upper left corner.
SHAPE
Defined srcin.
TEXT
Baseline position of the first character of the text string (for bitmap and bitmap_over text). Upper left corner of the outlining rectangle of the text string (for vector and vector_over).
TIME
Baseline position of the first character of the text string (for bitmap text). Upper left corner of the first character of the text string (for vector).
TREND
Lower right corner (for horizontal). Upper right corner (for vertical).
XY_PLOT 1 2 3
Lower left corner.
Allow the result to be stored in a local/global variable OR in a $D pointer. Can be stored in variables of type int, real, int[n], and real[n]. Can be stored in variables of type int and int[n].
Note: There is no difference in using a MATH command vs. a SET_VARIABLE command to set the value of an int, real, int[n], or real[n] type variable (except that you can create a SET_VARIABLE command from the Graphics Builder editor instead of having to use a source editor). The MATH command cannot be used to set the value of a sysid-type or ASCII-type variable; the SET_VARIABLE command is the only way to set sysid and ASCII named variables. Note: The srcin of a group is defined as the upper left corner of the group’s outlining rectangle.
OW330_90
29
3.2 What is Licensing?
3. 2
Wha t is Licensin
g?
The Graphics Builder application must be assigned a license key. When Graphics Builder is initially loaded, a trial license is given. After the end of the trial license period, if you try to access Graphics Builder without obtaining a regular license, a notice window will appear, and Graphics Builder will not display. Licenses are available during normal work hours from your Emerson representative. Depending on your situation, this contact might be your project engineer, after-market representative, or Field Service engineer. Contact Emerson prior to installations or upgrades to ensure the availability of required key codes or licenses.
3. 3
Wha t are the multi-network
cons iderations?
This version of the Graphics Builder can be run on multiple networks. In a multi-network system, you may have read-write access to the Graphics Builder on all of the applicable networks. However, in some instances, the Graphics Builder may just have read-only privileges on one of the networks. If the online version of the Graphics Builder is invoked from a read-only location, you will NOT be permitted to save any changes to graphics. The Graphics Builder allows you to view a remote graphic (a graphic on another network), but no changes (moves, adds, deletes, resizes, and so forth) can be saved. Specifically, the Save, Save As, and Compile buttons are disabled. You are not able to save macro notes, save or compile in the Generic Text Editor, edit the Shape Library, edit custom line patterns, or perform auto-saves. The Graphics Builder title bar shows “Read-Only GBNT” so that you know you are working on a read-only system.
3. 4
Wha t are the rules for e ntering process
point name
s?
Point record information is required in many Graphics Builder windows (Bar, Process Point, Poke, and so forth). This section defines the valid point names and record fields that can be used. (See Ovation Record Types Reference Manual.) Valid point names in the graphics language consist of the following:
Process point names defined in the Point Builder.
Dummy points (unresolved points).
$Pointer variables ($P, $G, $H, $, $D, $O, and $S).
Record fields.
OPC points.
All of the above types of points can be used in graphics commands wherever point names (or point name and record field pairs) are used.
3.4.1 What is a valid poi nt name? A fully qualified point name in the Ovation system uses the following format: “name.unit@network”
30
OW330_90
3.4 What are the rules for entering process point names? This fully qualified name consists of three parameters:
A 24-character maximum point name.
A six-character maximum unit name.
An eight-character maximum network name.
In a multiple network implementation, the network name segment must be one of the following:
Actual name of the local or remote network.
Any of the defined network aliases (the alias for the remote or local network).
In addition to the above parameters, the “.” and “@” are required and are reserved characters. Therefore, the maximum number of characters in a fully qualified point name is 40. Characters in the name portion may be any combination of alphabetic, numeric (0 - 9), or special punctuation characters. The only characters that are not allowed in the name are: *, @, ., %, $, ~, \, “, ‘, comma, space. Note that the “.” and “@” are part of a fully qualified point name, but are not allowed in the name portion of the fully qualified point name. The unit and network portions of the fully qualified name are composed of alphanumeric characters only. Point names are no t case sensitive. That is, “Testai01.unit1@wdpf” is the same as “TESTAI01.UNIT1@WDPF”. Fully qualified point names must be delimited by backslashes (\) when used in graphics since the “.” and “@” characters are not alphanumerics. Any point name that includes a non-alphanumeric character or that does not begin with an alpha (A - Z) character must be delimited by backslashes in a graphic. For example, you must enter “\Testai01.unit1@wdpf\” for a point name instead of “Testai01.unit1@wdpf”. If the point name is a reserved graphic word (for example: RECTANGLE, COLOR, UP, HORZ, and so forth), it must be delimited by backslashes. Even when not using fully qualified point names, Emerson recommends using backslashes. Note: The backslash characters are NOT included in the characters making up the point name. There is no space between the backslashes and the point name characters. What are some uses o f Fully Qualified and Non-F ully Qualified poin t names? Database point names are not required to be fully qualified in a graphic. Different plant situations determine the need for fully qualified point names in a multiple network system. 1. In situations where you want to copy the same graphic to multiple units/networks and the points being used are defined in all the units/networks, you do NOT have to fully qualify the point name. When a point name is not fully qualified, the local network is always assumed. For example, you copy a graphic with point A100 from unit1/network1 to unit2/network1 and to unit1/network2. If A100 exists in all three places, then you would no t want to fully qualify the point name, since each unit/network reads the value of A100 on its own unit/network. If A100 were fully qualified, when it was copied to the other units/networks, it would not read the value on its local network. When a point name is not fully qualified, the local network is always assumed. 2. In situations where you are building a graphic and you want to monitor a point from another network, you must fully qualify the point name. In this way, there is no ambiguity when receiving values from the point.
OW330_90
31
3.4 What are the rules for entering process point names? For example, you build a graphic on unit1/network1 that monitors point A100 on unit1/network2. Since the local network is always assumed when a point is not fully qualified, you must specify the point as \A100.unit1@network2\ so that it is being read from the proper network.
3.4.2 Wha t are dummy poin ts ( unresolved points)? Dummy points (also known as unresolved points) are valid point names that do not exist in the Ovation database. These may be fully qualified with a unit and network name, or they may be unqualified. If the dummy point name does not begin with an alphabetic character, or if it contains any characters other than alphanumerics, it must be delimited with backslashes. If it is a fully qualified name, it must be delimited with backslashes. Dummy points are used to enable a diagram to be compiled and displayed before the points are added to the Ovation database. When dummy points are displayed in a diagram, they are inactive and have no value. Therefore, final testing of the diagram cannot take place until the dummy points are added to the Ovation database, and the diagram is recompiled and redisplayed. All dummy points should be resolved into database points before the diagram is executed at runtime. Dummy points have no point type associated with them. Since they have no type, some of the error checking that is performed for points in the Ovation database cannot be performed for dummy points. Therefore, when dummy points are added to the Ovation database and the diagram is recompiled, there may be errors that were not detected previously. These errors are caused by the point type assigned to the formerly “typeless” point. To minimize these errors, you should note the point type that is assigned to the dummy point, and write the source code as if the dummy point actually has this type. When a file containing dummy points is loaded and/or saved, the Graphics Builder may display a warning message saying that dummy points exist in the diagram. This is not done automatically. You must choose to be warned of dummy points by configuring the Unresolved Points Warning function (see page 91). A list showing all the dummy points used in the diagram is then displayed. Checking this list is important because misspellings and invalid identifiers may be interpreted as dummy points by the graphics language. See the Graphics Builder User Guide for information on unresolved points warnings. For example, operands in a conditional statement may be any of the following types: integer, real constant, point name/record field, pointer/offset, or status identifier. An invalid status identifier (such as OFF32) would be handled as a dummy point named OFF32. Therefore, unintended dummy points in the list indicate errors in the diagram. Variables cannot be delimited by backslashes (they are NOT process points). If the are delimited by backslashes, GB interprets them as process points instead of variables. If L:some_variable, S:some_variable, or G:some_variable shows up in the Unresolved points dialog box, the points were erroneously delimited with backslashes in the graphic.
3.4.3 What are the valid poin ters? The Graphics Language recognizes the following valid pointers: $P, $G, $H, $W, $D, $O, and $S. Pointers are used as a means of passing data into a diagram. The $W and $D pointers are used as parameters to the diagram. Actual process point names are passed for these pointer variables before the displays runtime. reference points defined externally diagram in diagram the system groupat library file. $G $P pointers and $H pointers reference a segment offset to in the the computer memory in the Operator Station. Pointers are identified by a dollar sign ($).
32
OW330_90
3.4 What are the rules for entering process point names? What do $P pointers (Scratch Pad Pointer) do? The “$P” pointers (valid range = $P1 - $P99) point to locations in memory segments. A maximum of 99 $P pointer variables can be defined in a graphic. $P pointer variables must be initialized to an existing segment and offset in memory using the POINTER command or the PTR_EQUAL command. Data may be passed between graphics using these pointer variables. For example, an area of computer memory is reserved in the Operator Station to store data received from another drop (such as general message data). Using $P pointer variables allows you to access and display this data by setting a pointer to begin at a specified segment and offset within the reserved area. $P variables cannot be combined with the standard two-character ASCII record fields (for example: AV, RS, 1W, and so forth) in the source syntax since $P pointers do not represent actual process points in the database. Instead, $P pointer variables have an associated $offset notation. The valid $offsets for $P pointers are defined as follows:
$In — represents a 32-bit integer beginning at an offset of n bytes from the associated $P pointer location initialized by the POINTER or PTR_EQUAL command. The “n” must be a multiple of 4 (for example: $I0, $I4, $I8, $I12, and so forth).
$Rn — represents a 32-bit floating po int real number beginning at an offset of n bytes from the associated $P pointer location initialized by the POINTER or PTR_EQUAL command. The “n” must be a multiple of 4 (for example: $R0, $R4, $R8, $R12, and so forth).
$Bn — represents a byte beginning at an offset of n bytes from the associated $P pointer location initialized by the POINTER or PTR_EQUAL command (for example, $B0,$B1,$B2, and so forth).
$Sn — represents a 16-bit integer beginning at an offset of n bytes from the associated $P pointer location initialized by the POINTER or PTR_EQUAL command. The “n” must be a multiple of 2 (for example: $S0, $S2, $S4, $S6, and so forth).
$AnXi — represents an ASCII string of length i beginning at an offset of n bytes from the associated $P pointer location initialized by the POINTER or PTR_EQUAL command.
where: n = (0 - 32,767) and i = (0 - 255). Sample $P pointer variables and associated $offsets are: $P1 $I0, $P23 $R24, $P99 $A10X32, and so forth. Note that you must be aware of the size of the segment that you initialize your $P pointer to using the POINTER or PTR_EQUAL command before/while attempting to access data within that segment. For example, if you assign $P1 to a segment that is only 256 bytes long, unpredictable results occur if you try to access $P1 $B300 because you are accessing memory beyond the total size of the segment to which you are pointing. A list of available memory segments and their associated sizes is available (see the Pointer Command Syntax). What do $G pointers (group poin ter) do? The “$G” pointers (valid range = $G1 - $G250) are used to reference the group points stored in the current point group. The Group Builder program is used to build/modify the system point groups. A given point group can have a maximum of 250 points associated with it ($G1 represents the first point in the current group, $G2 represents the second point, and so forth). The $G1 pointer is reserved for Emerson use; however, you may use $G2 - $G250 in your graphics. Since $G pointers reference actual database points, use the standard two-character ASCII point record fields (for example: AV, RS, 1W, and so forth) with them wherever a point name/record field pair is required in a graphic.
OW330_90
33
3.4 What are the rules for entering process point names? What d o $H pointers (Highway Pointer) do? The “$H” pointers (valid range = $H1 - $H99) are used to reference database points indirectly by looking at a system ID stored in computer memory at the Operator Station. It is a precondition of using $H pointers that when you initialize the $H pointer in memory using the POINTER or PTR_EQUAL command, you must point it to a system ID stored in computer memory. Make sure that the $H pointer points to a database point system ID; otherwise, the $H pointer does not function properly. Since $H pointers reference actual database points, use the standard two-character ASCII point record fields (for example: AV, RS, 1W, and so forth) with them wherever a point name/record field pair is required in a graphic. What do $W pointers (W indow p ointer) do? The “$W” pointers (valid range = $W1 - $W99) are used in WINDOW diagrams (diag_type parameter on the DIAGRAM command = WINDOW). The $W pointers mark generic points which are replaced with valid process points when the window diagram is displayed. A window diagram is displayed either as a result of a DIAG_DISP command, a POKE_FLD (type 8) command, or an OL_BUTTON (poke functionality, type 8) command. Note that all of these commands take a list of database point names as a parameter in the source syntax. When the window diagram is displayed, the first point passed in the point names list via any of the above commands is substituted for all occurrences of $W1 in the window, the second point passed is substituted for all occurrences of $W2 in the window, and so forth up to $W99. Window graphics are often implemented as templates so that the same window can be called from multiple graphics with different sets of points. Since $W pointers are replaced with actual database points, use the standard two-character ASCII point record fields (for example: AV, RS, 1W, and so forth) with them wherever a point name/record field pair is required in a window graphic. Note that when you access a window graphic, you only pass the point name to the window (not a point name/record field pair). The record field is coded into the window graphic and cannot be passed into the window. It is your responsibility to passes code the graphic with thethe appropriate record field foron whatever type of point ultimately towindow the window to replace $W pointer. At runtime, the Operator Station, if the point passed for any $W pointer in the window is incompatible with the coded record field for that instance of the $W pointer, an error is sent to the Error Log window, and the gcode using that $W pointer in the window is skipped (that is, not drawn at runtime).
34
OW330_90
3.4 What are the rules for entering process point names? What do $D pointers (macro poi nter) do? The “$D” pointers (valid range = $D1 - $D99) are used in macro diagrams. The $D pointers mark generic points that should be replaced with valid process points when the macro (see page 205) is added to a graphic. Valid database points, any of the $pointer variables, dummy points, sysid-type variables, and/or OPC points can be passed to replace $D points in a macro file. The MACRO graphics command takes a macro diagram number, and a list of up to 99 process points as parameters. $D pointers are required because a single macro diagram may be added to several graphics with different process point parameters. When the macro is added to the graphic, each process point parameter is substituted in the macro gcodes for all occurrences of the corresponding $D pointer. That is, the first process point is used for $D1, the second process point is used for $D2, and so forth. Since database points, $W, $G, $H, or $P pointers can be passed to replace $D pointers in the macro, $D pointers can be paired with either the standard two-character ASCII point record fields (for example: AV, RS, 1W, and so forth) OR the $offsets (for example: $I0, $R24, $B3, $A10X16, and so forth) wherever a point name/record field pair is required. Note that when you access a macro graphic, you only pass the point names to the macro (not the point name/record field pairs). The record fields are coded into the macro graphic and cannot be passed into the macro. It is your responsibility to code the macro graphic with the appropriate record field for whatever type of point is ultimately passed to the macro to replace the $D pointer. What do $O pointers (onscr een poin ter) do? The $On pointers (valid range = $O1 - $O99) are used as a programming tool to pass a two-character ASCII record field to application program SEND_CA (#80) using the POKE_FLD (type 7 or 23), RUN_PROGRAMS, FUNC_KEY, or OL_BUTTON (type 7 or 23) command. Application program #80 performs a change attributes function on some point in the database. You must pass the two-character ASCII point record field that you want to change to this program. The numbers, $On pointer used to do that. identifiers, Valid application program arguments integers, real setisvariables, status and point name/record fieldinclude pairs. Astrings, stand-alone record field is not a valid argument to an applicable program; however, a point name/record pair is a valid argument. What do $S pointers (e ntry field p ointer) do? The $S pointers (valid range = $S1 - $S99) are used as placeholders for point names when only a record field is needed by an application program. They are used with FUNC_KEY, POKE_FIELD (type 7 and 23), RUN_PROGRAMS, and OL_BUTTON (poke type 7 and 23) commands. The applications programs that typically use $S pointers are SEND_GENMSG (67) and SEND_GENMSG_NETWORK (167). For example, you define an entry field on the screen. The entry field number (buffer number) is used as the Select Pointer or type number. If the entry field was defined to use buffer number 5, then, to pass the value record field (AV) of that point in the entry field to a function key or Poke Type 7 program, you would write: $S5 AV.
OW330_90
35
3.4 What are the rules for entering process point names?
3.4.4 What are the recor d field s? Record fields are predefined in the Ovation system. These record fields vary according to the type of the process point (analog, digital, device, packed group, and packed digital), and are denoted by a two-character ASCII name (AV, DS, 1W, LL, ED, and so forth). A default record field is defined for each point type. If you do not enter a record field in a graphics command when a process point/record field is required, the default record field for that type of point is assumed. Record fields are applicable to database points, dummy points, sysid-type variables, $W, $G, $H, $O, and $D pointers. The $offsets ($I0, $R4, $S0, $B3, $A0X16, and so forth) are only applicable to $P (see page 33) and $D (see page 35) pointer variables. OPC points do not have associated record fields or $offsets. The following table summarizes the relationship between the type of point and the record field (or $offset) expected in the Ovation system. (See Ovation Record Types Reference Manual.) Point types with associated record fields T YPE OF P OINT
A SSOCIATED
R ECORD F IELD ( O R $ O FFSET )
D EFAULT R ECORD F IELD ( $ O FFSET )
Database point
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
Depends on the type of point.
Dummy point
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
OPC point
None.
Not Applicable
$P1 - $P99
$Offset (for example: $I0, $R4, $S0, $B3, $A0X16, and so forth).
$B0
$G1 - $G250
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
$W1 - $W99
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
$D1 - $D99
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
OR
$Offset (for example: $I0, $R4, $S0, $B3, $A0X16, and so forth). $O1 - $O99
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
$H1 - $H99
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
$S1 - $S99
Two-character ASCII record field (for example: AV, 1W, HL, LL, and so forth).
None
Note: The Graphics Builder does not check for valid record types on points srcinating from a remote network.
36
OW330_90
3.4 What are the rules for entering process point names?
3.4.5 What are OPC poi nts ? OPC (Ole for Process Control) points are used to access data on OPC servers. This data is external to the Ovation System. OPC point names (or tags) in graphics are of the following format: OPC$ser ver t ag$poi nt t ag where: OPC$
The first four characters of any OPC name must be “OPC$”.
servertag
Logical name of the OPC server. It is comprised of alphanumeric characters only.
$
Mandatory placeholder.
pointtag
Name of the point or tag. This portion can contain any characters (including spaces and backslashes).
The entire OPC name is limited to 130 characters. The maximum source line length in a graphic is 132 characters, and OPC point names must always be delimited by backslashes (therefore, 132 -2 = 130). The entire OPC point name is case sensitive . The name “OPC$server1$A100.AV” is different from “OPC$server1$a100.av”. Also, the first four characters of an OPC name must be “OPC$” (no t “opc$”). Note that this is different than database point names, du mmy point names, and $pointer variables, which are all case insensitive . OPC point names must always be delimited by backslashes in graphic source commands and in entry fields on the GB windows that expect a point name or point name/record field pair. OPC points do not have associated record fields (neither the two-character ASCII record fields or the $pointer offset notation). You may pass an OPC point anywhere in a graphic where a point name or point name/record field pair label is expected, but do not append record it (even if the entry field label or source syntax indicates doing so). Enter a the OPC field pointafter name as defined (delimited by backslashes) when specifying an OPC point name. Since backslash characters are used to delimit OPC point names (as well as all other point names), the use of a backslash character in the pointtag portion of an OPC names is not recommended. However, if backslashes are used in the pointtag portion, two backslashes must be used. This is done so that GB can differentiate between the delimiting backslash that marks the end of the OPC name and the ones used in the pointtag portion. Any even number of consecutive backslashes within the pointtag portion is considered part of the name and not the terminating backslash. For example, if the pointtag portion exists as “A100\SYSTEM1\TEST\AV” in the OPC Server, it must be written in the graphics source file as follows:
\ OPC$ser ver t ag$A100\ \ SYSTEM1\ \ TEST\ \ AV\ If it were written as “\OPC$servertag$A100\SYSTEM1\\TEST\AV\”, GB would assume that the backslash after A100 is the terminating backslash (that is, that the OPC point name is “\OPC$servertag$A100\”) and would process the rest of the name as extra data on the source line after the OPC name.
OW330_90
37
3.5 What are the differences between the online and offline Graphics Builder? Using OP C points in gr aphics 1. OPC points cannot be used with a POKE FLD (poke type = 0) command to display Ovation system point information since the OPC point is not part of the Ovation system. Similarly, you cannot poke on the display of a PROCESS PT command built with an OPC point. 2. In the PROCESS PT command, if an OPC point is specified for the point name argument, no record field (or record field conditional) is allowed, since OPC points do not have associated record fields. 3. OPC points cannot be used in conjunction with CASE or QUALITY conditional expressions in graphics. 4. OPC point names are not stored in the database with the graphic when running the Graphics Builder within the Ovation Developer Studio. (Seefunction OvationonDeveloper Studio User Guide.) Thus, you cannot do a search or a “where used” OPC points as you can for database points. 5. OPC point names do not display in the list of dummy points in the Graphics Builder. There is no support for getting/printing a list of OPC points used in a graphic in the Builder.
3. 5
What are the diff erences Builder?
between
the onl ine and offl ine Graphic s
The Graphics Builder can be run online from within the Ovation Developer Studio or it can be run offline as a standalone program. To run online, the Graphics Builder is automatically installed as part of the Ovation Developer Studio. To run offline, a separate installation CD is required to perform the setup. Note: You cannot simply execute the online gbnt.exe file in order to run offline, because the offline runtime environment is different from the online runtime environment. Both the online and offline versions of the Graphics Builder require a license to run. When running the Graphics Builder offline, the Import Graphics function (see page 325) within the Ovation Developer Studio is used to move your offline graphics and support files into the database (online environment). In addition, the Export Graphics function can be used to move graphics from the Developer Studio to a user-defined location. (See Ovation Developer Studio User Guide.) The appearance and functionality of the Graphics Builder are identical between the online and offline versions with the following exceptions:
Communicating with the Database (see page 39)
Browsing OPC Servers (see page 39)
Creating a new graphic (see page 39)
Opening an existing graphic (see page 40)
Compiling a graphic (see page 41)
Saving a Graphic (see page 42)
Note: Throughout the remainder of this manual, the examples are from the offline version of the Graphics Builder.
38
OW330_90
3.5 What are the differences between the online and offline Graphics Builder?
3.5.1 Whe n does the Graphics Builder commun
icate with the databa
se?
The Graphics Builder only communicates with the database when it is running online. All point names are interpreted as dummy points when running offline/stand-alone. On a save of a macro file, only the online version of Graphics Builder prompts you to recompile all the graphics using the macro.
3.5.2 When does the Graphic s Build er Browse the
OPC servers?
Support for browsing the available OPC servers for OPC point names within the Graphics Builder is only provided when running online. Both the associated menu item and the toolbar button for the OPC point browser are inactive when running Graphics Builder offline. You may still use OPC point names in graphics when running offline, but you will not be able to browse for them within Graphics Builder. See GBNT:Browse OPC Points dialog (see page 84) for more information.
3.5.3 When does the Graphic s Build er create a new graphic ? In the offline version of the Graphics Builder, the New function is accessed when you pull down the File menu on the main window and select New. In the online (Studio) version of the Graphics Builder, new diagrams cannot be created from within the Builder (in the online version, the New menu item on the File menu is inactive, as well as the associated toolbar button). New diagrams are created in the online version (see page 39) of the Graphics Builder from within the Ovation Developer Studio. Once a diagram is opened in the online version via the Ovation Developer Studio, you cannot create a new diagram in the same window. The only way to create a new diagram is via the Ovation Developer Studio, in which case a new instance of the Graphics Builder is invoked. In contrast, new diagrams can be created in the offline version (see page 95) either by using the New menu item or the New toolbar button. In the offline version, when the New function is invoked, any currently loaded diagram is erased (after prompting to save any changes), and the current instance of the Graphics Builder is re-used to create the new diagram. When building graphics offline, use the Import Graphics function (see page 325) to first move the graphic to the Developer Studio. Make sure you check for errors as the import is processing. Once in the Developer Studio, perform a download of that graphic. You can then load the updated graphic in a Graphics Display window. If creating a graphic online, save the graphic, then perform a download of that graphics in the Developer Studio. You can then load the updated graphic in a Graphics Display window. (See Ovation Developer Studio User Guide.) To create a new graphic in the Developer Studio 1. From the Ovation Developer Studio system tree, drill down to Graphics and select either Diagrams or Macros . 2. Pull down the Operation menu, and select Insert New. Note: You must initiate the New function from the Macros node when creating a new macro graphic. You can also access the Operation menu by highlighting Diagrams or Macros and right-clicking on the Overview window. The Insert New Diagrams Wizard displays.
OW330_90
39
3.5 What are the differences between the online and offline Graphics Builder? 3. Enter the name of the diagram in the Name entry field. Press the Finish button. Do not enter the .src or .diag file name extension in the entry field. The Studio appends the filename extensions for you when the new diagram files are created. The diagram name is no t case sensitive. The New Diagrams window displays. 4. Enter the diagram description/title in the Description entry field. The description can be up to 60 characters and can include blanks. This parameter is optional and may be left blank. Press the OK button.
The diagram name, entered in Name entry field, is carried over from the Insert New Diagrams window and is read-only.
The diagram type, shown in Type pull-down menu, is read-only and is defined by the hierarchy node that initiated the Insert New process. That is, if this function was invoked from the Macros node in the Studio hierarchy, then the diagram type is set to Macro. If it was invoked from any of the Diagrams nodes, the diagram type is set to Normal. Note that you cannot change from type Normal to type Macro or vice versa.
5. After entering the required data in the New Diagrams window, press the OK or Ap pl y button to create the new graphic in the database and invoke the online the Graphics Builder with the new, empty graphic .src file loaded. The corresponding .diag file is not created until a Save function is performed.
3.5.4 What is the Open fun cti on? In the offline version of the Graphics Builder, the Open function is accessed when you pull down the File menu on the main Graphics Builder window and select Open. In the online (Studio) version of the Graphics Builder, diagrams cannot be opened from within GBNT. The Open menu item on the online Graphics Builder’s File menu is inactive, as well as the associated toolbar button. Diagrams are opened from within the Ovation Developer Studio. Once a diagram is opened in the online version (see page 40) via the Ovation Developer Studio, you cannot open a new diagram in the same window. The only way to open a new diagram is via the Ovation Developer Studio, in which case a new Graphics Builder main window will be invoked. In contrast, diagrams can be opened in the offline version (see page 96) of GBNT either by using the Open menu item or the Open toolbar button. In the offline version, you can change to another diagram from the Graphics Builder:Open window, and you will always re-use the same instance of GBNT. Note that the online version of GBNT loads the source version of a graphic when opening it; there is no way to load the corresponding .diag file from within the Ovation Developer Studio. Since there is no support for loading the .diag versions of graphics from within the Ovation Developer Studio, it is imperative not to lose source files as they cannot be recreated from the .diag files as in the offline version. Either the source or the object format of a graphic may be loaded into the offline version of GBNT. Also note that you cannot take a .diag file generated from the online version and load it into the offline version of GBNT to recreate the .src file if it has any System IDs compiled into it because the offline version of GBNT cannot access the database to translate the stored System ID into a point name. To Ope n an existing graphic in the De veloper Studio 1. From the Ovation Developer Studio, highlight Diagrams or Macros under Graphics in the System tree.
40
OW330_90
3.5 What are the differences between the online and offline Graphics Builder? A list of the available diagrams appears in the Workpad window. Note: You must initiate the Open function from the Macros node to open a macro graphic. 2. Highlight the diagram to open in the Workpad window. 3. Pull down the Operation menu, and select Open . (You can also double-click on the diagram name in the Workpad window to open the diagram.) The Ovation Developer Studio invokes the Graphics Builder main window to display with the specified diagram already loaded.
3.5.5 What is the Compi le fun cti on? In the offline version of the Graphics Builder, the Compile function is accessed when you pull down the File menu on the main Graphics Builder window and select Compile . In the online (Studio) version of the Graphics Builder, diagrams cannot be compiled from within the Graphics Builder other than by saving the currently loaded graphic. The Compile menu item on the online Graphics Builder’s File menu is inactive, as well as the associated toolbar button. Diagrams must be compiled online (see page 41) from within the Ovation Developer Studio. In contrast, diagrams can be compiled within the offline version (see page 100) of the Graphics Builder either by using the Compile menu item or the Compile toolbar button. In the offline version, you can compile one or more diagrams by selecting them on the GBNT:Compile window, which will use the same instance of the Graphics Builder to perform the compile. To Compile a graphic in
the De veloper Studio
1. From the Ovation Developer Studio, in the Overview window, highlight Diagrams or Macros under the Graphics node in the System tree. A list of the available diagrams appears in the Workpad window. 2. Highlight the diagram to compile in the Workpad window. To compile all of the diagrams, highlight Graphics under the System tree. 3. Pull down the Operation menu, and select Compile . The Ovation Developer Studio invokes a new instance of the Graphics Builder to do the compile in the background. The Graphics Builder window does not display, but the Compilation Output window displays to show the compilation status. All compile output is written to both the window and to a list file. Note: In a multinetwork system, if the online version of the Graphics Builder is invoked from a read-only location, you are no t be able to compile the graphic. The Graphics Builder displays “Read-Only GBNT” in the title bar so that you know you are viewing a graphic in a read-only system.
OW330_90
41
3.5 What are the differences between the online and offline Graphics Builder?
3.5.6 What is the Saving fun ctio n? In the offline version of the Graphics Builder, the Save function is accessed when you pull down the File menu on the main window and select Save or Save As . Diagrams are saved in both the online and offline versions of the Graphics Builder by selecting the Save menu item on the File menu and/or by selecting the associated toolbar button. Behind the scenes, the online version updates the database by storing any System IDs used in the diagram and any macros used in the diagram. If the diagram being saved is a macro, the online version also gives you the option to recompile all graphics which use that macro. No such option exists in the offline version and it is your responsibility to recompile graphics which call a macro after changing the macro. However, the Save As function differs between the online and offline versions. The online Save As function displays a different window than the offline version. The online version only allows you to specify a new name, not a new path, for the diagram. The new diagram is always created in the same hierarchy node in the Ovation Developer Studio. Note: In a multinetwork system, if the online version of the Graphics Builder is invoked from a read-only location, you are no t able to save the graphic. The Graphics Builder displays “Read-Only GBNT” in the title bar so that you know you are viewing a graphic in a read-only system. In contrast, you can save to any file name or directory in the offline version (see page 97).
42
OW330_90
3.6 Variables
3.6
Variables GB supports local, global, and system named variables in graphics. These variables may be used in a graphic file wherever a process point (or $P pointer) is used with the following exceptions:
POINTER Command
PTR_EQUAL Command
PTR_MOVE Command
PTR_VALUE Command
Note: These commands set init, $P, and/or $H pointers only. A variable will have a name and a type. The types supported are:
int,
real,
string,
sysid,
array of ints,
array of reals,
array of strings.
For array type variables, the maximum number of array elements must be defined when the variable is defined – dynamic arrays are not supported. Arrays of sysid type variables are not supported. Named variables can NOT be passed for arbitrary arguments in the graphic source file (for example: x, y coordinates, line width, and so forth). DEF_VARIABLE (see page 45) and SET_VARIABLE (see page 47) also support variables.
3.6.1 Namin g Variables Variable names:
Can contain alphanumeric characters, -, and _ only.
Must begin with a letter.
Cannot contain blanks.
Are limited to 40 characters.
Are not case-sensitive.
Cannot be interactively changed once they are defined; they must be deleted and re-created.
Variables that are used in the loaded graphic cannot be deleted interactively.
The size of array type variables cannot be decreased after they are defined. GB performs bounds checking on array type variables at compile time.
Are differentiated rom other reserved words or database point names in the graphic source by the following: Local variable names are prefixed with L.
OW330_90
Global variables are prefixed with G.
System variables are prefixed with S:
43
3.6 Variables For instance, to use a local variable named Temp in some command, enter L:temp in the source syntax. Note: Variable references are not delimited by backslashes. \L:temp\ is a data base point named L:temp – not a local variable. System Variables System variables are prefixed with "S", they are read-only variables that any graphic can use. System variables are defined internally and cannot be created, defined or edited. System variables list: diagram_type
Local Variables The scope of local variables is the .src graphic file where they are declared.
44
Local variables in a main screen are local to the main screen (associated subscreens and/or
pop-ups cannot access them). Local variables in a macro are local to each instance of that macro.
Local variables to a pop-up window are local to that pop-up.
Local variables to a subscreen are local to that subscreen.
OW330_90
3.6 Variables Global Variables The scope of global variables is the set of main/sub/pop-up windows associated with a given graphics window (W1-W4).
Global variables are not shared between main screen graphics (W1,W2,W3,and/orW4) - even if they are displayed concurrently on the same CRT.
Global variables are not system globals!
Global variables become active within a graphics window (for example: W1-W4) when a graphic is initially displayed and not until:
If/when a subscreen or pop-up window is displayed,
Its global variables become active, If/when a subscreen or pop-up window is dismissed.
Its global variables are freed if they are not also declared in the main screen.
When the main screen changes:
All of the global variables for the main screen and its pop-up windows are freed.
The global variables associated with the new main screen become active.
If a new subscreen is displayed with the new main screen, the old subscreen global variables are freed.
Each graphic that wants to use a global variable (read or write) must declare it in its .src file by way of the DEF_VARIABLE (see page 45) command; if the main screen wants to share data with a subscreen and a pop-up window, then the main screen, the subscreen, and the pop-up must each declare the global variable in its respective .src file.
Since global variables declared in the main screen remain active as long as the main screen is displayed, it is possible to share global data across changing subscreens or changing pop-up windows as long as the main screen remains the same.
DEF_VARIABLE The DEF_VARIABLE command is only valid in the diagram section, and defines the variable. A variable must be defined before it can be used in a graphic. Selecting the ‘expose’ (see page 47) menu item will add a DEF_VARIABLE command for the global variable to the parent graphic, the variable will no longer be grayed-out on the variables dialog, and you will be able to use it in the parent graphic from that point on.
3.6.2 To open the Variables dialog 1. Select one of the following to open the Variable dialog:
OW330_90
The "V" located at the end of the File Toolbar.
The ‘Variables…’ menu item from the View menu.
The CTRL+ALT+V shortcut key
45
3.6 Variables The Variables dialog appears.
2. The local and global variable lists have right-click menus (see below) from which you can:
Add a new variable (see page 46),
Delete an unused variable (see page 47),
Expose a variable (see page 47),
Increase the size (see page 47) of an array type variable,
Create an associated SET_VARIABLE (see page 44) command in the graphic.
3.6.3 To add a new local or global variable 1. Open the Variable dialog (see page 45). 2. Right-Click on the variable, in the local or global window, to be set. Note: There is no right-click menu for the system variables because they are read-only.
46
OW330_90
3.6 Variables 3. Select "new variable", the "Add new variable" dialog appears.
3.6. 4 To Delete a Variab le To Delete a local/global variable. 1. Open the Variable dialog (see page 45). 2. Right-Click on the variable, in the local or global window, to be set. 3. Select "delete variable", the variable will be deleted.
3.6. 5 To Expo se a Variab le The parent graphic cannot use these variables unless it first ‘exposes’ them. 1. Open the Variable dialog (see page 45). 2. Right-Click on the variable, in the local or global window, to be set. 3. Select "expose variable", the "expose variable" dialog appears. Selecting the ‘expose’ menu item will add a DEF_VARIABLE (see page 45) command for the global variable to the parent graphic, the variable will no longer be grayed-out on the variables dialog, and the user will be able to use it in the parent graphic from that point on.
3.6.6 To I ncr ease the size of a Variable To increase a local/global variable. 1. Open the Variable dialog (see page 45). 2. Right-Click on the variable, in the local or global window, to be set. 3. Select "increase size", the "increase size" dialog appears.
3.6.7 To use the SET _VARI ABL E com mand The SET_VARIABLE command is used to set the value of a local/global variable. The SET_VARIABLE command is valid everywhere except the keyboard section, and is used to set the value of a defined variable. 1. Open the Variable dialog (see page 45). 2. Right-Click on the variable, in the local or global window, to be set.
4. Choose the section from the drop-down menu. 5. Specify the source line # where the new source command will be placed. The line# must be within an existing multi-line command. The SET_VARIABLE command will be added after the last line of the command at the input line#. 6. Select a name.using the rules set in "Naming variables (see page 43)" 7. Define the "value".
The ‘examples’ button displays a help window containing sample possible values for the given type of variable you are setting. Note that a parenthesized math-type expression is valid for int/real type variables.
48
Brackets will be used to reference an element of an array type variable in the source syntax. For example, assuming that name is defined as a local variable of type array-of-int, to reference the nth element of name in a command, use L:name[n].
The array index, n, may be specified as an integer, or as another named variable of type int.
A process point cannot be used as an array indexer. If a variable is used as an array indexer, it must be declared as type int (not real, or array-of-int or sysid).
Only points resolving to an Ovation sysid can be assigned to a sysid type variable (i.e. no OPC pts).
‘Sysid’ type variables may have an associated 2-char ascii record field paired with them in the graphic source syntax (i.e. L:my_sysid_var AV).
Only sysid-type variables can be passed to macros for $D points.
Variables of type int, array-of-int, real, and array-of-real may be passed to macros for $CONSTn parameters.
There is NO support for passing ascii-type variables to macros for $T strings!!!
OW330_90
3.7 What is the main Graphics Builder window?
3. 7
When a macro is added to a graphic, its global variables are internally added to the parent graphic .diag file (but no DEF_VARIABLE (see page 45) commands are added to the parent for the globals from the macro). These macro globals will appear grayed-out [inactive] on the variables dialog.
The parent graphic cannot use these variables unless it first ‘exposes (see page 47)’ them.
Wha t is the main Gra phic s Build er windo w? When the Graphics Builder is started, the main window displays in the workspace. This window consists of a base frame with a pull-down menu panel, toolbars, drawing canvas, horizontal and vertical scrollbars, and a footer for displaying messages. The Graphics Builder window title bar reads “GBNT” when no graphic is currently loaded. If a graphic is currently loaded, the loaded filename (less the file path and file extension) is appended to the window title bar. If a diagram name is defined, it also is appended. The filename and diagram name are separated by a dash and are in parenthesis. For example, if the currently loaded graphic is 1800.src and the name is “System Status Diagram,” the window title bar reads, “ GBNT (1800 — System Status Diagram).” If no name for 1800.src was defined, the window title bar reads, “ GBNT (1800).” Note: The Graphics Builder is displayed on a CRT, and a cursor positioning device (mouse or trackball) is used to access the menus and windows. For editorial simplicity, the cursor positioning device is referred to as a “mouse” throughout this manual.
OW330_90
49
3.7 What is the main Graphics Builder window?
3.7.1 Wha t is the in pull-down menu panel? The pull-down menu panel displays the following items:
File (see page 95) - used to load, save, print, and compile graphics.
Edit (see page 231) - displays some of the configurable parameters for the current edit session in the Graphics Builder.
View (see page 63) - displays other windows related to the Graphics Builder. There are also options that allow you to change the display of the drawing canvas (grid, handle/drag color, and so forth.)
Options (see page 87) - defines some of the configurable parameters for the current edit session. Unlike the the GBNT:Diagram Command window, the variable settings here apply only to the Graphics Builder edit session. Help - displays help on the Graphics Builder window.
50
OW330_90
3.7 What is the main Graphics Builder window?
3.7.2 What are the Graphic s Bui lder toolbars ? Toolbars provide quick access to the more frequently used Graphics Builder windows and functions. The main Graphics Builder window supports nine toolbars and the Integrated Source Editor (see page 299) supports one toolbar. Each toolbar button has an associated “tooltip” for that button. A tooltip is a short descriptive text string describing the button function. To see the tooltip for a particular button, pause the mouse pointer over the toolbar button. Toolbar buttons, like their associated menu items, can be active or inactive. If a function is currently not active, the associated toolbar button and menu item are inactive. If a function is valid, both the toolbar button and the menu item are active. All toolbar button functions can be accessed via a menu with the exception of the Draw toolbar buttons. Draw functions are only available through the toolbar. The display of toolbars can be toggled by pulling down the View menu and then selecting the Toolbars pull-right menu. This menu contains a menu item for each toolbar. If there is a check to the left of the menu item, that toolbar is currently displayed. It may be docked or floating. If there is no check beside the menu item, that toolbar is currently not displayed. Each of the toolbars is dockable and floatable. A toolbar is docked if it is attached to one of the sides of the main Graphics Builder window. A toolbar is floating if it is displayed as a pop-up window with a title and a window close button in the upper right corner. A floating toolbar can move anywhere on the screen. The Drawing Attributes toolbar can only be docked to the top or bottom of the main window (left or right docking is not available). The other toolbars can be docked to the left, right, top, or bottom on the main window. To move a docked toolbar, grab the toolbar background (that is, not on a button). Press and hold the left mouse button with the mouse pointer on the toolbar background. The toolbar outline is highlighted. Drag the toolbar to the desired place/position. Release the mouse button, and the toolbar is docked to that side. To float a toolbar, drag it to the center of the diagram, outside the main window, or anywhere on the screen that is not along the edge of the main window and release the mouse button. The toolbar changes to a pop-up window. Note that when a toolbar is floating, it is resizable. That is, you can grab a side of the floating toolbar with the mouse and resize the toolbar to change the layout. This configuration is only maintained while the toolbar is floating. If you dock the toolbar now, it is restored to its srcinal layout (a single row of buttons). The current toolbar state, including which toolbars are displayed, whether they are docked or floating, and where they are positioned, is saved when the Graphics Builder exits. When the Graphics Builder restarts, the saved toolbar state is restored. The toolbar states are saved automatically on exiting the Graphics Builder and are not affected by you selecting the Save Defaults function (see page 82). If running the Graphics Builder online from the Ovation Developer Studio, you may notice that your toolbars are being unexpectedly repositioned when opening graphics. This is because the default diagram width and height stored as part of the Save Defaults function is smaller than the graphic you are loading. To correct this, follow the steps below: 1. Open the largest graphic (in the width dimension) in the Studio. 2. Hand-place the toolbars as you want them. 3. Execute the Save Defaults function (see page 82). This stores the current diagram width and height as the default width and height.
OW330_90
51
3.7 What is the main Graphics Builder window? 4. Exit the Graphics Builder to re-save the toolbar state. What is the Main toolbar? The Main toolbar allows you to access such functions as new, open and compile.
Figure 5: Main Toolbar The following table shows each button on the Main toolbar. Main to olbar B UTTON
NAME
AND
D ESCRIPTION
New -- Erases the graphic currently loaded, thereby clearing the canvas. It also resets the Graphics Builder window title to reflect that no diagram is currently loaded. This function is not available in the online version. Open (Offline) -- Access the Open dialog for loading a new graphic into the main Graphics Builder window. This function is not available in the online version. Re-load (Online) -- Replaces the inactive online "Open" button. This allows a re-load of currently loaded graphics, saving quit and restart time. Save -- Saves the currently loaded graphic. Writes both the .src and the .diag format of the graphic. Compile --Displays the Compile window for compiling one or more graphic .src files. This function varies depending on whether the Graphics Builder is running in online or offline mode. Print -- Prints the Graphics Builder drawing canvas to the printer. No title/header is appended to the printout; it is just the canvas drawing area. Integra ted Source Editor -- Accesses the Integrated Source Editor window which allows you to edit the graphics source file. Generic Text Editor -- Accesses TextEdit, a generic, independent text editor package written specifically to be used to edit graphic source files. TextEdit provides a means to edit graphic source files in a more conventional editor package that supports cut and paste and free-form editing. Shape Library -- Accesses the Shape Library window which allows you to display, create, edit, and delete shapes in the Shape Library. Point Browser -- Displays the Point Browser dialog which is used to browse for points in the Oracle database. This function is only available when running the Graphics Builder online from the Ovation Developer Studio. Browse OPC Points -- Displays the Browse OPC Pts dialog which is used to browse the available OPC servers for OPC points. These points can then be dragged and dropped into any point entry field on any of the Graphics Builder dialogs. This function is only available when running the Graphics Builder online from the Ovation Developer Studio. Variable - Displays the dialog used to view, add, and edit diagram variables (local, global, and system).
52
OW330_90
3.7 What is the main Graphics Builder window? What is the Align/Equi-space toolbar? The Align/Equi-Space toolbar allows you to properly space and align your graphics.
Figure 6: Align/Equi-Space Toolbar The following table shows each button on the Align/Equi-space toolbar. Al ign/Equi -Space tool bar B UTTON
NAME
AND
D ESCRIPTION
Alig n L eft -- aligns the left edge of one item to the left edge of another item. Al ig n Ri gh t -- aligns the right edge of one item to the right edge of another item. Alig n To ps -- aligns the top edge of one item to the top edge of another item. Alig n B ot to ms -- aligns the bottom edge of one item to the bottom edge of another item. Al ig n Cen ter s -- aligns the center of one item to the center of another item. After performing this function, the items all have the same center. Al ig n Cen ter s Ver ti cal ly -- aligns the y coordinates of the centers of an item to the y coordinate of the center of another item. Al ig n Cen ter s Ho ri zon tal ly -- aligns the x coordinates of the centers of an item to the x coordinate of the center of another item. Horz Equi-Space -- uses the setting on the Equi-space dialog to set the number of virtual pixels between successive selected items/groups starting with the left-most item/group. Vert Equi-Space -- uses the setting on the Equi-space dialog to set the number of virtual pixels between successive selected items/groups starting with the top-most item/group. Set Horz/Ve rt Spacing -- displays the Equi-space dialog which allows you to set the number of virtual pixels between successive selected items/groups. Alig n X Or ig in s -- aligns the srcins of the selected items/groups along the x-axis (horizontally). Al ig n Y Or ig in s -- aligns the srcins of the selected items/groups along the y-axis (vertically). Object-to-Object Snap Mode item/group.
-- moves (snaps) one item/group to some point on another
Verte xt Edit Mode -- allows you to edit the individual vertices of lines, polygons, rectangles and rectangular types. Toggle Grid -- allows you to either display a grid on the screen or leave it off. Grid Options -- allows you to choose the display features of a grid. Snap-to-Grid -- snaps all of the selected items to the nearest grid mark.
OW330_90
53
3.7 What is the main Graphics Builder window? What is the Dra w to olbar? The Draw toolbar allows you to access the draw items.
The following table shows each button on the Draw toolbar. Draw to olbar B UTTON
NAME Toggle Multi-Draw Mode -- gives you the option of using multi-draw mode. Multi-draw mode allows you to draw several items of one type without selecting the button on the Draw toolbar each time. The default is off. Macro -- draws a macro, which are graphic files built within the Graphics Builder used to integrate a set of graphic commands into another diagram. Macro Notes & Parameter Descriptions -- allows you to interactively create/edit the macro parameter descriptions/labels, and to interactively create/edit macro notes/comments. Ar c -- draws an arc. Rubberba nd Arc -- draws a line that appears as a curve. Line -- draws a straight line. Rubberba nd Li ne -- draws a curved line. Circle -- draws a circle. Ellipse -- draws an ellipse. Polygon -- draws a polygon. Rectangle -- draws a rectangle. Dot -- draws a dot. OL Rectangle -- draws a rectangle that has a three-dimensional appearance. Bitmap Image - draws a bitmap image. OL Gauge -- draws a gauge that is partially filled based upon a process point value. The gauge has a three-dimensional appearance. OL Cylinder -- draws a cylindrical bar graph on a diagram that is partially filled based upon a process point value. The cylinder has a three-dimensional appearance. Bar/Polybar -- Bar draws a rectangle that is partially filled based upon a process point value. The PolyBar draws the outline of the polygon (in addition to filling the polygon based on the point value). Plot -- shows the current value of a process point plotted over time and scaled between a low and high value. XY Plot -- plots two points sampled over time against one another. Dynamic Lin e/Polygon -- plots a line or polygon which may have changing endpoints. Trend -- displays a graph that shows the current value of a process point sampled over time.
54
OW330_90
3.7 What is the main Graphics Builder window?
B UTTON
NAME Time -- displays the current time. Date -- displays the current date. Pt Group Text -- displays one of the three predefined point group text strings. Process Point -- displays the contents of a process point record field in ASCII format. Text -- allows you to display three different types of text. Shape -- displays the Shape Library window. Poke -- draws an invisible rectangular area that is activated when selected with the mouse. Entry Field -- defines an area of the process diagram for displaying information that is entered by an operator or obtained from an Ovation Operator Station application program. OL Slider -- draws a slider with a three-dimensional appearance, which is both an input and an output device. OL Check Box -- draws a check box item with a three-dimensional appearance, which is both an input and an output device. OL Choice -- defines a choice item with a three-dimensional appearance, which is both an input and an output device. Button -- defines a button with a three-dimensional appearance (similar to smart-ma style button), that is activated when selected with the mouse. OL Button -- defines a general style button. OL Event Menu -- defines a list of event or alarm conditions and the text messages to display if the conditions are met at runtime. This menu has a three-dimensional appearance. Function Key -- used to run one or more application programs from a function key. Page -- dialog used to configure the up/down/left/right paging for the current graphic.
What is t he Drawing attrib utes toolbar? The Drawing Attributes toolbar allows you to define color, font and line appearance for draw items.
Figure 7: Dra wing Attributes Toolbar The following table shows each button on the Drawing Attributes toolbar. Drawing attribu tes toolbar B UTTON
NAME
AND
D ESCRIPTION
Display/Set Active Place (pull-down menu) draw graphics.
OW330_90
-- allows you to set the desired place to
55
3.7 What is the main Graphics Builder window?
B UTTON
NAME
AND
D ESCRIPTION
Set/Show Source Line # (entry field) -- allows you to specify a source line number within the place specified. The source line number and the place must always match. Change Place - Allows you to change the place srcinally specified for selected draw items. If you change the place, the source line number updates to the last line of that section. Color -- displays the Color dialog used to set or change the current drawing colors for items on a graphic. Font Attributes -- displays the Font Attributes window used to set the font type and size for items on a graphic. Fill Patterns -- displays the Fill Pattern dialog used to define the type of fill pattern that may be used for a draw item. Line Patterns -- displays the Line Pattern dialog used to define the type of line pattern that may be used for a draw item. Line Width -- displays the Line Width dialog used to define the size of the line width that may be used for a draw item.
What is the Edit toolbar? The Edit toolbar allows you to access such functions as cut, copy, paste, and delete.
Figure 8: Edit Toolbar The following table shows each button on the Edit toolbar. Edit toolbar B UTTON
NAME
AND
D ESCRIPTION
Cut -- Erases all of the currently selected items on the screen and copies them to an internal buffer for pasting later. Copy -- Copies all the currently selected items on the screen to the internal buffer for pasting later. Paste -- Prompts you to press the left mouse button and drag a "paste" rectangle. The paste rectangle is sized to what was previously copied to the internal buffer via the Cut or Copy functions. Release the left mouse button to add (paste) the copied or cut items to the current graphic. Delete -- Erases all of the currently selected items on the screen. Undo -- Undoes the last edit. Only the last edit can be undone. Selecting this option again after an undo has the affect of redoing the srcinal operation. Properties -- Displays the current drawing attributes (color, line/fill pattern, and so forth) in the associated attribute window for the currently selected item. Select Mode -- Cancels out of any edit in progress and returns you to the default select mode. Note that this is not an undo, which cancels the previously completed edit. This cancels the
56
OW330_90
3.7 What is the main Graphics Builder window?
B UTTON
NAME
AND
D ESCRIPTION
edit currently in progress.
Group -- Internally combines all of the selected items into a single entity (group) in the current edit session. Grouping is only effective during the current edit session. Ungroup -- Separates a group into individual items which can be edited. Note that this menu item does not dissociate macros.
What is the Invert/Rotate toolbar? The Invert/Rotate toolbar allows you to change the position of draw items.
Figure 9: Invert/Rotate Toolbar The following table shows each button on the Invert/Rotate toolbar. Invert/Rotate toolbar B UTTON
NAME Invert Horizontally Invert Vertically
-- flips the graphic side to side.
-- flips the graphic up and d own.
Rotate C lockwis e -- moves the graphic clockwise the number of degrees specified on the Rotation Increment window. Rotate C ounterclockwis e -- moves the graphic counterclockwise the number of degrees specified on the Rotation Increment window. Set Rotation Increment -- displays the Rotation Increment window which allows you to specify the number of degrees of rotation for a draw item.
What is the Resize toolbar? The Resize toolbar allows you to access such functions as pin center on resize, unconstrained resize, and set scale factors.
Figure 10: Resize T oolb ar
OW330_90
57
3.7 What is the main Graphics Builder window? The following table shows each button on the Resize toolbar. Resize toolbar B UTTON
NAME
AND
D ESCRIPTION
Pin Center on Resize -- the center of a draw item remains pinned (fixed) during a resize. Pin Opposi te Handle on Resize -- the opposite corner/side of a draw item remains pinned (fixed) during a resize. Unconstrained Resize -- aspect ratio (ratio of width and height) of any display item or group is not maintained on a resize operation. Maintain Aspect Ratio Size -- aspect ratio (ratio of width and height) of any display item or group is maintained on a resize operation. Resize-by-Factor -- used to resize the selected item or group as defined by the factors on the Scale Factors window. Set Scale F actors -- displays the Scale Factors window which sets the width and height scale factors that are used in conjunction with the Resize-by-factor edit function.
What is the Show/Hide toolbar? The Show/Hide toolbar allows easy access to layered display items or a graphic.
The following table shows each button on the Show/Hide toolbar. Show/H ide toolbar B UTTON
NAME
AND
D ESCRIPTION
HIDE SEL -- Hides the selected items on the graphic. HIDE !SEL -- Hides everything but the selected items on the graphic. HIDE PL -- Hides all items in the current place. HIDE !PL -- Hides all items not in current place. SHOW -- Shows all hidden graphics.
58
OW330_90
3.7 What is the main Graphics Builder window? What is t he Zoom toolbar? The Zoom toolbar allows you to access the zoom functions.
Figure 11: Zoom Toolbar The following table shows each button on the Zoom toolbar. Zoom toolbar B UTTON
NAME
AND
D ESCRIPTION
Full View -- displays the entire graphic in the Graphics Builder canvas. This is the default view. Zoom by Corners -- prompts you to drag a rectangle to specify the area of a graphic to zoom in on. Zoom In -- allows you to zoom in on the current view by a defined percentage. Zoom Out -- allows you to zoom out of the current view by a defined percentage. Recall Backwards -- displays the view that was shown before the current view within the zoom queue.
3.7.3 What is Error handl ing ? Errors detected while doing any of the interactive editing functions (that is, draw, rotate, resize, and so forth) are displayed in pop-up error dialogs. These error dialogs are called blocking dialogs which means that they must be acknowledged before any other actions can be taken within the Graphics Builder. Note that they are only blocking to the Graphics Builder process; other applications can be used. Errors may also be displayed in the footer area of the window. In addition to the error message, beeps are generated when source editor errors are detected.
OW330_90
59
3.8 What are the Keyboard shortcuts for the Graphics Builder?
3. 8
Wha t are the Keyboard
shor tcuts for
the Gra phics Builder?
Keyboard shortcuts allow the Graphics Builder windows and functions to be accessed by keystroke combinations instead of selecting the item with the mouse. The main Graphics Builder window must have the keyboard focus to use the keyboard shortcuts (a window with keyboard focus is the window that keyboard events go to and is indicated by the top bar of the window being highlighted). Also, the associated menu item must be active at the time you press the keyboard shortcut. For example, if no items are currently selected, the Group menu item is not active. Therefore, the “Group” shortcut key is also inactive. The following tables list the keyboard shortcuts for functions as they are listed under their pull-down menu for the main Graphics Builder window. Keyboard shortcut s accessed by File menu M ENU I T E M
S HORTCUT
New
Ctrl + N
Open
Ctrl + O
Save
Ctrl + S
Save As
Ctrl + A
Print
Ctrl + P
Batch - Compile
Shift + C
Create image
Ctrl + I
Keyboard shortcuts M ENU I T E M
accesse d by Edit menu K EYBOARD
S HORTCUT
Undo
Ctrl + Z
Cut
Ctrl + X
Copy
Ctrl + C
Paste
Ctrl + V
Delete Properties Select Mode
60
K EYBOARD
Del Shift + A Esc
Group
Ctrl + G
Ungroup
Shift + G
Unshape
Ctrl + U
Resize-by-factor
Ctrl + R
Vertex edit
Shift + V
Object-to-object snap
Shift + O
Snap to Grid
Ctrl + Y
OW330_90
3.8 What are the Keyboard shortcuts for the Graphics Builder? Keyboard shortcuts M ENU I T E M
Toolbars
accesse d by View menu K EYBOARD
S HORTCUT
(no keyboard shortcuts)
Diagram Config
Shift + D
Integrated Source
Shift + S
Generic Text Editor
Shift + T
Shape Lib
Shift + H
Zoom
(see individual items on menu)
Variables
Ctrl + Alt + V
Page
Alt + P
Full View
Shift + F
Zoom by Corners
Shift + Z
Zoom By Box
Shift + B
Zoom In
Shift + I
Zoom Out
Shift + U
Zoom In/Out Factor
Shift + P
Hide Selected items
Ctrl + H
Show Hidden items
Ctrl + Alt + H
Keyboard shortcuts accessed by Options menu M ENU I T E M
K EYBOARD
S HORTCUT
Resize scale factors
Shift + R
Multi-draw mode
Ctrl + M
OW330_90
61
S
ECTION
4
Using t he View menu
IN THIS SECTION What items are available on the View menu? ................................................................... 64 What Configuration window?..................................................................... 65 What is is the the diagram integrated source editor?................................................................................ 68 What is the generic text editor?......................................................................................... 69 What is the Shape Library? ............................................................................................... 75 What is the Zoom menu? .................................................................................................. 75 To use Keyboard Repaint Order ....................................................................................... 78 To use Handle/Drag Color ................................................................................................. 79 To use Coordinate Display ................................................................................................ 79 What is a Grid?.................................................................................................................. 80 What is the Save Defaults function? ................................................................................. 82 What is the Point Browser? ............................................................................................... 83 What is browsing for OPC points? .................................................................................... 84
OW330_90
63
4.1 What items are available on the View menu?
4. 1
What items are available
on the View menu?
The windows found under the View pull-down menu are related to the look and feel of the Graphics Builder application. In addition, other Graphics Builder"sub applications" are found on this menu, such as Integrated Source Editor, Generic Text Editor, and Shape Library. The View menu provides the following items:
Toolbars (see page 51)
Diagram Configuration (see page 65)
Integrated Source Editor (see page 299)
Generic Text editor (see page 69)
Shape Library (see page 277)
Variables
Keyboard Repaint Order (see page 78)
GB poke_fld display
Handle/Drag Color (see page 79)
Coordinate Display (see page 79)
Grid (see page 80)
Grid Options (see page 80)
Save Defaults (see page 82)
Point Browser (see page 83)
Browse OPC Points (see page 84)
Hide Selected items (see page 58)
Hide non-selected items (see page 58) Hide current place (see page 58)
64
Page Zoom (see page 75)
Hide not in current place (see page 58)
Show hidden items (see page 58)
OW330_90
4.2 What is the diagram Configuration window?
4. 2
Wha t is the diagram
Configuration
windo w?
The Diagram Configuration window sets the display variables for the diagram. The variables defined here affect how the diagram appears at the Ovation Operator Station. To access the Diagram Configuration window, pull down the View menu on the main Graphics Builder window, and select Diag Config .
Figure 12 : Diagram Configuration Window
OW330_90
65
4.2 What is the diagram Configuration window?
4.2.1 Dia gram config uration window
fields
Diagram configuration windo w fields W INDOW F IELDS
D ESCRIPTION
Type
Allows you to define the diagram’s type. Choose one of the following options: Main is the primary area for a diagram. Main screen diagrams can be resized at the Ovation Operator Station. Subwindow displays a subwindow. On the Windows platform, subwindows are displayed within the main window in a split screen format. You can configure the subwindow to be displayed at the bottom portion of the main screen. The initial width of the subwindow corresponds to the width of the main screen. The initial height is a fixed 100 pixels. You have the ability to resize the width and height of the subwindow once displayed, but the aspect ratio of the diagram is maintained. Window displays menus, data entry fields, or other diagrams associated with a main diagram. Once the dimensions are set, you cannot resize a window diagram at the Ovation Operator Station. Control is used in conjunction with the Control Builder. (See Ovation Developer Studio User Guide or Ovation Control Builder User Guide.)
The default entry for Type is Main . Associated Subwin #
If Subwindow is selected for Type, this is the number associated with the subwindow.
Name
Defines the name of the diagram. A maximum of 60 characters may be used.
Revision
Defines the revision level of the diagram. Valid range is 0 through 2,147,483,647.
Update Rate
Defines how often the process diagram updates on the Ovation Operator Station. The update rate is the rate at which the foreground section of a graphic updates. You may specify the update rate in seconds (1 through 60 is the valid range) using the entry field when the Update Rate drop-down menu is set to seconds . You may also choose a defined rate in tenths of a second (0.1 through 0.9) from the Update Rate drop-down menu. The default value is 1 second .
Position
Defines the position of the graphic window. The choice buttons determine whether or not the diagram displays at the same position as the last diagram displayed on the particular Ovation Operator Station window. Once the diagram initially displays, you can move the diagram as desired. Fixed — the diagram does not display at the same position. X and y coordinates must be entered (see below). Default —the diagram displays at the same position. X and y coordinates are ignored. x — x coordinate for the position of the upper left corner of the graphic window on the Ovation Operator Station at run-time. This parameter is ignored at run-time if the Default option is selected. Valid range is 0 through 1151. y — y coordinate for the position of the upper left corner of the graphic window on the Ovation Operator Station at run-time. This parameter is ignored at run-time if the Default option is selected. Valid range is 0 through 899.
66
OW330_90
4.2 What is the diagram Configuration window?
W INDOW F IELDS
D ESCRIPTION
Size
Defines the size of the graphic window. The choice buttons determine whether or not the diagram is sized to the dimensions of the last displayed graphic on the particular Ovation Operator Station window. Once the diagram initially displays, you can resize the diagram as desired. Fixed — the diagram is not sized to the same dimensions. W and h dimensions must be entered (see below). Default — the diagram is sized to the same dimensions. W and h dimensions are ignored. w — width of the canvas area of the graphic. This parameter is ignored at run-time if the Default option is selected. Valid range is 100 through 3200. h — height of the canvas area of the graphic. This parameter is ignored at run-time if the Default option is selected. Valid range is 100 through 1200.
Background
Allows you to select either a solid color for the background of a diagram or a bitmap image. The selection here determines the background of the Graphics Builder drawing canvas as well as the background of the diagram at the Ovation Operator Station. The default for this option is solid color white . Color — Select any of the eight standard colors (black, blue, green, cyan, red, magenta, yellow, and white) or select a custom color (see page 317). Bitmap — Bitmap background filename less the “.bmp” extension. When running the Graphics Builder in the offline mode, these files reside in [InstallationPath]/mmi/graphics/cstfiles (where “InstallationPath” is a user-defined directory). When running the Graphics Builder from the Ovation Developer Studio, these files must be imported using the Import Graphics program (see page 325).
Zoomable (check box)
Determines whether or not zoom is permitted when a diagram displays on the Ovation Operator Station. If this check box is checked, zoom is permitted; if the box is not checked, zoom is not permitted. The default for this option is checked ( zoomable ).
4.2.2 To set or chang e the D iagram C onf igu ration parameters 1. Pull down the View menu on the main Graphics Builder window, and select Diagram Configuration . The GBNT:Diagram Configuration window displays. 2. Pull down the Type menu and select one of the following diagram types:
Main window
Window
Control (not to be used by the user)
3. Enter the name of the diagram in the Name entry field. 4. Enter a revision level for the diagram in the Revision entry field. 5. From the Update Rate drop-down menu, select one of the following
OW330_90
Select one of the frequencies listed on the Update Rate menu. From this menu, you only have the option of the fractional update rates listed. OR If the update rate is to be a whole number of seconds, select seconds on the Update Rate menu. Enter the seconds in the entry field to the right of the menu. The entry field is inactive (grayed out) if you select one of the fractional update rates.
67
4.3 What is the integrated source editor? 6. Define the position of the graphic window with the Position choice buttons. The choices are:
Fixed —the diagram will not display at the same position. X and y coordinates must be entered (see below).
Default — the diagram will display at the same position. X and y coordinates are ignored.
(x) — x coordinate for the position of the upper left corner of the graphic window on the Ovation Operator Station at run-time.
(y) — y coordinate for the position of the upper left corner of the graphic window on the Ovation Operator Station at run-time.
7. Define the size of the graphic window with the Size choice buttons. The choices are:
Fixed — the diagram will not be sized to the same dimensions. W and h dimensions must be entered (see below).
Default —the diagram will be sized to the same dimensions. W and h dimensions ignored.
(w) — width of the canvas area of the graphic.
(h) — height of the canvas area of the graphic.
8. From the Background drop-down menu, select one of the following options:
solid color — The Color scrolling list becomes active (the Bitmap list is grayed out). Select any of the eight standard colors (black, blue, green, cyan, red, magenta, yellow, and white) or any of the custom colors (see page 317).
bitmap — Bitmap background filename less the “.bmp” extension. When running the Graphics Builder in the offline mode, these files reside in [InstallationPath]/mmi/graphics/cstfiles (where “InstallationPath” is a user-defined directory). When running the Graphics Builder from the Ovation Developer Studio, these files must be imported using the Import Graphics program (see page 325).
9. At the zoomable toggle option, determine whether or not zoom is permitted when a diagram displays on the Ovation Operator Station. Click on the option and a checkmark appears in the box. Zoom is permitted.
Click on the option again, and the checkmark disappears. Zoom is not permitted.
10. After all of the options on the GBNT:Diagram Configuration window have been set, choose one of the following buttons:
4. 3
Ok — Saves the selected settings, and qui ts the GBNT:Diagram Configuration window.
Ap pl y — Saves the selected settings, but the GBNT:Diagram Configuration window remains open.
Cancel — Quits the GBNT:Diagram Configuration window without saving any changes.
Wha t is the integrated
sour ce editor?
The integrated source editor allows you to edit the graphics source file. Refer to Using the Integrated Source Editor (see page 299) for more information.
68
OW330_90
4.4 What is the generic text editor?
4. 4
Wha t is the generic
text editor?
TextEdit is a generic, independent text editor package written to be used specifically to edit graphic source files. It is invoked solely from the Graphics Builder, but it is not part of the Graphics Builder. TextEdit is designed to provide a means to edit graphic source files in a more conventional editor package that supports cut-and-paste and free-form editing. To access TextEdit, pull down the View menu on the main Graphics Builder window, and select Generic Text Editor . The TextEdit window appears. Note: The Integrated Source Editor is a command-based editor that requires inserting/editing a single command at a time and does not support cut-and-paste of source from other graphics. TextEdit supports standard Open, Save, and Print functions, as well as Cut, Copy, Paste, and Undo. The standard Find and Replace functions have been enhanced to search in a circular loop (that is, it does NOT quit searching at the end of the file). Line number support has been added to TextEdit, as well as support for viewing graphic compile errors and support for subsequent recompilation. The following table provides a brief description of the menu options. TextEdit menu option s MENU
M ENU O PTION
D ESCRIPTION
File
New
Erases the currently loaded text file, thereby clearing the canvas in preparation for a new file.
Open
Displays a window for loading an existing text file into the main window.
Save
Saves the currently loaded text file.
Save As
Saves the currently loaded text file under a new name.
Print
Sends the text file displayed on the window to a printer.
Print Preview
Allows you to see what will be printed before actually printing.
Print Setup
Allows you to specify printer, paper size, print mode, and so forth.
Edit
Search
View
Exit
Quits the TextEdit window.
Undo
Undoes the last edit.
Cut
Erases all of the currently selected items on the screen and sends them to the internal buffer for pasting later.
Copy
Copies all of the currently selected items on the screen to the internal buffer for pasting later.
Paste
Adds the copied or cut item to the new location in the text file.
Goto line#
Display a window that allows you to jump to a specific line by entering the line number.
Find
Allows you to search for and find text.
Replace
Allows you to insert new text in place of other text found in the file.
Compile Output
Compiles the text file.
Toolbar
Toggle option that allows you to either show or hide the toolbar.
Status Bar Help
OW330_90
About TextEdit
Toggle option that allows you to either show or hide the status bar. Displays the version of TextEdit that is running.
69
4.4 What is the generic text editor?
Note: TextEdit is NOT part of the Graphics Builder; it is only invoked by the Graphics Builder. Once it is invoked, the Graphics Builder and TextEdit do not communicate again. When changes are made in TextEdit, the Graphics Builder main window and the Integrated Source Editor do not update accordingly. To view the changes in the Graphics Builder, the graphics source file must be reloaded. Recompiling the file from within TextEdit does NOT update a version of the file currently displayed/loaded in the Graphics Builder. TextEdit is designed to work only with graphic source files. Graphic Source files have a “.src” file extension. If you attempt to open or save a file which does not have a “.src” file extension, an error generates and the open/save aborts. In the Ovation Developer Studio environment, TextEdit gives you the ability to edit the graphic source files in the database without having to know where the files reside on disk. TextEdit can only be invoked from a graphic in the data base. It is not possible to access TextEdit with no graphic loaded, nor is it possible to create/open a new graphic or switch to another graphic from within the TextEdit (online). Once TextEdit is running in the Ovation Developer Studio, you only have access to the graphic from which it was invoked. When running the Graphics Builder offline, you can open/create new graphics and/or switch to other graphics from within TextEdit. In a multi-network system, if the Generic Text Editor is invoked from a graphic on a read-only system, the Save and Compile options within the text editor are disabled. Note that when the Graphics Builder displays a graphic on a read-only system, the title bar shows “Read Only GBNT.” This serves as a visual clue that you are viewing a remote graphic in a read-only system.
4.4.1 TextEdi t dif ferences Differe nces between TextE dit and int egrate d source editor
70
T EXTEDIT
I NTEGRATED
S OURCE E DITOR
Allows you to make as many changes as desired, without having to select/deselect one command at a time. Compilation after making changes in TextEdit occurs on demand by pressing the Recompile button on the Compile Output window. At that time, the entire file is compiled.
Forces you to add/edit a single command at a time, and that command is compiled automatically when you deselect the command. Only the affected command is compiled.
Supports cut and paste of graphic source code.
Does not support cut and paste of graphic source code.
No handshaking occurs between the Graphics Builder and TextEdit. In fact, there is no way to have any Graphics Builder window update after making changes in TextEdit other than by saving the file in TextEdit and then re-opening the updated file in the Graphics Builder.
Constant handshaking occurs between the main Graphics Builder window and the Integrated Source Editor. When a change is made in the integrated source editor, the display in the Graphics Builder updates as soon as the command is deselected and compiled. When a command is selected in the integrated source editor, special handles are displayed around the associated item (if applicable) in the Graphics Builder.
The Replace function does no t prompt you before making the replace.
The Replace function gives you the choice to be prompted at each occurrence found before the replace.
Does not display line numbers in the view pane. TextEdit does not contain an auto-save feature.
Displays line numbers in the view pane. The Graphics Builder (and therefore the integrated source editor) contains an auto-save feature. This may prevent you from losing hours of changes if the program were to exit ungracefully.
OW330_90
4.4 What is the generic text editor?
4.4.2 To open T extEdit files The TextEdit Open window is used to display graphic source files for editing. This window shows the diagram directory where the files are stored and a scrolling list of the files already present in the directory. 1. Pull down the File menu on the main TextEdit window. 2. Select Open from the File menu. . 3. To specify the directory from which to open the file, pull down the Look in menu, and select a directory. The subdirectories for this directory display in the list. The buttons to the right of the Look in menu are, from left to right:
Go up one directory
Create a new fo lder — creates a new directory under the current directory.
List — Displays only the file names in the window.
Detail — Gives detailed information on the files in the list such as size of file, type, and date last modified.
— goes to the directory above the current directory in the hierarchy.
4. Specify the file to open by selecting a file from the scrolling list, or type the name in the File name entry field. 5. Pull down the Files of t ype menu and select the type of files to appear in the list. 6. Select the Open button to load the file into TextEdit. To quit the window without opening a file, select the Cancel button. Note: The TextEdit Open function is not available in the online version of the Graphics Builder.
4.4.3 To save TextEdit fil es TextEdit provides two functions for saving a file. The Save function is used to save a currently loaded source file. If this option is used to save a previously saved file to the same name and directory, no window will display. Note: The file will be automatically compiled as well. The Save As function saves the currently loaded file to the file name specified on the TextEdit Save As window. The Save As window is used to save a previously saved file to a new directory or file name. This window also appears when you select the Save function for a first-time save of a file. 1. Pull down the File menu on the main TextEdit window. 2. Select Save (for a first-time save of a file) or Save As (to save a previously saved file to a new directory/name). The TextEdit Save As window appears. 3. To specify the directory from which to save the file, pull down the Look in menu, and select a directory. The subdirectories for this directory will display in the list. The buttons to the right of the Look in menu are, from left to right:
OW330_90
Go up one directory
— goes to the directory above the current directory in the hierarchy.
71
4.4 What is the generic text editor?
Create a new fo lder — creates a new directory under the current directory.
List — Displays only the file names in the window.
Detail — Gives detailed information on the files in the list such as size of file, type, and date last modified.
4. Specify the file to save by selecting a file from the scrolling list, or type the name in the File name entry field. The file name must end with a “.src” extension. If saving an existing file, select the file to overwrite from the Files scrolling list. 5. Pull down the Save as typ e menu and select the type of file that it will be saved as. The only choice is Diag and Source files (*.diag and *.src). 6. Select the Save button to save the file. To quit the window without saving, select the Cancel button. 7. Note that as a result of the save, the file will be automatically compiled. Any errors will be written to the TextEdit Compile Output window.
4.4.4 To pri nt a TextEdi t fil e The Print option is used to send the TextEdit file to the printer. The standard Windows Print dialog box is used to perform the print. To access this window, pull down the File menu on the main TextEdit window, and select Print . The Print window has the following options:
Name — Lists the names of the printers that are available for printing.
Status — Gives status of printing (ready, processing, and so forth).
Type — Shows the type of printer to be used for the print.
Where — Shows the location of the printer being used.
Comment — Gives any comments about the printer.
Print to File -- Allows you to send the information to a file instead of a printer. Print Range -- Allows you to print the entire file or only certain pages.
Copies -- Allows you to specify how many copies to print.
Properties -- Displays another window that defines the fields on the Print Setup window.
Select the OK button to send the file to print. To exit the Print window without printing, press the Cancel button.
72
OW330_90
4.4 What is the generic text editor? To setup a print Print Setup displays the standard Windows Print Setup window which allows you to specify a printer, paper size, print mode, and so forth. The window has the following options:
Name — Lists the names of the printers that are available for printing.
Status — Gives status of printing (ready, processing, and so forth).
Type — Shows the type of p rinter to be used for the print.
Where — Shows the location of the printer being used.
Comment — Gives any comments about the printer.
Size — Lists size of the paper available to be used for printer (letter, 11 x 14, and so forth).
Source — Determines the source of the paper (from where the paper is coming from). The choices are Automatically Select, Cassette, or Manually Feed.
Orientation — Allows you to choose between Portrait (prints vertically) or Landscape (prints horizontally).
Properties — Displays another window that defines the fields on the Print Setup window.
Network — Displays another window that shows the network connections for the printers defined.
Note: Pressing the OK button does NOT send the file to print. It only confirms the settings on the Print Setup window. To exit the Print Setup window without saving any changes, press the Cancel button.
4.4.5 When do you compi le a TextEdit fil es? Compiling a file translates the source version (*.src) to the object version (*.diag). There are several when times TextEdit when a file is compiled TextEdit. If a graphic is currently loaded in the Graphics Builder is invoked, the in graphic source file will be automatically compiled and then loaded into TextEdit. When a file is saved in TextEdit, it will also be automatically compiled. Finally, you may choose to compile a file at any time by pulling down the View menu on the TextEdit window and selecting Compile Output . Any errors in the file are displayed in the TextEdit's Compile Output window. From this window, you may view the errors, and then select the Recompile button when corrections are made.
4.4.6 Navigating
thr oug h TextEdit fil es
The Find (see page 74), Replace (see page 74) and GotoLine # (see page 75) options allow you to quickly and easily navigate through your TextEdit file.
OW330_90
73
4.4 What is the generic text editor? To use the F ind opti on The TextEdit Find option allows you to search the source file for specified strings. For example, if you want to find the string "le," each line of the file is checked for occurrences of "le." When the string is found, it is highlighted in reverse video. You can then continue to search for additional occurrences. Use the following procedure to use the Find function: 1. Pull down the Search menu on the main TextEdit window, and select Find . The Find window appears. 2. Enter the characters or string to search for in the Find what entry field. 3. Searching is no t case sensitive by default. Select the Match case checkbox to make searching case sensitive. 4. Select a Direction for the search. The choices are either up or down. Note that no matter which direction is selected, the search will proceed in a circular loop, meaning that it will no t quit searching at the end of the file. 5. Select the Find Next button. The search starts at the cursor position in the file and proceeds either up or down depending on the direction selected. The search ends when a match is found or when the search loops back to the srcinal starting position. If a match is found, the characters are displayed in reverse video. At this point, you can either quit the search or hit the Find Next button again to continue the sea rch for other occurrences of the string. To use the Replace option The TextEdit Replace option allows you to search the source file for specified strings and replace the string with other valid strings. For example, if you choose to replace all occurrences of the string "solid" with "dashed," each line of the file is checked for occurrences of "solid," and any matches areif replaced with "dashed." Note that when the Find what portion of the window find a if a string even it is part of a token. For example, replacing the string “solid” withwill “dashed,” line in the source file contains “near_solid,” that string will be replaced with “near_dashed.” Use the following procedure to use the Find function: 1. Pull down the Search menu on the main TextEdit window, and select Replace . The Replace window appears. 2. Enter the characters or string to search for in the Find what entry field. 3. Searching is no t case sensitive by default. Select the Match case checkbox to make searching case sensitive. 4. If a replacement is desired for the match, enter the characters or string in the Replace with entry field. 5. Select the Find Next button. The search starts at the cursor position in the file and proceeds either up or down depending on the direction selected. The search ends when a match is found or when the search loops back to the srcinal starting position. If a match is found, the characters are displayed in reverse video. 6. Al Select the Replace button to replace current instance of the found. Select Replace l to replace every occurrence of thethe match in the file. Select thematch Cancel button to end the find and replace function.
74
OW330_90
4.5 What is the Shape Library? To use the Goto Line # option The Goto Line # option allows you to jump to a specific line in your TextEdit file. 1. Pull down the Search menu on the main TextEdit window, and select Goto line# . The TextEdit Goto Line # window appears. Notice that the total number of lines in the file is displayed on the window. 2. Enter a line number in the line # entry field. 3. Select the Goto button. The TextEdit view pane pages to the specified line, moves the cursor to the first character of the line, and highlights the given line in reverse video. To quit the Goto Line# window, select the Close button. The Goto Line# dialog can be used in conjunction with the Compile Output dialog to view/correct errors. Go to the given line of an error, correct the error, repeat for the next error, and so forth, until all errors are corrected. Then, press the Recompile button on the Compile Output window to recompile the entire file. All errors have been fixed when only the loaded filename displays in the compile output listbox. The file is automatically saved when the Recompile button is pressed.
4. 5
What is the Shape Lib rary? The Shape Library encompasses a set of shapes that is shared between graphics in the system. There can be up to 1000 shapes defined in the shape library. For more information, refer to Using the Shape Library (see page 277).
4. 6
What is the Zoom menu? The Zoom menu (located on the View menu on the main Graphics Builder window) allows you to change the magnification for viewing all or part of a graphic. Z OOM M ENU ITEM
D ESCRIPTION
Full View
Displays the entire graphic on the Graphics Builder canvas. It is what is displayed when the diagram is initially loaded. Any time you want to return to this view, simply select Full View from the Zoom menu. This is the default view.
Zoom by Corners
Prompts you to drag a rectangle to specify the area of a graphic in which to zoom. Aspect ratio of the graphic is no t maintained. If this menu item is inactive (grayed out), you have already zoomed in as far as you can.
Zoom by Box
Displays a “view box” which, when placed over sections of the diagram, allows you to expand that particular area. This method of zoom maintains the aspect ratio of the graphic because the zoom rectangle has the same aspect ratio as the graphic.
Zoom In
Allows you to zoom in on the current view by a percentage (10%, 50%, and so forth). The center of the current view remains constant.
Zoom Out
Performs the opposite function of the Zoom In function. It allows you to zoom out by a percentage (10%, 50%, and so forth). The center of the current view remains constant.
Zoom In/Out Factor
Allows you to set the percentage of magnification for the Zoom In and Zoom Out functions. For example, a zoom factor of 25 indicates that the current view increases in size by 25% each time the Zoom In function is selected.
Recall
Recall displays the view that was shown before or after the current view within the zoom queue. This menu item is inactive until you perform a zoom operation. You can repeatedly recall backward until the initial view is displayed or the first entry in the queue is reached. The maximum zoom queue size is five views. The zoom queue is emptied when you load
OW330_90
75
4.6 What is the Zoom menu?
Z OOM M ENU ITEM
D ESCRIPTION
a diagram, erases a diagram, or when you start up the Graphics Builder. A view is added to the end of the queue when you perform one of the following actions: Zoom In/Out. Zoom by Box. Zoom by Corners. Zoom To Area. Zoom to full view. When the queue is full and a new view is selected, the view at the beginning of the queue is removed to make room for the new view. Define Area
Allows you to save the current view for quick retrieval.
Zoom to Area
Accesses the areas defined in the Define Area option.
4.6.1 To use Zoom by Corners 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. Select Zoom by Corners . 2. Place the pointer on the drawing canvas. Press and hold the left mouse button, and drag a rectangle around the area in which to zoom. 3. Release the mouse button, and the desired area expands to the visible drawing canvas dimensions. 4. To return the diagram to its srcinal setting, select the Full View menu option on the Zoom menu.
4.6.2 To use Zoom by Box 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. Select Zoom by Box . A small box displays with the pointer. Note: You can increase the size of the view box by pressing down the Control key and left-clicking when the view box initially displays. You can decrease the size of the view box by right-clicking when the view box initially displays. 2. Without pressing any mouse buttons, move the box (by moving the pointer) to the area in which to zoom. As you move the mouse pointer on the Graphics Builder canvas, the center of the zoom rectangle follows the mouse. You cannot move the zoom rectangle off the canvas. 3. When the box is positioned over the selected area, left-click on the drawing canvas. The area that has been shown in the box expands to the zoom dimensions (see To use the Zoom In/Zoom Out Factor (see page 77) for more information on zoom dimensions). 4. To return the diagram to its srcinal setting, select the Full View menu option on the Zoom menu.
76
OW330_90
4.6 What is the Zoom menu?
4.6. 3 To us e Zoom I n Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. Select Zoom In . The entire drawing canvas expands by the percentage set on the GBNT:Zoom In/Out Factor (%) window. Note that increasing the zoom percentage causes the Zoom In function to zoom in by a larger amount and vice versa.
4.6.4 To use Zoom O ut Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. Select Zoom Out . The view zooms out from the current view based on the percentage set on the Zoom In/Out Factor (%) window. Note that increasing the zoom percentage causes the Zoom Out function to zoom out by a larger amount and vice versa. Note: You must Zoom In, Zoom by Box, Zoom by Corners, Zoom to Area, and so forth, before you can Zoom Out.
4.6.5 To use the Zoom I n/Out F actor 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. Select Zoom In/Out Factor. The GBNT:Zoom In/Out Factor (%) window displays. 2. To change the zoom percentage, position the pointer on the slidebar. Press and hold the left mouse button, and drag to move the slide on the zoom scale (to the right to increase, to the left to decrease). The zoom factor percentage updates as the slidebar moves. 3. or After adjusting slidebar, theTozoom factor percentageIn/Out change is immediate (thatpress is, nothe OK Apply button the is necessary). quit the GBNT:Zoom Factor (%) window, “x” button in the upper right corner of the window.
4.6. 6 To us e Recall 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. 2. Select Recall from the Zoom menu. Drag the pointer to the right to display another menu. 3. Select one of the following options: Backward — displays the previous view. Forward — displays the new view. This menu item is not active (grayed out) if you did not previously select Backward.
4.6. 7 To us e Defin e Ar ea 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. 2. Select Define Area from the Zoom menu. Drag the pointer to the right to display another menu. A list of numbers between 1 and 5 appears. 3. Select the area number for the defined area (1 through 5).
OW330_90
77
4.7 To use Keyboard Repaint Order You may define up to five areas (these areas do not need to be sequentially saved). Once an area is defined, it may be accessed through the Zoom to Area option described below. Note: The defined areas are only for the current editing session of a graphic. When the graphic is saved and exited (from the Graphics Builder), the defined areas are lost.
4.6.8 To use Z oom to Area 1. Pull down the View menu on the main Graphics Builder window. Go to Zoom , and pull right to display another menu. 2. Select Zoom to Area from the Zoom menu, and drag the pointer to the right to display another menu. A list of numbers between 1 and 5 appears. 3. Select the desired area number. Only area numbers that have been defined are active on this menu. The retrieved view is placed within the zoom queue so that it will be included when Recall is selected.
4. 7
To use Keybo ard Repaint
Order
Keyboard Repaint Order specifies the order in which the keyboard section should be displayed on a refresh of the screen in relation to the background, foreground, trigger and macro trigger diagram sections. 1. Pull down the View menu and select Keyboard Repaint Order . Pull right to display another menu. 2. Select one of the following choices:
First indicates that the keyboard items (poke fields, OL buttons, OL choices, entry fields, and so forth) should be displayed before the background, foreground, trigger and macro trigger sections (that is, macro the keyboard items will be displayed beneath background, foreground, trigger and trigger sections).
Last indicates that keyboard items should be displayed after the background, foreground, trigger and macro trigger sections (that is, the keyboard items will be displayed on top of background, foreground, trigger and macro trigger sections).
The default for this option is first . You can change the ordering of the keyboard at any time during the edit session.
78
OW330_90
4.8 To use Handle/Drag Color
4. 8
To use Handle/D rag Color Handle/Drag Color is used to change the color of the display handles on selected items and the color used while dragging items during the draw process. Sometimes, depending on the background color of the graphic or the items on the graphic, the handles are difficult to see. This window can be used to select another color which yields better contrast on the graphic. 1. Pull down the View menu, and select Handle/D rag Colo r . The Drag/Handle Color window appears.
Figure 13: Drag/Handle Color Window 2. Select one of the colors from the color list (if other than the default is desired). You can select any of the eight standard colors (black, blue, green, cyan, red, magenta, yellow, and white) or any of the custom colors (see page 317). Note: The drag/handle color is a function of the color selected and the color of what is on the graphic under the handle/drag lines. Therefore, selecting a new drag/handled color is a trial-and-error process. 3. After selecting a color in Step 2, the result is immediate (that is, no OK or Apply button is necessary). To quit the Drag/Handle Color window, press the “x” button in the upper right corner of the window.
4. 9
To use Coord inate Displ ay Coordinate Display defines where the current pointer coordinates should display on the main Graphics Builder window, or if they should display at all. 1. Pull down the View menu, and select Coordinate Display . Pull right to display another menu. 2. Select one of the following choices:
Off indicates that the coordinates will not display on the main Graphics Builder window. This is the default.
Footer indicates that the coordinates will display in the lower right corner of the main Graphics Builder window.
Pop-up indicates that the coordinates will display in a pop-up window (GBNT:Coords window). This window can be moved anywhere on the main Graphics Builder window and will remain open until you close it.
OW330_90
79
4.10 What is a Grid?
4. 10 What is a Grid? Grid allows you to display a grid on the screen. This grid is not part of the finished graphic. Since this option is a toggle, it is either on or off. To use this option, perform one of the following steps:
To turn this feature on, pull down the View menu, and select Grid . A checkmark appears next to the item. A grid appears on the drawing canvas.
To turn this feature off, pull down the View menu, and select Grid again. The checkmark disappears. The grid disappears.
Note: Whenisthe option is turned on, Snap is automatically turned on as well. If Grid is not used, Snap notGrid used either.
4.10. 1 To dis play and defi ne a gri d The Grid Options window allows you to choose the display features of the grid. 1. Pull down the View menu on the main Graphics Builder window, and select Grid Options . The Grid Options window displays.
Figure 14 : Grid Options Window 2. Choose if or how the grid displays from the Display options. The choices are off, lines , or dots . The default is of f . If off is selected, go to Step 8. 3. From the Order options, select first if the grid is to be displayed beneath the items on the graphic. Select last if the grid is to be displayed on top of the items on the graphic. The default is first . 4. Choose a color for the grid lines/dots from the Color scrolling list. You can select any of the eight standard colors (black, blue, green, cyan, red, magenta, yellow, and white) or any of the custom colors (see page 317). The default for this option is black .
80
OW330_90
4.10 What is a Grid? 5. Specify the type of pixels to use for the grid at the Units option. The choices are virtual and screen .
Virtual pixel grid cell dimensions change appropriately when you zoom/resize the graphic. Items snapped to the virtual cell grid remain on the grid after a zoom/resize. When the virtual grid is displayed, virtual grid line/dot locations are converted to screen pixels. Due to the rounding that occurs when converting virtual to screen pixels, it is probable that the grid lines are not evenly spaced as with the screen pixel grid. This guarantees that items drawn to the grid at full view remain on the grid when zoomed in.
Screen pixel grids do not change when you zoom/resize the diagram. This means that if you snap items to the grid, they are not guaranteed to be on the grid after a zoom/resize.
6. Enter the width of the grid cells in width entry field. The minimum screen grid cell width is 6 pixels; the minimum virtual grid cell width is the equivalent of 6 screen x pixels. These equivalents vary based on the canvas width and height. The maximum screen grid cell width is 1/4 the canvas width. The maximum virtual pixel grid cell width is 1/4(16,384) = 4096. 7. Enter the height of the grid cells in height entry field. The minimum screen grid cell height is 6 pixels; the minimum virtual grid cell height is the equivalent of 6 screen y pixels. These equivalents vary based on the canvas width and height. The maximum screen grid cell height is 1/4 the canvas height. The maximum virtual pixel grid cell height is 1/4(16,384) = 4096. 8. After all of the options on the Grid Options window have been set, choose one of the following buttons: Ok — Saves the selected settings, and qui ts the Grid Options window. Ap pl y — Saves the selected settings, but the Grid Options window remains open. Cancel — Quits the Grid Options window without saving any changes.
OW330_90
81
4.11 What is the Save Defaults function?
4.10 .2 What i s a Sn ap? Snapping only occurs during draw operations when a grid is displayed. No snapping occurs on move or copy functions. The Snap to Grid function (see page 255) can be used to snap items currently not on grid points to the grid, but it is only available when a grid is displayed. When a grid is turned on, snapping is automatically enabled on future draw operations, and the Snap to Grid function becomes active when one or more items are selected. When a grid is turned off, snapping is automatically disabled and the Snap to Grid function becomes inactive. When a grid of dots is displayed, all x, y mouse events on the drawing canvas snap to the nearest grid point during draw operations. When a grid of lines is displayed, all x, y mouse events snap to the nearest intersection point of the grid lines during draw operations. For example, when drawing a rectangle, you press down with the left mouse button to mark the upper left corner of the rectangle. The position of the mouse pointer (and therefore the position of the upper left corner of the rectangle) maps to the nearest grid point. As you drag the pointer to define the lower right corner of the rectangle, the position of the pointer snaps to the nearest grid pint with each successive drag event. When drawing a line or polygon, each time you move the pointer, the position of the pointer snaps to the nearest grid point. If one or more items are currently selected on the screen at the time a grid is displayed, those items do not automatically get snapped to the grid. The Snap to Grid function can be used to do this. Turning on the grid only affects future draw operations — it does not affect existing items. The source editor functions are not affected by the grid. No snapping occurs if a new command is typed into the source editor window — even if a grid is currently displayed. For example, if you enter a RECTANGLE command via the integrated source editor, the x, y, width, and height are used as entered (not snapped to grid points).
4. 11 What is the Save Defaults funct
ion ?
Save Defaults is used to save the current Graphics Builder working environment. This includes the current windows displayed, the positions of the windows displayed, the parameters on the Diagram Configuration window, the current load/save directory, and the initial values for the following Graphics Builder options: Grid, Drag/Handle Color, Keyboard Repaint Order, Coordinate Display, Autosave, Unresolved Points Warnings, Resize Options, Drag/Draw Constraint, and Multi-draw mode. After executing the Save Defaults function, these settings/windows appear the next time the Graphics Builder is started. The Windows registry is used to store and restore these values.
4.11. 1 To Use the Save Defaults
fun cti on
1. Select the desired parameters on the GBNT:Diagram Configuration window. Define what windows to display and the placement of these windows. Set any applicable Graphics Builder options as desired. 2. Pull down the View menu on the main Graphics Builder window. 3. Select Save Defaults from the View menu. The defined settings are saved. The next time the Graphics Builder opens, the settings will be used.
82
OW330_90
4.12 What is the Point Browser?
4. 12 Wha t is the Point Browser? This option displays the Point Browser dialog (see page 83) which is used to browse for points in the Oracle database. The window contains two tabs. The Filter tab is used to specify search criteria, and the Points tab displays the search results, a history list, and is used to initiate drag-and-drop operations. Both the point name and its English description display in the results list. This menu item is only available when running the Graphics Builder online from the Ovation Developer Studio and is inactive in the offline version of the Graphics Builder.
4.12. 1 To use the Poin t Br ows er dialo g (Filters t ab) 1. From the online Graphics Builder main window, pull down the View menu, and select Browse Points . This option is also found on the Main toolbar. The Pt Browser dialog appears.
2. From the Filter tab, specify the network . Note that only the local network is supported. This field cannot be left blank, since this is the only required field. 3. Pull down the unit menu, and select a unit. If a unit is not specified, all units are searched. 4. Pull down the drop menu, and select a drop. If a drop is not specified, all drops are searched. Note that the drop menu has no entries until you specify a unit from the unit menu. 5. If desired, enter search criteria for any or all of the following options: ptname , alias , description , and characteristics . If you do not specify any of these criteria, they are ignored in the search. Wildcards (% or *) can be used when specifying point name, alias and description. A dash (-) is the wildcard used for any unknown characters in the characteristics. 6. If desired, pull down the record type menu and select a record type to use in the search. 7. If desired, pull down the freq menu and select a frequency to use in the search.
OW330_90
83
4.13 What is browsing for OPC points? 8. Before completing the search, it may be necessary to select the re-scan network(s) button. This is used to update the units/drops menus in the event that units/drops have been added or removed since the Graphics Builder was invoked and the units/drops choices displayed on the dialog are not current. 9. Press the Search button. The PtBrowser dialog automatically switches to the Points tab (see page 84) and display the results. What is t he Points tab on th e PtBrowser dialog? When a point is selected from the list on the Points tab, it is copied into the entry field below the list. You can type into this entry field, also. As you type, character by character, into this field, the points list scrolls to find the first match. The entry field contains a drop-down menu, which is used to implement the history list. A point name is only added to the drop-down history list when you complete a drag-and-drop operation. The history list has no limit on the number of past used point names. You may either drag and drop from the point in the results scrolling list, the history list or the entry field to any applicable field of a Graphics Builder dialog. However, drag and drop is not supported into the integrated source editor or the generic text editor.
Figure 15: Pt Browser Window (Points Tab)
4. 13 Wha t is browsing for OP
C poin ts?
OPC (Ole for Process Control) points are used to access data on OPC servers. This data is external to the Ovation System. OPC point names (or tags) in graphics are of the following format: OPC$servertag$pointtag
84
OW330_90
4.13 What is browsing for OPC points? where: OPC$
The first four characters of any OPC name must be “OPC$”
servertag
Logical name of the OPC server. It is comprised of alphanumeric characters only.
$
Mandatory placeholder
pointtag
Name of the point or tag. This portion can contain any characters (including spaces and backslashes).
The Browse OPC Points dialog is used to browse the available OPC servers for OPC points. From this dialog, you can drag and drop a selected OPC point name to any point entry field on any of the Graphics Builder dialogs. The browse for OPC points function is only available when running the Graphics Builder online from the Ovation Developer Studio and is grayed out on the offline version.
4.13. 1 To cho ose an OPC server to
bro wse
1. From the online Graphics Builder main window, pull down the View menu, and select Browse OPC Pts. The Main toolbar also shows the Browse OPC points button when the Graphics Builder is running online. The Browse OPC points window appears.
Figure 16: Brows e OPC Pts Windo w 2. Select an OPC server from the "Available OPC servers" scrolling list. The Available OPC Servers scrolling list contains all of the OPC servers you have access to from your computer. The available OPC servers are added to the Windows registry as part of the Ovation Developers Studio installation. If an entry in the list is grayed-out, that means that it is defined in the registry, but the Graphics Builder could not successfully connect to it. 3. Press the Brow se OPC button to access the OPC Item Browser dialog.
OW330_90
85
4.13 What is browsing for OPC points? The OPC Item Browser dialog allows you to browse the currently selected OPC server from the list of available OPC servers. The information is implemented in a hierarchy. Click on the plus/minus signs to expand groups. Left-click on a leaf (the rightmost element that does not have a plus/minus sign to the left of it), to select an OPC point.
Figure 17: OPC Item Brows er 4. Select an OPC point in the hierarchy. The name displays in the Item ID field at the bottom of the window. Press the OK button on the window to complete the browse. 5. Once the OK button is pressed, the OPC point name is copied to the OPC Point field on the Browse OPC Pts window. The Graphics Builder adds to the OPC point name with the expected “OPC$server$” string (where server is the selected OPC server) before making the copy. 6. Once the fully qualified OPC point name is copied to the OPC Point field, you can drag and drop it into any valid entry field on any of the Graphics Builder dialogs. The required leading and trailing backslash characters which specify a point name in graphics are automatically added during the drag-and-drop operation. Note that if you cut and paste from the OPC Point field instead of performing a drag-and-drop operation, you must add the required backslash characters yourself in the Graphics Builder entry fields. Also note that the OPC Point field is a read-only field; you cannot type into it. Note: You cannot drag point names from the Item ID field; only from the OPC Point field. 7. To close the Browse OPC Pts window, press the “x” button at the top right corner of the dialog.
86
OW330_90
S
ECTION
5
Using the O ption s menu
IN THIS SECTION What items are available on the Options menu? ..............................................................87 To Ratio function .......................................................................... 88 To use use the the Resize Resize Aspect Pin Point function ................................................................................ 88 What is the Resize-by-Factors (Scale Factors) function?.................................................88 What is the Drag/Draw Constraint?................................................................................... 89 What is the Multi-draw mode? ........................................................................................... 90 What do unresolved points do?......................................................................................... 90 What does AutoSave do?.................................................................................................. 92 To set AutoSave Frequency.............................................................................................. 92 What is Conditional Word Wrap? ...................................................................................... 92 What is the Macro Notes/Param Information menu? ........................................................93 To set Undefined Description Warnings............................................................................ 93 Option for Highlighting Selection in Tab Controls .............................................................94
5. 1
What items are available
on the Optio ns menu?
The windows found under the Options pull-down menu define some of the configurable parameters for the current edit session. Unlike the GBNT:Diagram Command window (found on the View menu), the variable settings here apply only to the Graphics Builder edit session. The following items are found on the Options menu: Resize Aspect Ratio (see page 88)
Resize Pin Point (see page 88)
Resize Scale Factors (see page 88)
Drag/Draw Constraint (see page 89)
Multi-Draw Mode (see page 90)
Unresolved Points (see page 90)
Unresolved Points Warning (see page 91)
AutoSave (see page 92)
AutoSave Frequency (see page 92)
Conditional Word Wrap (see page 92)
Macro Notes/Parameter Information (see page 93)
Undefined Description Warnings (see page 93)
Macro w/invalid parameter counts
OW330_90
Retain Grouping on File Save Highlight selection in Tab Controls (see page 94)
87
5.2 To use the Resize Aspect Ratio function
5. 2
To use the Resize Asp ect Ra tio fun cti on This option determines whether or not the aspect ratio (ratio of width and height) of any display item or group should be maintained on a resize operation. If this option is activated, the outlining rectangle continually snaps to the nearest coordinate that maintains its proportions. 1. Pull down the Options menu, and select Resize Aspect Ratio . Pull right to display another menu. 2. Select one of the following choices:
Ignore indicates that the aspect ratio will no t be maintained.
Maintain indicates that the aspect ratio will be maintained.
Note: Set the resize aspect ratio option to maintain so that shapes and macros will not skew after rotated by non-90 degree increments.
5. 3
To use the Resize Pin Point fun cti on This option displays the resize pin point menu. The pin point specifies what point on an object remains fixed when you drag a handle for resize. 1. Pull down the Options menu, and select Resize P in Poi nt . Pull right to display another menu. 2. Select one of the following choices:
5. 4
Center of object indicates that the center of the object remains fixed.
Opposite handle indicates that the opposite side/corner remains fixed.
What is the Resize- by-Factor
s (Scale Factors ) fun cti on?
This option sets the width (see and height scalefrom factors which are used in factors conjunction with the Resize-by-factor function page 241) the Edit menu. These determine the amount by which the selected item sizes in the width and the height dimensions when the Resize-by-factor function is selected (you can only resize one item or group at a time by a factor). These factors are independent of one another, and can be set to any positive real number other than 0. The default for both of these factors is 2.000. For example, if the width factor is set to 2.000 and the height factor is set to 0.500, then the item’s width doubles and the height is halved when resized by factor.
5.4.1 To use the Resize -by-Fa cto rs functi on 1. Pull down the Options menu, and select Resize Scale Fa cto rs . The Scale Factors window displays.
Figure 18: Scale Factors window
88
OW330_90
5.5 What is the Drag/Draw Constraint? 2. Set the width by entering a positive real number, greater than 0, in the width entry field. 3. Set the height by entering a positive real number, greater than 0, in the height entry field. 4. After both of the options on the Scale Factors window have been set, choose one of the following buttons: Ok — Saves the selected settings, and qu its the Scale Factors window. In addition, if exactly one item/group is currently selected, that item/group is scaled accordingly. Ap pl y — Saves the selected settings, but the Scale Factors window remains open. In addition, if exactly one item/group is currently selected, that item/group is scaled accordingly. Cancel — Quits the Scale Factors window without saving any changes. Note: The Resize-by-factor function overrides the aspect ratio setting. That is, even though the Resize Aspect Ratio option may be set to “maintain”, the Resize-by-factor function resizes the selected item by the specified width/height factors regardless of whether aspect ratio changes or not.
5. 5
What is the Drag/D raw Const raint ? This function controls the direction that the mouse pointer can be moved during Move and Duplicate functions, and/or on line and polygon draw functions. Drag/Draw Constraint does not affect dragging/drawing rectangle-based items (bars, rectangles, poke fields, and so forth) or text-based items (text, process points, entry fields, and so forth). It does not affect dragging for resize or paste operations, and it has no affect when you are in vertex edit mode (see page 246). The vertex edit menu contains its own constraint pull-right menu.
5.5.1 To Use Drag/D raw C ons train t 1. Pull down the Options menu, and select Drag/Draw Constraint . Pull right to display another menu. 2. Select one of the following choices:
None allows you to drag an item or group without any restrictions during move/duplicate functions. It also allows you to drag vertices without any restrictions during line/polygon drawing.
Horz only allows horizontal dragging during move/duplicate functions. It also allows only horizontal AND vertical line segments (determined by whether delta x or delta y is greater) to be drawn during line/polygon draw mode. This option is identical to Vert for line/polygon drawing.
Vert only allows vertical dragging during move/duplicate functions. It also allows only horizontal AND vertical line segments (determined by whether delta x or delta y is greater) to be drawn during line/polygon draw mode. This option is identical in function to Horz for line/polygon drawing.
The default for this option is none .
OW330_90
89
5.6 What is the Multi-draw mode?
5. 6
What is the Multi-d raw mod e? The Multi-draw Mode option allows you to draw several items of one type without selecting the button on the GBNT:Draw toolbar each time. The default for this option is of f , which means that only one item is drawn and then draw mode is cancelled. When Multi-draw Mode is off, the toolbar button must be selected again if you wish to draw another of the same item. If this option is on , you may continue to draw the selected item repeatedly until deselecting the Multi-draw Mode option. If the draw item has an associated parameter dialog, it allows you to repeatedly draw the item without having to press the OK/Apply buttons on the parameter dialog. To turn Multi-draw mode on, left-click the first button (from left) on the GBNT:Draw toolbar. If Multi-draw Mode is on and you select a new button from the GBNT:Draw toolbar, the multi-draw option remains in effect with the newly specified item. Whenever a button is selected (whether in multi-draw mode or regular draw mode), a message appears in the left footer of the main window displaying the current draw mode. As soon as you exit draw mode, the message clears. When Multi-draw mode is turned on, you cannot select or deselect items, move items, resize items, and so forth until exiting out of draw mode. The only events that are processed during draw mode are those used to draw the current item. You can manually exit multi-draw mode and return to normal selection by one of the following methods:
5. 7
Press the Esc (Escape) key on the keyboard.
Select the Select Mod e menu item on the Edit menu.
Press the Select Mode toolbar button on the Edit toolbar.
Wha t do unresolv
ed point s do?
Unresolved Points (also known as dummy points) displays the Unresolved Points window with a list of the system IDs used in the graphic, but not yet defined in the Ovation database. When running in offline mode, the Graphics Builder is not communicating with any database, so all point names (other than $pointer names and OPC points) are interpreted as unresolved points. These may be fully qualified with a unit and network name or they may be unqualified. If the point name does not begin with an alphabetic character, or if it contains any characters other than alphanumerics, it must be delimited with backslashes. If it is a fully qualified name, it must be delimited with backslashes. Unresolved points allow a diagram to be created and compiled before the points are added to the Ovation database. When unresolved points are displayed in a graphic at runtime, they are inactive and have no value. Therefore, final testing of the diagram cannot take place until the unresolved points are added to the Ovation database and the diagram is recompiled and redisplayed. All unresolved points should be resolved into database points before the diagram is executed at runtime.
5.7.1 To dis play Unresolv ed Points 1. Pull down the Options menu on the main Graphics Builder window.
90
OW330_90
5.7 What do unresolved points do? 2. Selected Unresolved Pts from the Options menu. The Unresolved Points window displays.
Figure 19 : Unresolved Points Window The Unresolved Points window contains a scrolling list of the unresolved points currently used in the graphic. Press the Print button to print this li st to the printer via the standard Windows print mechanism. Press the Update Button to recheck the graphic for unresolved points and rebuild the list. The count field in the upper right corner of the window shows how many points exist in the scrolling list. If the show reasons checkbox is selected, a short description displays beside the point name, indicating the reason the point is unresolved. This list is updated at the following times:
Every time the Unresolved Points window is displayed.
When the diagram is saved/loaded depending on the setting for the Unresolved Points Warning (see page 91).
On demand when you press the Update button.
In addition, the Unresolved Points window is cleared when the New menu item is selected from the File menu. If configured, the Graphics Builder displays a notice window on all save/load operations if the graphic contains unresolved points. You must acknowledge the notice window before the load or save occurs.
5.7.2 To set an Unresol ved Points Wa rni ng This option allows you to choose if or when to be informed of unresolved points in a graphic. 1. Pull down the Options menu, and select Unresolved Pts Warning . 2. Pull to the right to display another menu with four choices:
of f — do not inform that unresolved points exist.
load only — inform during the file load/open process only.
save only — inform during the file save process only.
both — inform during both file save and load/open.
3. Select the desired choice.
OW330_90
91
5.8 What does AutoSave do?
5. 8
What does Aut oSave do? This option saves all changes to an opened graphic after the number of edits specified in the AutoSave Frequency window has been met. Since this option is a toggle, it is either on or off. To use this option, perform one of the following steps:
To turn this feature on, pull down the Options menu, and select Auto save. A checkmark appears next to the item. Changes automatically save to the graphic.
To turn this feature off, pull down the Options menu, and select Auto save again. The checkmark disappears. Changes do not automatically save.
The default for this option is of f . Note: Select the Restore Original menu item on the File menu to override any autosaves that have occurred since you last loaded the graphic. In a multinetwork system, if the online version of the Graphics Builder is invoked from a read-only location, the Autosave option does no t work. The Graphics Builder displays “Read-Only GBNT” in the title bar so that you know you are viewing a graphic in a read-only system.
5. 9
To set Aut oSave Frequency AutoSave Frequency specifies how many edit operations must occur before the graphic saves. This option is only valid when the Autosave option is on . Use the following procedure to set the autosave frequency. 1. Pull down the Options menu, and select Auto Save Freq uen cy. The AutoSave Frequency window appears.
Figure 20: AutoSave Frequency Window 2. Enter a value in the # edits entry field. Use the increment/decrement buttons to adjust the value, if necessary. Valid range is 1 through 100 (the default is 25). 3. Select the Ok button to save the setting and quit the AutoSave Frequency window. Press Cancel to quit the window without saving a ny settings.
5. 10 What is C ond iti onal W ord Wrap? The Conditional Word Wrap menu controls how many characters displays per line in one of the following windows when it is displayed from the Properties function (see page 245): Color, Blink, Fill Pattern, Line Patterns, Text, Process Point, and Shape Library (when not out for edit).
92
OW330_90
5.11 What is the Macro Notes/Param Information menu?
Note: This function is NOT used to control the word wrap when you are typing a conditional in the window fields. It is NOT used in the integrated source editor. It is only used for displaying existing conditionals on windows during a Properties function. To set the conditional word wrap, pull down the Options menu on the main Graphics Builder window, and select Conditional word wrap . Pull-right to display the following choices:
width of field (word wrap at the number of columns available in the given conditional text field. Note that each conditional text field is a different width)
60 columns
80 columns
91 columns 100 columns
max columns (132)
The currently selected setting has a black dot to the left of the menu item. There are no corresponding toolbar buttons for this menu. Setting conditional word wrap is a cosmetic issue only. When a conditional is displayed on the window, the conditional text is translated from the source code in the object file. During this process, the conditional is fully parenthesized and one long contiguous text string is generated. The word wrap setting determines the initial line break point(s) in the translated conditional string when it is being displayed. Tokens are never split between lines, so if the initial line break point would split a token, the algorithm that splits the conditional scans back to find the first break point that would not split a token. If that is not possible, the algorithm scans ahead from the initial break point. This setting does not specify an absolute number of columns/characters per line. It specifies a request for a certain number of columns when displaying. In addition,that complex conditionals (thatEach is, conditionals that begin/end with have some special formatting overrides this setting. individual conditional within the{,}) complex conditional begins on a new line. These individual conditionals word wrap according to the current word wrap setting, but the overall complex conditional does not.
5. 11 What is the Macro N otes/Param
Infor mation menu
?
The GBNT:Macro Notes & Information dialog is used to interactively create/edit the macro parameter descriptions/labels, the macro parameters default values, and the macro notes/comments. For more information, refer to Using the Macro Notes/Information Description option (see page 213).
5. 12 To se t U ndefined D
escriptio
n W arnings
The Graphics Builder can display a warning message if you attempt to save a macro graphic when there are undefined descriptions/labels for the macro parameters (remember that description/labels are not required). This will happen even if you never open the GBNT:Macro Notes & Parameter Descriptions window (if you configure the Graphics Builder to give these warnings). These warnings can be enabled/disabled via the Undefined Description Warnings menu item. 1. Pull down the Options menu on the main Graphics Builder window.
OW330_90
93
5.13 Option for Highlighting Selection in Tab Controls 2. Select Undefine d descriptio n warnings. (Note that this menu item will be inactive (grayed out) whenever the Macro Notes/Param Descriptions menu item is inactive. If there is a check mark beside the menu item, the warnings are enabled. If there is no check beside the menu item, the warnings are disabled.
5. 13 Option for H
ighli ghtin g S ele ction in Ta
b C ontro ls
This option highlights the selected tab in all tab controls. When set, the current selected tab will display in blue. Tab controls exist on the ShapeEditorGUI, the DrawShapeGUI, and the button dialog.
94
OW330_90
S
ECTION
6
Loading, sa ving, a nd c ompilin g gr aphics and graphics images
IN THIS SECTION What options are available on the File menu? .................................................................. 95 To displaying a new graphic (Offline)................................................................................ 95 What is the the Open window function? ............................................................................ 96 What is the purpose of the Save or Save As function?.....................................................97 What is the Print function? ................................................................................................ 99 To restore the srcinal diagram ....................................................................................... 100 What is the purpose of compiling graphics (Offline)?......................................................100 What is the Exit function in the Graphics Builder? ..........................................................109
6. 1
What opt ion s are available
on the File menu?
The File pull-down menu on the main Graphics Builder window is used to load, save, print, and compile graphics. This section describes these functions when the Graphics Builder is in the offline mode:
6. 2
Displaying a new graphic (see page 95)
Opening/reloading an existing graphic (see page 96)
Saving a graphic (see page 97) Printing (see page 99)
Restoring the srcinal diagram (see page 100)
Batch Compiling graphics (see page 100)
Creating diagram images (see page 108)
Exiting the Graphics Builder (see page 109)
To displ aying a new graphic
(O ffline)
The New menu item erases the Graphics Builder canvas in preparation for creating a new graphic. It essentially “unloads” the current graphic. It does no t delete the diagram file. 1. Pull down the File menu on the main Graphics Builder window. 2. Select New from the File menu. If using the toolbars, new is the first button on the Main toolbar. The Graphics Builder drawing canvas clears. Note: If changes have been made to the diagram since the last save, a window displays asking you to verify the unload operation. This function is not available in the online version.
OW330_90
95
6.3 What is the the Open window function?
6. 3
Wha t is the the Ope n wind ow funct ion? The GBNT:Open window is used to display a graphics file. This window shows the diagram directory where diagram files are stored and a scrolling list of the files already present in the directory. Note: This dialog is a blocking dialog, which means that once this dialog is displayed, you cannot do anything else in the Graphics Builder while the dialog is displayed.
6.3.1 To Open (offl ine) or Re load (onlin e) an existi ng graphi c To use the Open function (only when GB is offline): 1. Select Open from the File menu, or select the Open icon (second button) on the Main toolbar. The Open window appears. 2. To specify the directory from which to open the file, pull down the Look in menu, and select a directory. The subdirectories for this directory display in the list. The buttons to the right of the Look in menu are, from left to right:
Go up one directory
Create a new fo lder — creates a new directory under the current directory.
List — Displays only the file names in the window.
Detail — Gives detailed information on the files in the list such as size of file, type, and date last modified.
— goes to the directory above the current directory in the hierarchy.
3. Specify the file to open by selecting a file from the scrolling list, or type the name in the File name entry field. 4. Pull down the Files of type menu and select the type of files that appear in the list. The only choice is Diag and Source files (*.diag and *.src). 5. Select the Open button to load the file into the Graphics Builder. To quit the window without opening a file, select the Cancel button. If an object format file (.diag file extension) was specified, a warning window appears asking you to verify the load since comments and macros are lost. Press Yes to continue with the load, and press No to abort the load. If you elected to be notified of unresolved points (see page 90) on the load operation, a window appears at this time showing the unresolved points (if any exist) in the graphic being loaded. Note: The Open function is not available in the online version. To use the Reload function (only when GB is offline): 1. Select Re-load from the File menu, (the reload button replaces inactive online "Open" button). This button allows a re-load of currently loaded graphics, saving quit and restart time.
96
OW330_90
6.4 What is the purpose of the Save or Save As function?
6. 4
Wha t is the purpo se of the Sa ve or S ave As function? The Save function is used to save a currently loaded graphic. It writes both the .src and the .diag format of the graphic. If this option is used to save a previously saved file to the same name and directory, no window displays. For a first time save of a file, this option is identical to the Save As function (see page 97). If running the Graphics Builder online, the database information stored for each graphic is updated when it is saved. This information includes the system IDs used in the graphic and the macros used in the graphic, as well as the diagram name/description contained in the DIAGRAM graphic command. (See Ovation Graphics Language Reference Manual.) Note: When building graphics offline, Use the Import Graphics function (see page 325) to move the graphic to the Developer Studio. Make sure you check for errors as the import is processing. In the Developer Studio, perform a download of that graphic. Then load the updated graphic in a Graphics Display window.If creating a graphic online, save the graphic, then perform a download of that graphics in the Developer Studio.Then load the updated graphic in a Graphics Display window. (See Ovation Developer Studio User Guide.) The diagram object file size is limited to 2 MB. Before saving the diagram object file, the Graphics Builder calculates what the size of the diagram object file would be. If the size exceeds the limit, the diagram object file is NOT saved, and an error message is displayed stating that the size would exceed the limit and that the diagram object file will not be saved. The message also states that the only way to correct this issue is to start removing data from the graphic until the diagram file size is less than 2 MB. The Graphics Builder does not write the diagram object file to disk in order to check the file size - it internally calculates what the size would be from what is stored in the current Graphics Builder edit session. The diagram source file is always saved (assuming no errors exist); there is no limit on graphic source file size.
6.4.1 To use the Save or Sa ve As func tio ns The Save As function saves the currently loaded graphic to the file name specified on the Save As window. The Save As window is used to save a previously saved graphic to a new directory or file name. This window also appears when you select the Save function for a first-time save of a graphic. This dialog is a blocking dialog, which means that once this dialog is displayed, you cannot do anything else in the Graphics Builder while the dialog is displayed. 1. Select Save (for a first-time save of a graphic) from the pull down the File menu (you can also select the third button on the Main toolbar) or select Save As (to save a previously saved file to a new directory/name). The Save As window appears. Note: This window appears in a different way in the online version of the Graphics Builder. 2. To specify the directory from which to save the file, pull down the Look in menu, and select a directory. The subdirectories for this directory display in the list. The buttons to the right of the Look in menu are, from left to right:
Go up one directory
Create a new fo lder — creates a new directory under the current directory.
List — Displays only the file names in the window. Detail — Gives detailed information on the files in the list such as size of file, type, and date last modified.
OW330_90
— goes to the directory above the current directory in the hierarchy.
97
6.4 What is the purpose of the Save or Save As function? 3. Specify the file to save by selecting a file from the scrolling list, or type the name in the File name entry field. The file name must end with a “.src” or “.diag” extension. If saving an existing diagram, select the file to overwrite from the Files scrolling list. It is recommended that you choose a number as the diagram name. The valid diagram ranges are listed in Valid diagram numbering ranges (see page 98). 4. Pull down the Save as typ e menu and select the type of file saves. The only choice is Diag and Source files (*.diag and *.src). 5. Select the Save button to load the file into the Graphics Builder. To quit the window without opening a file, select the Cancel button. Both the source and object file formats are saved. After the save is complete, the diagram remains on the screen until you load another graphic or manually unloads the current graphic with the New function (see page 95). If you elected to be notified of unresolved points (see page 90) on the load operation, a window appears showing the unresolved points if any exist in the graphic being loaded. Note: When building graphics offline: Use the Import Graphics function (see page 325) to move the graphic to the Developer Studio. Make sure you check for errors as the import is processing. In the Developer Studio, perform a download of that graphic. Then load the updated graphic in a Graphics Display window. If creating a graphic online, save the graphic, then perform a download of that graphics in the Developer Studio. Then load the updated graphic in a Graphics Display window. (See Ovation Developer Studio User Guide.) Valid d iagram numbering r anges D IAGRAM
N UMBER
D IAGRAM
TYPE
S CREEN T Y P E
1 - 699
System
Subwindow
700 - 989
Customer
Subwindow
990 - 999
System
Subwindow
1000 - 1999
System
Main
2000 - 3999
Customer
Main
4000 - 4999
System
Main
5000 - 6999
Customer
Main
7000 - 8499
Customer
Window
8500 - 8999
System
Window
Diagram 299 is a standard blank window. Diagram 1600 is typically the system overview window. Diagram 4999 is a standard blank main window. Diagrams 612, 623, 8618, 8630, 8646, 8662, 8705, 8719, and 8721 are typically reserved.
Note: The file name extension (.src or .diag) is required for the save operation. Either format (.diag or .src) may be selected for the save. Both file formats are written. For example, you could enter “5432.src” or “5432.diag” in the File name entry field and “5432.src” and “5432.diag” would both be written.
98
OW330_90
6.5 What is the Print function?
6. 5
Wha t is the Print functi on? Print sends the Graphics Builder drawing canvas to the printer. No title/header is appended to the printout; it is just the drawing canvas area. You simply pull down the File menu, and select Print . The standard Windows print mechanism is used to perform the print. It is assumed that you have a printer properly configured on your system.
6.5.1 What is the Print Preview
win dow ?
Print Preview allows you to see what will be printed before actually printing. This option is useful in determining when/if a change to the print setup is needed. Note that while the print preview window is displayed, you cannot quit the Graphics Builder or resize the window.
6.5.2 What is the Print Se tup wind ow? Print Setup displays the standard Print Setup window which allows you to specify a printer, paper size, print mode, and so forth. The window has the following options:
Name — Lists the names of the printers that are available for printing.
Status — Gives status of printing (ready, processing, and so forth).
Type — Shows the type of p rinter to be used for the print.
Where — Shows the location of the printer being used.
Comment — Gives any comments about the printer.
Size — Lists size of the paper available to be used for printer (letter, 11 x 14, and so forth).
Source — Determines the source of the paper (from where the paper is coming from). The choices are Automatically Select, Cassette, or Manually Feed.
Orientation — Allows you to choose between Portrait (prints vertically) or Landscape (prints horizontally)
Properties — Displays another window that defines the fields on the Print Setup window.
Network — Displays another window that shows the network connections for the printers defined.
Note that pressing the OK button does NOT send the file to print. It only confirms the settings on the Print Setup window. To print, pull down the File menu, and select Print . To exit the Print Setup window without saving any changes, press the Cancel button.
OW330_90
99
6.6 To restore the srcinal diagram
6. 6
To restore
the srci nal diagram
The Restore Original menu item, on the File menu, is used to restore the current graphic back to the last version loaded or manually saved. If no graphic is currently loaded, this menu item is inactive (grayed out). The last loaded/saved version will be restored no matter how many edits have occurred. Note: This overrides any autosaves (see page 92) that may have occurred since the last load or manual save. Use the following procedure to use the Restore Original option. 1. Pull down the File menu on the main Graphics Builder window. 2. Select Restore Original from the File menu. The last manually saved version of the diagram displays.
6. 7
Wha t is the purpo se of compi ling graphics (
Offline) ?
Compiling a file translates the source version (*.src) to the object version (*.diag). The following sections discuss compiling graphics offline. In the offline mode, the Compile menu item (on the File menu) displays the GBNT:Compile window for compiling one or more graphic .src files. This menu item and window are not available when running the Graphics Builder from within the Ovation Developer Studio.
100
OW330_90
6.7 What is the purpose of compiling graphics (Offline)?
6.7.1 Batch Compile Options dialog The GBNT:Batch Compile Options dialog will provide the same options as the GBNT:Create Diagram Image dialog for creating images during a batch compile operation. The GBNT: Batch Compile Options dialog is used in conjunction with both online and offline batch compiles. It sets the options for the next batch compile. Batch compiles are invoked differently depending on whether you are running online or offline. When running online the Developer Studio is used, when offline, batch compiles are invoked within online Graphics Builder from the offline Graphics Builder: The dialog provides options for:
Generating graphic summary information,
Creating graphic images,
Generating compile warnings,
Generating a global replace pairs file from wildcards,
Doing a global replace of points or diagram numbers.
All of the batch compile options are automatically saved to the Windows Registry when the OK button is pressed (without having to use the Save Defaults function). The settings are stored automatically because online batch compiles are invoked from the Developer Studio (external to GB), and the settings are read from the registry. To be consistent between online/offline batch compiles, the settings are stored automatically whether running online or offline. Note: GB does not provide support for batch printing of images. Remember to backup graphics before doing a global replace as the global replace cannot be undone. Also, prior to performing a global replace (online or offline), you will be prompted to confirm the operation. The Batch Compile Options dialog (see page 101) will provide the same options as the GBNT:Create Diagram Image dialog for creating images during a batch compile operation. These image files will not be imported/exported via Import_graphics/Export_graphics. The creator of these images is responsible for managing them after GB generates them. To use the Batch Compile Options dialog 1. Pull down the File menu on the main Graphics Builder window, or the right-click menu from the Developer Studio when online.
OW330_90
101
6.7 What is the purpose of compiling graphics (Offline)? 2. Select Batch Compile options
S ECTION
A CTION
output file
Allows the selection of where the output data file can be saved. Default - blank. Entry field with browse button
summary info
create diag images
102
from the File menu.
D ESCRIPTION
Add the directory and output file name using the browse button to search for or create a directory for the output file.
Generates graphic summary data for the output file. Default - unchecked. format in output file drop-down menu
Per graphic - Data for the selected options will appear with each graphic.. Cumulative - The data will appear at the end of the compiled data. Both - The data will appear in both places.
options check boxes
Select any combination of the optional data to be displayed.
These options are specific to batch compiles and are stored independently in the Registry. The GB will display messages on the compile output dialog when it creates image files during batch compile operations. Default - unchecked.
OW330_90
6.7 What is the purpose of compiling graphics (Offline)?
S ECTION
global replace
A CTION
D ESCRIPTION
image format drop-down menu
.bmp, .gif, .jpg, or .png.
filter pokes drop-down menu
yes or no.
directory entry field with browse button
Search for, or create a directory for the output file.
To globally replace point names, diagram numbers or fully qualify points - 1 pair per l line. Note: Global replace cannot be undone – so any graphics must be backed up before executing the global replace. Also, prior to performing a global replace (online or offline), you will be prompted to confirm the operation.
build global replace pairs file from wildcards
compile warnings
global replace drop-down menu
Choose diagrams, points, or fully qualified points.
pairs file entry field with browse button
Used to browse the pairs file, also see Global Replace Pairs (see page 104).
view/edit
Allows creating or editing pairs files in Notepad.
Used to create a pairs file to use as input for a future global replace. Wildcard replacement is done in a three step process. See Global Replace Pairs (see page 104). Note: If a Global replace with a wildcard is needed, select this option first as it will set all other options to their default state.
global replace pairs drop-down menu
Used to browse the pairs file.
Help (wildcards)
Supports ‘*’ and ‘?’ wildcards, ‘*’ matches 0 or more characters; ‘?’ matches exactly 1 character.
output pairs entry field with browse button
Generated from the wildcard patterns, with the browse button provided for browsing for the pairs file.
view/edit
Allows viewing and editing files in Notepad.
input method drop-down menu
Specify a single wildcard search and replace pattern, or specify a file of any number of wildcard search and replace patterns when doing wildcard replacement.
search for Entry field
Information to search for the global replace.
replace with Entry field
Global replace information.
Messages will be reported similar to error messages in the batch compile output file. Dynamic data in BG
OW330_90
Data reported includes: bars/polybars, plots, process points (other than PN, TV, BV, EU, ED, BB,TB,or RT record fields), trends, xyplots, dynamic lines/polygons, ol_gauges/cylinders, if_changed commands, any item created with a conditional having one or more operands which is a resolved point, an unresolved point, an OPC point, or a
103
6.7 What is the purpose of compiling graphics (Offline)?
S ECTION
A CTION
D ESCRIPTION
$G/$H pt, and/or macros in the BG (as opposed to the DIAGRAM section) which have process point parameters. uninitialized $P/$H pts
If checked you will recieve a warning if the system determines the graphic uses $P or $H pointers without first initializing them first.
3. Select the OK button to compile the file(s). To quit the window without opening a file, select the Cancel button. Note: Once the Compile button is selected, the GBNT:Compilation Output window displays (see page 108). And when the Compile is complete, all settings in the Batch Compile will revert to their default. Global Replace Pairs A global replace pairs file is simply a simple text file with two columns, one that describe the point name (or list of point names) you want to change in the first column and the point name to replace it in the second column. Use spaces or tabs to separate the two columns. Example A1000 A2000 A1200 A1300 .
.
.
.
Z1000 Z2000 Wildcard
104
OW330_90
6.7 What is the purpose of compiling graphics (Offline)? Wildcard Global Replace Pairs A wildcard Global Replacement is a little more difficult and requires more thought and preparation. Sometimes it is easier to use a wildcard to shortcut a lot of typing, and if done carefully, will save a lot of time. Examples of an easy wildcard replacement file are below: Example 1 A1000 A2000 A1001 A2001 A1002 A2002 .
.
.
.
A1009 A2009 Example 2 A100* A200* All A1000s will be changed to A2000. An issue may occur where you have points named A1002-ABC or A1005-Cutout that you did not want to change. They will become A2002-ABC and A2005-Cutout. In order to help you think about what issues may be caused by building a wildcards replace pairs file, the three-step process is outlined below. 1. Generate a pairs file from the wildcard patterns. 2. Check the output paris file to verify that the points/diagram numbers matched by the given wildcard patterns and the proposed replacements are corrected. 3. Select the "global replace" option and execute another batch compile to do the global replace. In order to make the three-step process as easy as possible, when the global replace pairs file is created from wildcard patterns, the filename is automatically copied to the "global replace" input file entry filed. Also, buttons are provided for browsing for the pairs file and the wildcard patterns file, and for viewing/editing the file in Notebook.
OW330_90
105
6.7 What is the purpose of compiling graphics (Offline)? Compilation output
Figure 21 : Compilation Output Cumulative listings are labeled as such in the output file to differentiate them from per graphic listings. A cumulative macro listing includes any nested macros; per graphic macro listings only include the macros that are called from the compiled graphic. In the example, one graphic was compiled (nested_macros.src) which called macro601. But macro601 called other macros, which called other macros, and so forth. The cumulative list shows all nested macros (to any level) called from macro601. The 'View (in notepad)' button is a compilation output dialog to allow viewing the output file in a resizable window.
Figure 22 : Compilation complete The warning messages will be reported similar to error messages in the batch compile output file.
106
OW330_90
6.7 What is the purpose of compiling graphics (Offline)?
6.7.2 To Compil e graph ics ( Offlin e) Note: When you select Compile in the Compile window, the process will use any settings made in the Batch Compile window. You may want to set up or check the setup of the Batch Compile (see page 101) before continuing. 1. Pull down the File menu on the main Graphics Builder window 2. Select Compile from the File menu. If using the toolbars, Compile is the fourth button on the GBNT:Main toolbar. The GBNT:Compile window appears. 3. To specify the directory from which to find the file to compile, pull down the Look in menu, and select a directory. The subdirectories for this directory will display in the list. The buttons to the right of the Look in menu are, from left to right:
Go up one directory
Create a new fo lder — creates a new directory under the current directory.
List — Displays only the file names in the window.
Detail — Gives detailed information on the files in the list such as size of file, type, and date last modified.
— goes to the directory above the current directory in the hierarchy.
4. Specify the file to compile by selecting a file from the scrolling list, or type the name in the File name entry field. 5. Select a type of file to compile from the Files of type pull-down menu. The choices are: Source files (*.src) — specifies a source file. If this is selected, only files with the “.src” file extensions are displayed in the list when directories are set/changed. Batch fil es (*.cmp) — specifies a batch file. If this is selected, only files with the “.cmp” file extensions are displayed in the list when directories are set/changed. If specifying a batch file, only one “.cmp” can be selected at a time for compile. However, you can and select multipleTo source To toggle a file’s selectionfile status the including list, pressthe thecurrent Control key left-click. selectfiles. all files from the last selected up toinand file, press the Shift key and left-click (standard file selection). 6. Select the Compile button to compile the file(s). To quit the window without opening a file, select the Cancel button. Once the Compile button is selected, the GBNT:Compilation Output window displays (see page 108). Note: Once the Compile is complete, all settings in the Batch Compile will revert to their default.
OW330_90
107
6.7 What is the purpose of compiling graphics (Offline)?
6.7.3 Wha t is the Compilation Output dialog? All compile output is written to both the Compilation Output window and to a list file. The list file name is displayed at the top of the Compilation Output window. The list file name is derived from the file/file(s) being compiled. It is NOT configurable. As each file is being compiled, the full path filename is displayed in the output window. To print the file, press the Print button at the top of the window. If any errors are found, they are displayed immediately after the file name. If no errors are found, the name of the next diagram to compile displays. If the list points and/or the list gcodes (hex) check boxes are checked, the output is listed before a new diagram is compiled. When all specified files have been compiled, the message “compilation complete” displays in the window footer.
6.7.4 What are image fil es? The Graphics Builder provides the capability to generate image files, both online and offline, for all system graphics. The ability to generate images on batch compile operations as well as on-demand for the currently loaded graphic is available. The image file name will be the same as the diagram name plus one of four the image extension formats (.bmp, .gif, .jpg, or .png). Whether or not poke fields should be captured in the image(s) is configurable. A directory for the images can be specified, so that they can easily be 'zipped'. Creating images from graphic s The GBNT:Create Diagram Image dialog allows the creation of an on-demand image of the currently loaded graphic. The settings on this dialog will be saved in the Windows Registry on a Save Defaults function, so once the preferences are set, they remain set the next time the dialog displays. Note: For safety reasons, the created images cannot be placed on the regular graphics directory. The Batch Compile Options dialog (see page 101) will provide the same options as the GBNT:Create Diagram Image dialog for creating images during a batch compile operation. These image files will not be imported/exported via Import_graphics/Export_graphics. The creator of these images is responsible for managing them after the Graphics Builder generates them.
108
OW330_90
6.8 What is the Exit function in the Graphics Builder? To Create a Diagram Image 1. Select "Create Diag Image" from the File menu (Ctrl+I).
2. Select the "Image Format" (.bmp, .gif, .jpg, or .png). 3. Select "yes" or "no" in the Filter pokes combo. "Yes" means that poke fields will be filtered out of the resulting image, (that is, poke fields will be hidden). "No" means that any poke fields will be captured in the resulting image (that is, poke fields will be shown in the image). 4. In the "Image Directory"' browse for the directory where the images will be saved. D IALOG F IELD
D ESCRIPTION
Image format
Images can be created/saved in one of four format extensions: jpg, gif, png, or bmp. The image file name will be the same as the diagram name plus the image extension.
Filter pokes
Generated images can be configured to capture the Poke fields.
Image directory
Save the images to the specified directory, or browse for a specific directory.
Create
The settings on this dialog will be saved in the Windows Registry on a SaveDefaults function once "Create" is chosen. So once you sets the preferences, they remain set the next time the dialog displays.
5. Select Create.
6. 8
Wha t is the Exit func tion in the Graphics
Build er?
Exit closes the Graphics Builder application, checking for unsaved changes before exiting.
OW330_90
109
S
ECTION
7
Setting drawing attrib utes
IN THIS SECTION What items are on the Drawing Attributes toolbar?.........................................................111 What function?............................................................................................. 112 What is is the the Place Color dialog? ................................................................................................ 114 What is the Font Attributes dialog? ................................................................................. 120 What is the Fill Pattern dialog?........................................................................................ 124 What is the Line Patterns dialog?.................................................................................... 126 What is the Line Width dialog?........................................................................................ 127 To Set Blink..................................................................................................................... 128
7. 1
Wha t items are on the Dra wing Attributes
toolb ar?
The Drawing Attributes toolbar is used to set the attributes of the display items on the graphic. Default settings exist for all of the attributes. Set the following attributes before you draw any items:
Place (see page 112)
Color (see page 114)
Fonts (see page 120)
Fill Patterns (see page 124)
Line Patterns (see page 126)
Line Widths (see page 127)
Blink (see page 128)
OW330_90
111
7.2 What is the Place function?
7. 2
Wha t is the Pla ce funct ion? The Place of an item in a graphic is defined by the section where the associated command exists in the source file and/or by the source line number within that section. There are six different sections which make up graphic files: Diagram, Background, Foreground, Trigger, Macro_Trigger, and Keyboard. See the following table for a definition of each section. Place options P LACE
D EFINITION
Background
The commands in the background section are executed when the diagram is first displayed, and every time a window expose event is generated for the given graphic on the Ovation Operator Station. Items placed in the background section do not update periodically. Note that Background is the default place. The following draw items from the Draw toolbar can be used in the Background section: Arc, Rubberband Line/Arc, Line, Rubberband Line, Circle, Ellipse, Polygon, Rectangle, Dot, OL Rectangle, OL Gauge, OL Cylinder, Bar, Plot, XY Plot, Dynamic Line/Polygon, Trend, Time, Date, Group Text, Process Point, Text, Shape, Macro.
Diagram
The commands in the diagram section are executed only one time — when the diagram is initially displayed. Diagram initialization commands, (such as POINTER, PTR_VALUE,DEF_QUAL, and so forth) are typically in this section. (See Ovation Graphics Language Reference Manual .) Display items are not allowed in this section, with the exception of macros. The Macro draw item is t he only item that c an be used in t he Dia gram section. Macro display items are transparently dissociated into the individual foreground, background, trigger and keyboard sections.
Foreground
The commands in the foreground section of the diagram are executed when the diagram initially displays and periodically thereafter depending on the setting for Update Rate on the Diagram Configuration window. Foreground should be selected for items (such as process point, date, time, and so forth) that should update on a diagram. The following draw items from the Draw toolbar can be used in the Foreground section: Arc, Rubberband Line/Arc, Line, Rubberband Line, Circle, Ellipse, Polygon, Rectangle, Dot, OL Rectangle, OL Gauge, OL Cylinder, Bar, Plot, XY Plot, Dynamic Line/Polygon, Trend, Time, Date, Group Text, Process Point, Text, Shape, Macro.
Trigger
The commands in a trigger section are executed on demand only. A trigger section can be invoked from an application program (122 -Exec Trigger), or from the TRIG_ON command. (See Ovation Graphics Language Reference Manual .) A trigger section is executed once per demand. If the TRIG_ON command or the call to run program 122 is in the foreground section of the diagram, then the trigger can be executed periodically just like the foreground. There can be a maximum of 254 trigger sections (trigger 1 ... trigger 254). A trigger number is associated with each trigger section, and that number is a parameter to program 122 and the TRIG_ON command. The following draw items from the Draw toolbar can be used in the Trigger section: Arc, Rubberband Line/Arc, Line, Rubberband Line, Circle, Ellipse, Polygon, Rectangle, Dot, OL Rectangle, OL Gauge, OL Cylinder, Bar, Plot, XY Plot, Dynamic Line/Polygon, Trend, Time, Date, Group Text, Process Point, Text, Shape, Macro.
Macro Trigger
112
Allows the defining of trigger sections which are local to that macro. This allows the creation of a macro (which can be used multiple times on a single graphic) containing an item such as an OlSlider, without having to manage IF/ENDIF/$SETn logic in the associated trigger. You will now be able to associate a local macro-trigger in the macro with the OlSlider, and each instance of that macro will get its own local trigger.
OW330_90
7.2 What is the Place function?
P LACE
D EFINITION
Keyboard
The Keyboard section defines the operator interfaces to the diagram. The following draw items from the Draw toolbar can be used in the Keyboard section: Macro, Poke Field, Entry Field, OL Slider, OL Check Box, OL Choice, OL Button, OL Event Menu, Function Key
The Display/Set Active Place pull-down menu and the Line # entry field are used to set the place for current and future draw operations. The pull-down menu specifies which section new items are added to the graphic; the source line number entry field specifies the line on which the new command is added. The Line # entry field updates accordingly when the diagram section/place that is defined in the drop-down menu changes. The line number automatically updates to the end of the selected diagram section. The line number must be within the valid range for the selected diagram section. This field specifies on which line within the given section future draw operations occur. You may manually insert a draw item at a certain line in the source code by entering the applicable number in the entry field. However, if the desired line number is within a different section/place, you must change the place drop-down menu first, and then set the number within that place. The Change Place button allows you to change the place srcinally specified for selected draw items. To use this function, follow the steps below: 1. Select the items for which you want to change the place. 2. Set the Display/Set Active Place pull-down menu and/or the Line # entry field to where you want to move the selected items to. 3. Press the Change Place button. The selected items move to that section.
OW330_90
113
7.3 What is the Color dialog?
7. 3
Wha t is the Color dialog? The Color dialog is used to interactively set or change the current drawing colors for items on a graphic. The color values and optional conditionals are set/changed from this window. This dialog is also used to set/change the default $COLORn and $OL_COLORn variable display values used by the Graphics Builder. There are four different types of color available in graphics:
Foreground (FG) color — primary color for most items on a graphic. It is used for all solid line drawings, for all solid fills, for the characters in text, for the set bits (that is, bits = 1) of line and fill patterns, and to display bar, plot, trend, and so forth, current values. Background (BG) color —character used for the bits (that is, bits = 0) in line type and fill patterns for the background of each cell clear in vector_over and bitmap_over text. Vectorand and bitmap type text does not use BG color.
Erase (ER ) col or — used only at runtime to erase dynamic items (bars, shapes, OL Checkboxes, OL Sliders, and OL Cylinders) as their value changes. It is used to draw the unfilled (invisible) portion of a bar. It is used to erase the existing shape when a shape changes as a result of a conditional expression change. It is used to erase the portion of a checkmark which extends outside of the box for the OL checkbox when you select a new box. It is used to erase the slider control as you drag/move the control for the OL Slider. It is used to erase some intermediate drawing for the OL Cylinder. It is never used by the Graphics Builder to display items.
OL (3D item) col or — used to draw OL Rectangles, OL Cylinders, OL Sliders, OL Checkboxes, OL Event Menus, OL Gauges, OL Choices, and OL Buttons.
The FG, BG, and ER colors can be set to any of the eight standard colors (black, blue, green, cyan, red, magenta, yellow, and white) or any color listed in the system col ors. t xt file. This file is read at the startup of the Graphics Builder, and all of the color scrolling lists in the Builder are generated from this file. The FG, BG, and ER colors are specified by color names (red, green, blue, and so forth). The number of colors specified in the col ors. t xt file is unlimited. The OL color choices are also read from the col ors. t xt file at startup. The OL color choices in the file can be any of the standard eight colors or any of the color names defined in the file or you can defined an unlimited number of OL colors. The OL color in a graphic is specified by an ordinal index as defined in the col ors. t xt file as opposed to an ASCII name. Note: The Color dialog cannot used to set colors for the BUTTON command, as the BUTTON command gets its colors directly from its own BUTTON dialog.
114
OW330_90
7.3 What is the Color dialog?
7.3. 1 To set Colo r 1. From the Drawing Attributes toolbar, select the Color button. The Color window displays.
2. A type pull-down menu exists for each of the four color types. From the type pull-down menu you can set the FG, BG, and ER color to a $COLORn variable instead of a color name. You can also set the OL color to a $OL_COLORn variable instead of the standard color index. $COLORn and $OL_COLORn variables are used to tagout colors which are input parameters to a macro (see page 205).
OW330_90
115
7.3 What is the Color dialog? When you select the $COLORn choice from the FG, BG, or ER type pull-down menu, the scrolling list of color names is replaced by a scrolling list of $COLORn variables. Likewise, when you select $OL_COLORn from the type pull-down menu, the choice of OL colors is replaced by a scrolling list of $OL_COLORn variables. In both cases, the Find entry field is removed. 3. The Find entry field is used to locate a color in the associated scrolling list by typing the name instead of manually scrolling and selecting. If you know the color name, enter it in the entry field. If the Graphics Builder finds the color in the list, it automatically scrolls to that color and select it. The Find entry field does not locate a color in the list unless you type it completely. The Graphics Builder does not attempt to finish the color name for you as you enter it. The Graphics Builder warns you if there is an invalid color name in the FG, BG, or ER Find fields when you press the OK or Apply buttons. The warning message states that what is in the find field is ignored, and the currently selected color in the scrolling list is used instead. A color is always selected in the scrolling list. 4. To set the foreground color, pull down the Type menu and select either color or $COLORn. Then select a color name or color variable from the scrolling list. Use the Find entry field to type in a color name, if desired. The default FG color is black . The color names listed in the scrolling list are from the system colors.txt file. The number of colors specified in the colors.txt file is unli mited. There is a maximum of 100 $COLORn variables available. $COLORn variables are used to tagout colors which are input parameters to a macro. 5. To set the background color, pull down the Type menu and select either color or $COLORn. Then select a color name or color variable from the scrolling list. Use the Find entry field to type in a color name, if desired. The default BG color is white . 6. To set the erase color, pull down the Type menu and select either color or $COLORn. Then select a color name or color variable from the scrolling list. Use the Find entry field to type in a color name, if desired. The default ER color is white if a bitmap is specified for the diagram background on the Diagram Configuration window at startup. If a color is specified for the diagram background at startup, that color is used as the default ER color. Erase color has no meaning within the Graphics Builder. It is used for the display of bars and shapes on the process diagram at the Ovation Operator Station. Erase color is used to clear/erase the previous value of a bar graph when the value changes. It also erases the previous shape displayed when a shape conditional becomes true. 7. To set the OL color, pull down the Type menu, and select either OLcolor or $OL_COLORn . If Type is set to OL color, select one of the color choice buttons. Then select an OL color from the scrolling list. The colors and numbers are defined by the OL color choice index in the colors.txt file (see page 317). The default OL color is that which is defined for OL_COLOR 0 in the colors.txt file. If Type is set to $OL_COLORn, select a variable from the scrolling list. There is a maximum of 100 such variables available. $OL_COLORn variables are used to tagout OL colors which are input parameters to a macro. 8. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. Conditional statements can be entered for FG, BG, ER, and OL colors.
116
To define a conditional, place the cursor in the entry field beside the scrolling list of the desired color placement (FG, BG, ER, or OL).
OW330_90
7.3 What is the Color dialog?
Enter the conditional statement. (See Ovation Graphics Language Reference Manual.)
To clear or erase the conditional statement, press the applicable clear button beside the entry field.
9. After all colors have been selected, and conditional statements have been entered, select one of the following buttons: Ok — Saves the selected settings, and qui ts the Color window. Appl y — Saves the selected settings, but the Color window remains open. Fg <...> Bg — Swaps the foreground and background colors. It also swaps foreground and background conditionals if they exist. If any items are currently selected on the graphic when this button is pressed, the color change is automatically applied to them. Cancel — Quits the Color window without saving any changes. Help — Displays help information on this topic.
7.3.2 To use the Hide ER/Show ER but ton and Hide O L/Show OL button These buttons give you the ability to toggle on/off the display of the ER and/or OL color items on the GBNT:Color window. The default GBNT:Color window will display all four color choices. The ER and OL color will always be defined and active whether they are currently displayed on the color dialog or not. If the ER and OL color data is currently displayed on the dialog, the Hide ER and Hide OL buttons are used to hide the ER and OL color data respectively. When ER and OL color data is hidden, the button labels change to Show ER and Show OL respectively. Use the Save Defaults function (see page 82) on the View menu to store the ER and OL display states on the color dialog and to restore the settings each time the Graphics Builder is invoked.
7.3.3 To use the $CO LORn disp lay values dialo g The $color values button is used to set/change the default $COLORn variable display values. Unlike any of the other types of parameters that can be tagged out in a macro (for example, $Dn, $Tn, $SETn, and so forth), $COLORn tagouts must be assigned values in order to display the macro graphic in the Graphics Builder (otherwise, the Graphics Builder would not know what color to use for the variables). 1. Press the $color values button on the Color window. The $COLORn display values window displays.
7.3 What is the Color dialog? The Graphics Builder defaults the display values for all $COLORn tagouts to black. 2. Click on the $COLORn value that you want to change and a button displays to the right of the value column. Click on the button. 3. Once you select the button, the Select $COLORn value dialog displays.
Figure 24: Select $COLO Rn Value Window In the Select $COLORn value window, notice that the current color setting is selected in the scrolling list. Select a color from the scrolling list, and press the OK button. The new color appears in the $COLORn Display Values window. Note: Execute the Save Defaults function (see page 82) after setting the display values for $COLORn so that you do not have to reset the values each time you access the Graphics Builder. These values are not stored in any graphic or macro. Once configured, they apply to all macros loaded into the Graphics Builder until they are reconfigured.
7.3.4 To use the $OL_C OLORn dis play values dialog The $ol_color values button is used to set/change the default $OL_COLORn variable display values. Unlike any of the other types of parameters that can be tagged out in a macro (for example, $Dn, $Tn, $SETn, and so forth), $OL_COLORn tagouts must be assigned values in order to display the macro graphic in the Graphics Builder (otherwise, the Graphics Builder would not know what color to use for the variables). 1. Press the $ol_color values button on the Color window. The $OL_COLORn display values window displays.
7.3 What is the Color dialog? The Graphics Builder defaults the display values for all $OL_COLORn tagouts to OL color 0. 2. Click on the $OL_COLORn value that you want to change and a button displays at the right of the value column. Click the button. 3. Once you select the button, the Select $OL_COLORn value window displays.
Figure 26: Select $OL_COLO Rn Value Windo w In the Select $OL_COLORn value window, notice that the current OL color choice is selected on the dialog. Select a color from the scrolling list, and press the OK button. The new color appears in the $OL_COLORn Display Values window. Note: Execute the Save Defaults function (see page 82) after setting the display values for $OL_COLORn so that you do not have to reset the values each time you access the Graphics Builder. These values are not stored in any graphic or macro. Once configured, they apply to all macros loaded into the Graphics Builder until they are reconfigured.
OW330_90
119
7.4 What is the Font Attributes dialog?
7. 4
Wha t is the Font Attrib utes dialog? The Font Attributes dialog is used to set the text/font attributes for the following items: Text, Time, Date, Multi-Text, Group Library Text, Process Point, Entry Field, OL Event Menu, OL Choice, and OL Button. Font attributes are only applicable to OL Choice and OL Button items which have text (as opposed to shape) labels. Two font types are available for graphics: bitmap and vector text. Bitmap Text — Bitmap text does not scale on a zoom/resize operation. The available bitmap text sizes are defined by the eight font sizes found in the fonts.txt file (see page 318). are Youdefined may change eight sizes in the the file.font sizes (valid range for font sizes is 1 pt. to 200 pt. text type) if Bitm ap_Over Te xt — Bitmap_Over text is the same as bitmap text but uses the overstrike option. This means that both the foreground and background of each character cell making up the text string are drawn. If the overstrike option is not used, only the foreground of each character cell making up the text string is drawn on the canvas. The overstrike option should always be used with changing characters such as process point values and text conditionals. A conditional may be written to have text change on the process diagram depending on the conditions in the plant. If the overstrike option is not used, the new text does not cover the old text. The lines for the old text are still seen because only the foreground of the text is drawn. If the overstrike option is used, the new text covers the old text since it has a background associated with it. Vector Text — Vector text scales on zoom/resize operations. You specify the font size for vector text by defining the pixel dimensions (width and height) of the character cells. The valid virtual pixel range for characters is 3 through 16,383. Vector_Over Textboth —Vector_Over text is background the same asof vector but uses overstrike option. This means that the foreground and eachtext character cellthe making up the text string are drawn. If the overstrike option is not used, only the foreground of each character cell making up the text string is drawn on the canvas. Note: A special vector font, “Ovation Vector Font (see page 123),” is also discussed. The overstrike option should always be used with changing characters such as process point values and text conditionals. A conditional may be written to have text change on the process diagram depending on the conditions in the plant. If the overstrike option is not used, the new text does not cover the old text. The lines for the old text can still be seen because only the foreground of the text is drawn. If the overstrike option is used, the new text covers the old text since it has a background associated with it.
120
OW330_90
7.4 What is the Font Attributes dialog?
Note: When the Graphics Builder attempts to create/get a font of a particular size in Windows, it is only a request. The Windows font mapper attempts to find the font in the requested size, but provides the closest match if the exact font is not found. The Graphics Builder has no control over this. The font mapper searches by height first and then by width. If the height exists, the font mapper returns that font whether it matches the width or not. Text sizes may change on a zoom/resize operation. This means that if you interactively resize text, the text drawn after you release the mouse pointer may not represent what the outlining rectangle handles indicated the size would be while dragging for resize. The Graphics Builder may have requested a certain size font, but received a different size from the Windows font mapper. In addition, if you draw a box around text and then resize the diagram, zoom the diagram, or group the box and text and resize the group, the text may not always be within the box after the resize. During the resize, the Graphics Builder requests a certain font size to keep the in the box but may another size from the Windows font mapper. Thetext information above doesreceive NOT apply to Ovation Vector Font since it is an Ovation font — not a Windows font. The Ovation Vector Font sizes exactly per the requested size.
7.4.1 To use Bitmap a nd Bitmap_Over te
xt
1. From the Drawing Attributes toolbar, select the Font button. The Font Attributes window displays. 2. Pull down the Type menu, and select the type of text used for the graphic. For these procedures, select Bitmap . 3. When Bitmap is selected for Type, the Font Attributes window appears as shown below. Note that while the font is not configurable for bitmap text, the font that is used is “Courier New.”
Figure 2 7: Font Attrib utes window — showin g bitmap fon t type 4. Go to the overstrike checkbox and check this box if you want both the foreground and background of a character cell drawn when the text is displayed. If this box is not checked, only the foreground displays. This box should always be used with text conditionals. 5. Pull down the Size menu, and select a number that corresponds to a point size defined in the custom file, fonts.txt (see page 318). The menu choices are 1 through 8. As you select a new font size from this list, the display in the sample area updates to show you what the current font looks like in this size. The character width and height (in virtual pixels) associated with each of the eight sizes in the list displays in the char w and char h entry fields when you select a new entry in the list. This occurs whether or not the char w and char h fields are active.
OW330_90
121
7.4 What is the Font Attributes dialog? 6. At the Sample entry field, you can type words/letters to see how the font appears on the drawing canvas. The sample string may be up to 20 characters. The sample that was typed in the entry field appears in the Sample Area below it. 7. After Type and Size have been set, select one of the following buttons: Ap pl y All — Saves all of the selected settings on the Font Attributes window and applies it to the graphic. Reset — Returns the Font Attributes window to its last saved settings (that is, what was saved by the Save Defaults function (see page 82)). Cancel — Quits the Font Attributes window without saving any changes. Help — Displays help information on this topic.
7.4.2 To use V ector and Vector_over text 1. From the Drawing Attributes toolbar, select the Font button. The Font Attributes window displays. 2. Pull down the Type menu, and select the type of text used for the graphic. For these procedures, select Vector . 3. If Vector is selected for Type, the Font Attributes window appears.
Figure 2 8: Font Attri butes window — showin g vector font type 4. Go to the overstrike checkbox and check this box if you want both the foreground and background of a character cell drawn when the text is displayed. If this box is not checked, only the foreground displays. This box should always be used with text conditionals. 5. Pull down the Font menu, and select a font from the l ist. The Graphics Builder allows you to use any font available on the computer where it is running. All the available fonts are listed in this combo box by name. The Graphics Builder appends a “*” to the name of any font that is a fixed-width font. You should use a fixed-width font for all conditional text because you want all text to be the same length.
122
OW330_90
7.4 What is the Font Attributes dialog?
Note: Different fonts may be available on different computers. Third-party packages installed on a computer often install their own fonts. If building a graphic on one computer, the fonts used to build the graphic must also be available on the computer where the graphic executes at runtime. 6. Pull down the Size menu, and select a number that corresponds to a point size defined in the custom file, fonts.txt (see page 318). The menu choices are 1 through 8. Go to Step 9. If one of the eight standard font sizes is not desirable, pull down the Size menu and select other . Once other is selected, you may define a character width and height (see Steps 7 and 8). 7. Enter a width for the text character in the char w entry field. Valid range is 3 through 16,383. 8. Enter a height for the text character in the char h entry field. Valid range is 3 through 16,383. 9. Pull down the Style menu, and select a style from the list (choices include bold, italic, regular, and bold_italic). 10. At the Sample entry field, you can type words/letters to see how the font appears on the drawing canvas. The sample string may be up to 20 characters. The sample that was typed in the entry field appears in the Sample Area below it. 11. After all of the choices have been made, select one of the following buttons: Ap pl y All — Saves all of the selected settings on the Font Attributes window and applies it to the graphic. Ap pl y Fon t/St yle — Only saves the Font and Style settings on the Font Attributes window and applies those settings to the graphic. Reset — Returns the Font Attributes window to its last saved settings (that is, what was saved by the Save Defaults function (see page 82)). Cancel — Quits the Font Attributes window without saving any changes. Help — Displays help information on this topic.
7.4.3 To use the Ovation Vector F ont Ovation Vector Font is a special vector font that is truly resizable and supports line width. It is an Ovation font as opposed to a Windows font. It sizes exactly per the requested size, as opposed to the Windows fonts which return the closest match. Ovation Vector Font cannot be displayed in italic or bold typeface, but it can have an associated line width of 1 - 16 pixels. Note that this line width is independent from that on the Line Widths dialog. The Ovation Vector Font is a fixed-width font. You should use a fixed-width font for all conditional text because you want all text to be the same length. 1. From the Drawing Attributes toolbar, select the Font button. The Font Attributes window displays. 2. Pull down the Type menu, and select the type of text used for the graphic. For these procedures, select Vector . 3. Go to the overstrike checkbox and check this box if you want both the foreground and background of a character cell drawn when the text is displayed. If this box is not checked, only the foreground displays. This box should always be used with text conditionals. 4. Pull down the Font menu, and select Ovation Vector Font . 5. Pull down the Size menu, and select a number that corresponds to a point size defined in the custom file, fonts.txt (see page 318). The menu choices are 1 through 8. Go to Step 8.
OW330_90
123
7.5 What is the Fill Pattern dialog? If one of the eight standard font sizes is not desirable, pull down the Size menu and select other . Once other is selected, you may define a character width and height (see Steps 6 and 7). 6. Enter a width for the text character in the char w entry field. Valid range is 3 - 16,383. 7. Enter a height for the text character in the char h entry field. Valid range is 3 - 16,383. 8. Pull down the Line width menu, and select a line width for the font. Valid range is 1 through 16. Unlike the line widths defined in the Line Width dialog, the number selected here corresponds to actual pixels. Note: The Style menu is grayed out, since Ovation Vector Font does not support bold or italic typefaces. 9. At the Sample entry field, you can type words/letters to see how the font appears on the drawing canvas. The sample string may be up to 20 characters. The sample that was typed in the entry field appears in the Sample Area below it. 10. After all of the choices have been made, select one of the following buttons: Ap pl y All — Saves all of the selected settings on the Font Attributes window and applies it to the graphic. Ap pl y Fon t/St yle — Only saves the Font and Style settings on the Font Attributes window and applies those settings to the graphic. Reset — Returns the Font Attributes window to its last saved settings (that is, what was saved by the Save Defaults function (see page 82). Cancel — Quits the Font Attributes window without saving any changes. Help — Displays help information on this topic.
7. 5
What is the Fill Pa ttern dialo g? The Fill Pattern dialog is used to set and/or change the active fill pattern and/or fill pattern conditional used for items on a graphic. The following items on the Draw toolbar may have an associated fill pattern: polygon, circle, ellipse, dynamic polygon, rectangle, and arc. Graphic fill patterns are monochrome patterns. When the Graphics Builder displays a fill pattern, the set bits of the pattern are displayed in the active FG (foreground) color, and the clear bits are displayed in the active BG (background) color. The Graphics Builder provides nine standard fill patterns: unfilled, solid, back_slash, slash, vert_slash, horz_slash, asterisks, blocks, and west_logo. In addition, to the nine standard fill patterns, you can create custom fill patterns (see page 318).
124
OW330_90
7.5 What is the Fill Pattern dialog?
7.5.1 To set Fill P attern attrib utes 1. From the Drawing Attributes toolbar, select the Fill button. The Fill Pattern window displays.
Figure 29: Fill Pattern window 2. Select the desired fill pattern from the scrolling list. The default fill pattern is unfilled . 3. A conditional statement allows the value of a parameter in a graphic command to change based upon a specific condition. To create a fill pattern conditional, place the cursor in the Conditionaltoentry field belowrules. the fill(See pattern scrolling list. Enter the conditional statement according the applicable Ovation Graphics Language Reference Manual.) To clear or erase the conditional statement, press the clear button above the Conditional entry field. 4. After the fill pattern and conditional (if applicable) have been set, select one of the following buttons: Ok — Saves the selected settings, and qui ts the Fill Pattern window. It also changes the fill pattern for all applicable currently selected items. Appl y — Saves the selected settings, but the Fill Pattern window remains open. It also changes the fill pattern for all applicable currently selected items. Cancel — Quits the Fill Pattern window without saving any changes. Help — Displays help information on this topic.
OW330_90
125
7.6 What is the Line Patterns dialog?
7. 6
Wha t is the Line Pa tterns
dialog?
The Line Patterns dialog operates in two different modes: In one mode, it is used to edit the system line patterns file (that is, add, delete, change custom line patterns). In the other mode, it is used to set/change the active line pattern and line pattern conditional for current and future draw operations. The mode of operation is determined by the setting for the Line patterns out for edit checkbox at the top of the window. If this box is checked, the dialog can only be used to edit the system custom line pattern file (see page 320). If this box is not checked, the window can only be used to set/change the current line pattern and line pattern conditional for items on the graphic. The draw items that a line line, pattern line, polygon, arc, rubberband line,use dynamic andare: dynamic polygon.rectangle, arc, circle, ellipse, rubberband
7.6.1 To Set Lin e Patterns 1. From the Drawing Attributes toolbar, select the Line Pattern button. The Line Patterns window displays.
Figure 30: Line Patterns Window 2. Select the desired line pattern from the line pattern scrolling list. The red box around the name is the currently selected pattern. The first nine line patterns are the default patterns: solid, dashed, sm_dash, big_dots, dotted, dash_dot, near_solid, sparse, and dot_dash. Custom line patterns read from the system line_patterns.txt file at startup are added to the list after the standard nine patterns. The default line pattern is solid .
126
OW330_90
7.7 What is the Line Width dialog? 3. A conditional statement allows the value of a parameter in a graphic command to change based upon a specific condition. To create a line pattern conditional, place the cursor in the Conditional entry field below the line pattern scrolling list. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.) To clear or erase the conditional statement, press the clear button above the Conditional entry field. 4. After the line pattern and conditional (if applicable) have been set, select one of the following buttons: Ok — Saves the selected settings, and q uits the Line Patterns window. It also changes the line pattern for all applicable currently selected items. Appl y — Saves the selected settings, but the Line Patterns window remains open. It also changes the line pattern for all applicable currently selected items. Cancel — Quits the Line Patterns window without saving any changes. Help — Displays help information on this topic.
7. 7
Wha t is the Line Width dialog? The Graphics Builder offers 16 line widths from which to choose. The order of the line widths corresponds to an array index that is used in the source editor to specify line widths. Neither the size of the line widths nor the line width array index is configurable. The following table is a list of the line width array index numbers and their corresponding pixel line width. Line Width Array Index A RRAY I NDEX N UMBERS
OW330_90
W IDTH OF P IXELS
L INE IN
1
1
2
2
3
4
4
6
5
8
5
10
7
12
8
14
9
16
10
18
11
20
12
22
13
24
14
26
15
28
16
30
127
7.8 To Set Blink
7.7.1 To Set Lin e Width 1. From the Drawing Attributes toolbar, select the Line Width button. The Line Widths window displays.
Figure 31: Line Patterns Window Once a line width is selected, the choice appears indented. The first line width on the Line Widths window (first row, first button) is assigned the number 1 in the source syntax. The second line width (first row, second button) is assigned the number 2, and so forth, reading the line widths from left to right. The last button on the Line Widths window (fourth row, fourth button) is assigned the number 16 in the source syntax. Note: Line width does not scale on resize or zoom operations. 2. After selecting a line width from Step 1, the result is immediate (that is, no OK or Apply button is necessary). To quit the Line Widths window, press the “x” button in the upper right corner of the window.
7. 8
To Set Bli nk 1. Pull down the Edit menu and go to At tr ibut es. Pull right and select blink . The Blink window appears. Note that blink is not available on the Drawing Attributes toolbar. Note: Using blink may adversely affect the diagram update rate. It should be used sparingly. 2. To set foreground blink, select the FG check box. A check mark displays in the box. To remove the foreground blink, select the FG check box again. The check mark disappears. The default for foreground blink is of f (no check mark in the box). 3. To set background blink, select the BG check box. A check mark displays in the box. To remove the background blink, select the BG check box again. The check mark disappears. The default for background blink is of f (no check mark in the box). 4. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. Conditional statements can be entered for FG and BG blink.
128
To define a conditional, place the cursor in the entry field beside the desired blink placement (FG or BG).
OW330_90
7.8 To Set Blink
Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.)
To clear or erase the conditional statement, press the applicable clear button beside the entry field.
5. After the desired blink has been set, and conditional statements have been entered, select one of the following buttons: Ok — Saves the selected settings, and qui ts the Blink window. It also changes the blink setting for all applicable selected items. Ap pl y — Saves the selected settings, but the Blink window remains open. It also changes the blink setting for all applicable selected items. Cancel — Quits the Blink window without saving any changes.
OW330_90
129
S
ECTION
8
Drawin g graphi c Items
IN THIS SECTION What items are valid in the Background, Foreground, Trigger and Macro Trigger sections? ......................................................................................................................................... What Draw Items are Valid in the Keyboard Section? ....................................................132 133 What are the simple draw items? .................................................................................... 134 What is the Bar icon? ...................................................................................................... 137 What is the Bitmap Image icon?...................................................................................... 139 What Is the Button icon? ................................................................................................. 140 What is the Date icon? .................................................................................................... 154 What is the Dynamic Line/Polygon icon? ........................................................................ 155 What is the Entry Field icon?........................................................................................... 157 What is the Function Key Command?............................................................................. 159 What is the OL Button icon?............................................................................................ 161 What is the PolyBar icon? ............................................................................................... 164 What is the OL Check Box icon?..................................................................................... 166 What is the OL Choice icon?........................................................................................... 169 What is the OL Cylinder icon?......................................................................................... 172 What is the OL Event Menu icon?................................................................................... 173 What is the OL Gauge icon? ........................................................................................... 175 What is the OL Rectangle icon?...................................................................................... 176 What is the OL Slider icon?............................................................................................. 177 What is the Page command icon?................................................................................... 179 What is the Plot icon?...................................................................................................... 179 What is the Point Group Text icon?................................................................................. 182 What is the Poke Field icon?........................................................................................... 183 What is the Process Point button? .................................................................................. 190 What is the Shape button? .............................................................................................. 193 What is the Text button? ................................................................................................. 194 What is the Time button? ................................................................................................ 198 What is the Trend button? ............................................................................................... 199 What is the XY Plot button? ............................................................................................ 201
OW330_90
131
8.1 What items are valid in the Background, Foreground, Trigger and Macro Trigger sections?
8. 1
Wha t items are valid in the Backgrou Ma cro Trigger sections ?
nd, Foreground,
Trigger
and
The Graphics Builder draw items are valid in certain sections of a diagram. The macro draw item is the exception since it is valid in all place locations. The commands in the background section are executed when the diagram is first displayed, and every time a window expose event is generated for the given graphic on the Ovation Operator Station. Items placed in the background section do not update periodically. The commands in the foreground section of the diagram are executed when the diagram initially displays and periodically thereafter depending on the setting for Update Rate on the Diagram Configuration window. Foreground should be selected for items (such as process point, date, time, and so forth) that should update on a diagram. The commands in a trigger section are executed on demand only. A trigger section can be invoked from an application program, or from the TRIG_ON command. The following sections discuss the Graphics Builder draw items that are valid in the background, foreground, trigger and macro trigger sections of a diagram.
Arc (see page 134)
Arcpolygon (rotated Arc)
Rubberband Line/Arc (see page 134)
Line (see page 135)
Rubberband Line (see page 135)
Circle (see page 135)
Ellipse (see page 136)
Ellipsepolygon (rotated Ellipse)
Polygon (see page 136) Rectangle (see page 136)
132
Rectpolygon (rotated Rectangle)
Dot (see page 137)
OL Rectangle (see page 176)
OL Rectpolygon (rotated OL_Rectangle)
Bitmap Image (see page 139)
OL Gauge (see page 175)
OL Cylinder (see page 172)
Bar (see page 137)
PolyBar (see page 164) (Polygon shaped Bar)
Plot (see page 179)
XY Plot (see page 201)
Dynamic Line/Polygon (see page 155)
Trend (see page 199) Time (see page 198)
Date (see page 154)
Group Text (see page 182)
OW330_90
8.2 What Draw Items are Valid in the Keyboard Section?
Process Point (see page 190)
Text (see page 194)
Shape (see page 193)
Macro (see page 205)
When building graphics offline, use the Import Graphics function (see page 325) to first move the graphic to the Developer Studio. Make sure you check for errors as the import is processing. Once in the Developer Studio, perform a download of that graphic. You can then load the updated graphic in a Graphics Display window. If creating a graphic online, save the graphic, then perform a download of that graphics in the Developer Studio. You can then load the updated graphic in a Graphics Display window. (See Ovation Developer Studio User Guide.)
8. 2
What Draw Items are Va lid in the Keybo ard Section ? The Keyboard section defines the operator interfaces to the diagram. The following sections discuss the Graphics Builder draw items that are valid in the keyboard section of a graphic.
Poke Field (see page 183)
Entry Field (see page 157)
OL Slider (see page 177)
OL Choice (see page 169)
OL Check Box (see page 166)
OL Button (see page 161)
OL Event Menu (see page 173)
Function Key (see page 159)
Button (see page 140)
When building graphics offline, use the Import Graphics function (see page 325) to first move the graphic to the Developer Studio. Make sure you check for errors as the import is processing. Once in the Developer Studio, perform a download of that graphic. You can then load the updated graphic in a Graphics Display window. If creating a graphic online, save the graphic, then perform a download of that graphics in the Developer Studio. You can then load the updated graphic in a Graphics Display window. (See Ovation Developer Studio User Guide.)
OW330_90
133
8.3 What are the simple draw items?
8. 3
What are the simp le draw items ? The following items are considered simple draw items. There are no points or control associated with these items.
Arc (see page 134)
Rubberband Arc (see page 134)
Line (see page 135)
Rubberband Line (see page 135)
Circle (see page 135)
Ellipse (see page 136)
Polygon (see page 136) Rectangle (see page 136)
Dot (see page 137)
8.3. 1 To Draw an Ar c The Arc icon is accessed to draw a filled or unfilled circular arc. The arc must have three points: a start point, midpoint, and end point. You may specify a line and/or fill pattern for the arc. 1. Select the Ar c icon on the Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas and click to mark one end point for the arc. 3. Move the pointer on the drawing canvas, and click again to mark the other end point for the arc. 4. Move the pointer (without pressing any buttons on the mouse) to drag the arc between the end points to the desired size. As soon as the pointer moves, the line between points 1 and 2 is erased, and the arc (with points 1 and 2 and passing through point 3) is drawn. 5. Click again to complete the drawing process. Note: The initial draw of an arc always creates a circular arc. Once the arc is drawn on the graphic, it can be resized into an elliptical arc (assuming Resize Aspect Ratio (see page 88) is not set to “maintain”).
8.3.2 To Draw a Rubberb and Arc The Rubberband Arc icon is accessed to draw a line that appears as a curve (or non-circular, non-elliptical arc). It is drawn using the same steps as the standard arc. However, after this item is drawn, a LINE command appears in the source editor window, not an ARC command. (See Ovation Graphics Language Reference Manual.) Note: You cannot fill a Rubberband Arc. However, you can specify a line pattern for this item. To draw the Rubberband Arc, select the Rubberband Arc icon on the Draw toolbar. This i tem may be placed in the Background, Foreground, or Trigger section. Follow the procedures for drawing an Arc (see page 134) to draw a Rubberband Arc.
134
OW330_90
8.3 What are the simple draw items?
8.3. 3 To Draw a Li ne The Line icon is accessed to draw a straight line or a series of lines on the diagram. You select a line pattern for the line. You cannot fill a line. Note: A line must have at least two points. 1. Select the Line icon on the Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas, and click to mark the start point of the line. 3. Move the pointer on the drawing canvas, and click again to mark another point for the line. 4. Continue to move and click to mark all vertex points of the line. 5. Hold down the Control key and left-click to select the final vertex point and complete the drawing process.
8.3.4 To Draw a Rubberb and Line The Rubberband Line icon is accessed to draw a curved line or lines on the diagram. It is drawn using the same steps as the standard line. You can select the line pattern for the Rubberband Line. 1. Select the Rubberband Line icon on the Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas, and click to mark the start point of the rubberband line. 3. Move the pointer on the drawing canvas, and click again to mark another point for the rubberband line. Note: Atcanvas least three areon required to draw a Rubberband Line. the Nothing appears on the drawing untilpoints you click the second vertex point and move pointer. 4. After marking the second vertex point, move the pointer (up, down, left, or right). The line bends as desired. 5. Continue to move and click to mark all vertex points of the rubberband line. 6. Hold down the Control key and left-click to select the final vertex point and complete the drawing process.
8.3. 5 To Draw a Circ le The Circle icon is accessed to draw a circle on the diagram. You can specify a fill and line pattern for the circle. 1. Select the Circle icon on the GBNT:Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas. Press and hold the left mouse button, and drag the radius to the desired size. Do not release the mouse button while drawing the circle. 3. Release the mouse button to complete the draw operation.
OW330_90
135
8.3 What are the simple draw items?
8.3. 6 To Draw an Ell ip se The Ellipse icon is accessed to draw an ellipse on the diagram. You can specify a fill and line pattern for the ellipse. 1. Select the Ellipse icon on the GBNT:Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas. Press and hold the left mouse button, and drag the radius to the desired size. Do not release the mouse button while drawing the ellipse. 3. Release the mouse button to complete the draw operation.
8.3.7 To Draw a Polyg on The Polygon icon is accessed to draw a polygon on the diagram. You can specify a fill pattern and a line pattern for the polygon. Note: A polygon must have at least three points. 1. Select the Polygon icon on the Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas, and click to mark the start point of the polygon. 3. Move the pointer on the drawing canvas, and click again to mark the next point for the polygon. 4. Continue to move and click to mark all vertex points of the polygon. 5. Hold down the Control key and left-click to select the final vertex point. The polygon automatically closes. Note: A line segment is automatically drawn between the last vertex and the first vertex to close the polygon.
8.3. 8 To Draw a Rectang le The Rectangle icon is accessed to draw a rectangle on the diagram. You can specify a fill pattern and line pattern for the rectangle. 1. Select the Rectangle icon on the GBNT:Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. 2. Move the pointer onto the drawing canvas. Press and hold the left mouse button, and drag the pointer to mark the lower right corner of the rectangle. Do not release the mouse button while drawing the rectangle. 3. Release the mouse button to complete the draw operation.
136
OW330_90
8.4 What is the Bar icon?
8.3. 9 To Draw a Dot The Dot icon is accessed to draw a dot on the diagram. 1. Select the Dot icon on the Draw toolbar. This item may be placed in the Background, Foreground, or Trigger section. The Dot window appears.
Figure 32: Dot Window 2. From the Size choice buttons, select a dot size. The choices are small, medium, and large. 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Dot window. Ap pl y — Saves the selected settings, but the Dot window remains open. Cancel — Quits the Dot window without saving any changes. 4. Move the pointer onto the drawing canvas. Click the left mouse button to position the dot on the graphic. The dot displays on the canvas.
8. 4
Wha t is the Bar icon? The Bar choice icon, on the Bar/PolyBar window defines a rectangle on a diagram that is partially filled based upon a process point value. The bar can be filled bottom up, top down, right to left, left to right, or up or down from the 0 value (bias). The actual process point value is scaled between the low and high scales of the bar. The bar is filled from the low limit end in the direction specified, up to the scaled process point value on the process diagram. The bias bar is filled from the position/value 0 up or down to the scaled process point value.
8.4. 1 To Draw a Bar 1. Select the Bar/PolyBar icon on the Draw toolbar.
OW330_90
137
8.4 What is the Bar icon? The Bar/PolyBar window appears.
Figure 33: Bar/PolyBar Window 2. Select the Bar choice button on the Bar/PolyBar window. 3. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 4. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 6. From the Direction choice buttons, select a bar direction. They are (from left to right): up , down , left , right , or bias . 7. Select one of the following buttons: Ok — Saves the selected settings, and quits the Bar/PolyBar window. Appl y — Saves the selected settings, but the Bar/PolyBar window remains open. Cancel — Quits the Bar/PolyBar window without saving any changes. 8. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the bar. Do not release the mouse button while drawing the bar. 9. Release the mouse button, and the bar displays. When the different bar orientations display in the Graphics Builder, they all fill to the same level. However, when the bar displays in the process diagram at the Ovation Operator Station, it fills to a variable amount, depending on the value of the process point specified. Note: An outlining rectangle does not appear with the bar on the process diagram at the Ovation Operator Station — only the amount of fill appears.
138
OW330_90
8.5 What is the Bitmap Image icon?
8. 5
What is the Bit map Image ico n? The Bitmap Image icon allows you to add a .bmp (bitmap) file to your graphic and then move it, copy it or resize it. The Bitmap window contains a scrolling list of all of the available .bmp files loaded on the system. The available .bmp files reside in the same directory as the .bmp files associated with diagram background bitmaps (the [ I nstal l at i onPat h] / mmi / gr aphi cs / cs t f i l es directory where "InstallationPath" is a user-defined directory). The bitmap scrolling lists on the Diagram Configuration window and the Bitmap Image window are identical. The .bmp files are imported to and exported from the Ovation Developer Studio in the same way as the diagram background .bmp files. See Importing and Exporting Graphics (see page 325).
8.5.1 To name a Bit map file 1. Bitmap file names must begin with an alphabetic character (A-Z, a-z). 2. You cannot have blanks in bitmap file names. 3. Only alphanumeric characters and "_" and "-" are allowed in the base part of the bitmap file name (where the base part does NOT include the .bmp extension. 4. Bitmap file names must have a .bmp extension. 5. The base part of the bitmap file name (where base part does NOT include the .bmp extension) must be <= 40 characters. Note: The Graphics Builder does not check for correctly named bitmap files when building the window scrolling list. If you select a bitmap file from the scrolling list that is named incorrectly, the graphic will not load/compile.
8.5.2 To Add a Bitm ap I mage to a Graphic 1. Select the Bitmap Image icon on the Draw toolbar. The Bitmap Image window appears
Figure 34: Bitmap Image Window 2. Select a bitmap image from the scrolling list.
OW330_90
139
8.6 What Is the Button icon? 3. Select the Ok button. 4. Move your cursor to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the desired maximum dimensions of the bitmap image. 5. Release the mouse button, and the bitmap image displays.
8. 6
Wha t Is the Butto n icon ? The BUTTON icon, looks like a smart_ma icon. It automatically changes its appearance when the button is pressed/released. It provides options to show the button in a disabled state (including hiding it altogether). The button has the same functionality as the current OL_Button (for example: poke or trigger). An optional tag can be associated with the button to support programmatically enabling/disabling the button at runtime by the way of the existing POKE_STATE command. The Button dialog is comprised of 3 tabs:
The appearance tab, used to set the look and feel of the button
The function tab, used to specify poke vs. trigger functionality
The state/tag tab, used to enable or disable the button, and set the disabled buttons apperance.
The appearance tab will only prompt for colors that are required to be defined for the button. Unneeded colors will be grayed out (for example: the shape colors if a colored shape is selected, or the BG text color if the overstrike option is not selected). The button dialog provides support for saving the current appearance settings in the Windows registry (independent from the standard Save Defaults feature) so you can configure the button basics one time only. Button conditionals are not saved in the registry. Button disabled appearance options are available on the ‘state/tag’ tab of the button dialog. There are seven options available. One of the available options is to not show the button when it is disabled. By changing the disable color, you can choose from subtle to blatant displays for their disabled buttons. Each button can have its own disabled configuration. Note: On the draw items toolbar, the button follows the OL_button. The OL_Button button has "OL" on the icon, where the BUTTON button does not have the “OL” on it; the “OL” refers to the open look style button which is still available.
140
OW330_90
8.6 What Is the Button icon?
8.6.1 But ton features
Rectangular (no rounded endcaps).
Sizing by an overall width and height (similar to how the OL buttons are sized); not size by button label configuration.
Width/height of the button border lines are configurable and scale on resize/zoom operations proportionally to the overall button.
Labels can be specified as text (including multitext), as a shape, as a combo (both shape and text), or can be omitted.
Can pass in text/multitext labels to buttons in macros via $T strings.
Labels can be positioned anywhere within the button, they do not have to be centered.
Any named color can be selected for the button; OL colors are not used in conjunction with this button.
GB derives the shading colors automatically from the named color.
Labels, label colors, label sizes, and label positions are all completely configurable from the button dialog; the text and shape parts of combo labels are configured independently of one another.
An optional bitmap image may be used as button background; labels displayed on top of the image .
Options are provided (on a per button basis) for showing the button in a disabled state, including hiding the button altogether.
There is an optional tag label (similar to the new tag for pokes) so that the the state of a button (or a set of buttons) can be externally change programmatically in a graphic via the POKE_STATE command.
A preview dialog box is available to view the appearance of the button as it is created/edited it, and allows a preview conditional attributes (if defined).
Resizable dialogs to define all associated conditionals.
8.6.2 But ton attrib utes This attribute can change based on a user-defined conditional:
Primary button color.
Text/multitext label (including support for not displaying any text if some condition is met).
Text/multitext label FG color.
Text/multitext label BG color.
Shape label (including support for not displaying a shape if some condition is met).
Shape label FG color.
Shape label BG color.
Button state (enabled/disabled).
OW330_90
141
8.6 What Is the Button icon?
8.6.3 But ton dialo g features
Will only prompt for colors that are required to be defined for the button.
Has unneeded colors grayed out (for example: the shape label colors if a colored shape is selected, or the BG text label color if the overstrike option is not selected).
Provides support for saving the current appearance settings in the Windows registry (independent from the standard Save Defaults feature) so that their button basics can be configured one time only.
Conditionals are not saved in the registry.
Reserved word, NULL_SHAPE can be used in conjunction with shape labels on buttons. The reserved word is used in a shape label conditional if no shape is to be displayed when some condition is met.
Text label, the empty string, “”, is used for the same purpose, enabling a button to only display a shape or text label if some condition is met.
Combo label for a button can be defined, where the text is always displayed, and a shape only displays if some error condition is met, or vice versa.
8.6.4 To create a But ton 1. Select the Button button on the Draw toolbar.
142
OW330_90
8.6 What Is the Button icon?
The Button dialog displays with the Button Preview (see page 149) beside it (which can also be accessed from the icon on the appearance tab).
OW330_90
143
8.6 What Is the Button icon? 2. Fill in the button appearance (see page 144) tab information. 3. Fill in the button function (see page 150) tab information. 4. Fill in the button state/tag (see page 152) tab information. 5. Select OK. To configu re the Button appea rance tab 1. Access the Button dialog (see page 142).
144
OW330_90
8.6 What Is the Button icon?
The Button dialog displays with the Button Preview (see page 149) beside it (which can also be accessed from the icon on the appearance tab).
OW330_90
145
8.6 What Is the Button icon? 2. Fill in the button appearance (see page 144) tab information. 3. Fill in the button function (see page 150) tab information. 4. Fill in the button state/tag (see page 152) tab information. 5. Select OK..
6. Select the appearance of the button using the appearance tab and the following table.
146
OW330_90
8.6 What Is the Button icon?
NAME
apply/change individual attr mode
P OSITION
D ESCRIPTION
Top of dialog box
Activates and deactivates different parts of the TEXT LABEL and SHAPE LABEL sections, depending on the state of the label options.
Preview Button
Opens the Preview window (see page 149).
Save Button
Saves the appearance settings.
Back Button
Resets the choices to the defaults.
button color 1st dropdown menu
Color - If the Button color is not to be passed into a macro. $COLORn - If the Button is in a macro and you want to pass the color into the macro
button color 2nd dropdown menu
Color - Lists all of the system colors. $COLORn - Lists $COLOR1 - $COLOR256
button conditionals
See To Specify a Conditional on the Button dialog (see page 148).
w h
Dimensions (in virtual Pixels)
w'
x, y position
label options
multitext text1..textN
Virtual height of button (independent of label if label extends outside of button). Virtual width of the left/right border lines of the button.
h' text/shape toggle
Virtual width of button (independent of label if label extends outside of button).
Virtual height of the top/bottom border lines of the button. adjust label pos
Allows position adjustment of button text or shape one at a time.
above TEXT
Text - SHAPE LABEL as well as BG color options will be grayed out.
LABEL
Multitext - SHAPE LABEL options willgrayed be grayed Shape - TEXT LABEL options will be out.out. Combo - Can be any combination of the above. None - TEXT LABEL and SHAPE LABEL options will be grayed out.
TEXT LABEL
If checked it allows multiple lines of text to be entered.
Virtual coordinate of upper left corner of button (independent of label if label extends outside of button); relative coordinates not supported here.
Input used in multitext mode.
overstrike
Enables BG (Background) color.
text
Input dialog area for the button text.
font (name)
Name of font to be used.
(font) style
REGULAR / BOLD / ITALIC / BOLD_ITALIC.
char w
Desired virtual character width.
char h
Desired virtual character height.
lw
1 (for all font_names other than OvationVectorFont). 1-16 (actual pixel line width for OvationVectorFont).
OW330_90
fg and bg color menus
See button color drop-down menus above.
fg and bg conditionals
See To Specify a Conditional on the Button dialog (see page 148).
147
8.6 What Is the Button icon?
NAME
shape rot
P OSITION
D ESCRIPTION
SHAPE LABEL
Name of any shape in shape library. Used to rotate the shape.
w
Desired virtual character width.
h
Desired virtual character height.
inv
Used to flip the shape, horizontally or vertically.
fg and bg color menus
See button color drop-down menus above.
fg and bg conditionals
See To Specify a Conditional on the Button dialog (see page 148).
7. Select one of the other tabs to continue configuring, or select OK to finish. To Specify a Conditional on the Button d
ialog
You may specify conditionals for button color, text label, shape label, text label colors, shape label colors, and/or runtime state on the Button dialog. Each of these conditionals is specified by the following ellipsis button:
1. Click on the ellipsis button to display a dialog to view/enter/edit the associated conditional. The dialog title tells you which conditional you are viewing/editing:
2. Enter/edit any conditionals 3. Select the checkmark button at the top left to check/save the conditional. 4. Select the middle button (the reset button) to restore the last saved conditional. 5. Select the last button (the eraser) to clear/erase the conditional.
148
OW330_90
8.6 What Is the Button icon?
Note: If a conditional is defined, the color of the conditional button changes to green as a visual clue that a conditional exists. If a conditional is defined, but contains an error, the color of the conditional button changes to red as a visual clue that an erroneous conditional exists:
Note: The conditional dialogs are fully resizable. Button Preview window The button preview dialog can be accessed from the preview button on the appearance tab. 1. Access the Button dialog (see page 144), the Button Preview window appears 2. Access the Appearance tab, left-click on the Button Preview button.
3. Select the display state, normal, invoked or disabled, to preview how the button will appear in that state. 4. Select the preview conditionals button to access the preview conditionals (see page 150) dialog.
OW330_90
149
8.6 What Is the Button icon? Button Preview C ondition al dialog The preview conditionals window allows easy access to and preview of, all the conditionals developed from the Button window. 1. With the Button Preview (see page 149) window open, left-click on the preview conditionals button.
2. Select any available conditionals developed from the button window. 3. View the button appearance on the Button Preview window. 4. Select Close. To configure the Button function tab 1. Open the button dialog (see page 142).
150
OW330_90
8.6 What Is the Button icon? 2. Select the function tab.
3. Select the Trigger or Poke Functionally. 4. If Trigger is chosen (for Poke see the next step), select the Control Trigger.
OW330_90
integer, $CONSTn, or Macro_Triggern.
1-255
Skip to Step #6.
151
8.6 What Is the Button icon? 5. If Poke is chosen, pull down the Poke Type and choose one of the following:
Diag/group, Diag # -0-100, Group # -0-100.
Program - Prog # -0-100.
Application - Cmd Line.
Help - File Keyname.
Option - Prog#, Diag, and Args.
Window - Diag # -0-100, Group # -0-100, Points
Ladder - Pt Name, Arg 1, Arg 2.
Control - Set Num 0-100, Set Value, List, Prog#, Diag, and Args
6. Select one of the other tabs to continue configuring, or select OK to finish. To configur e the Button state/ta g tab 1. Open the button dialog (see To create a Button (see page 142)).
152
OW330_90
8.6 What Is the Button icon? 2. Select state/tag tab.
3. Select the inital "runtime state" of the Button.
ON (enabled) – Button will be enabled when the graphic displays at runtime.
OFF (disabled) – Button will be disabled when the graphic displays at runtime.
1. Specify a conditional for the runtime state of the Button if desired (see To Specify a Conditional on the Button dialog (see page 148)).
OW330_90
153
8.7 What is the Date icon? 2. Select disabled color - If the Button disable color is not to be passed into a macro. $COLORn - If the Button is in a macro and you want to pass the color into the macro 3. Select a color: Color - Lists all of the system colors, or $COLORn - Lists $COLOR1 - $COLOR256 4. Select a disable display option: 0: set label color = disabled 1: set label color and overlay medium pattern 2: overlay heavy pattern 3: overlay medium pattern 4: overlay light pattern 5: overlay lightest pattern 6: hide button 5. Use Apply configuration to selected buttons. Only the selected buttons will be configured. 6. Use the Button Preview window to view the button with the available disabled display options if desired (make sure that the ‘display state’ is set to ‘disabled’ on the Button Preview dialog). 7. Specify an optional external tag label for the button (quoted string representing a label for the button ( “ ” used if no tag defined )). It must be defined if you want to enable/disable the button using the POKE_STATE command.
Define a string label for the button. The label is not case-sensitive and does not need to be enclosed in quotes.
Then, define an instance id. The instance id is a unique number used in conjunction with the label to search for buttons at runtime using the POKE_STATE command (see the POKE_STATE command documentation for information on how the tag label and instance id are used at runtime). See the National Graphics Language manual.
1. Set the label instance: None (-1) = no tag defined, or no instance id defined with tag). hand coded = user-specified integer if button is NOT part of a macro. $SETn = if instance id will be passed in to the macro. $CONSTn = if instance id will be passed in to the macro. $Pn $Im = if instance id will be read from a $P pointer at runtime variable (int) = named variable of type INT if instance id stored in variable 2. Select one of the other tabs to continue configuring, or select OK to finish.
8. 7
What is the Da te ico n? The Date icon displays the current date on the process diagram. You may select the format for the date display. For all text items (time, date, text, entry field, and so forth), you may select the size of the text characters used to display the string and may display the text in either a vector or bitmap font (see page 120).
8.7.1 To D isp lay the D ate on a Diagram 1. Select the Date icon on the Draw toolbar.
154
OW330_90
8.8 What is the Dynamic Line/Polygon icon? The Date window displays.
Figure 35: Da te Window 2. From the drop-down menu, select a date format. The choices are:
mm/dd/yy mmm dd, yyyy
mm/dd
mm-dd-yy
dd/mm/yy
where:
mm = month (1 through 12)
dd = date (1 through 31)
yy = year (0 through 99; the first two digits are 20)
mmm = month (JAN, FEB, MAR, APR, MAY, JUN, JLY, AUG, SEP, OCT, NOV, DEC)
3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Date window. Ap pl y — Saves the selected settings, but the Date window remains open. Cancel — Quits the Date window without saving any changes. 4. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the date string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 5. Release the mouse button to position the date string.
8. 8
Wha t is the Dynamic
Line/P olygo n icon?
The dynamic line/polygon icon is used to plot a line or polygon which may have dynamic (that is, changing) endpoints. The endpoints may be specified as integers, real constants, or process points. The x and y coordinates of each vertex are independent. X may be absolute and y may be dynamic or vice versa. Dynamic coordinates are specified as process points. Both x and y coordinates are scaled between low and high values for the given axis.
8.8.1 To Draw a Dynamic Line/Polygo
n
1. Select the Dynamic Lin e/Polygon icon on the Draw toolbar.
OW330_90
155
8.8 What is the Dynamic Line/Polygon icon? The Dynamic Line/Polygon window appears.
Figure 36 : Dynamic L ine/P olygon Window 2. From the Item choice buttons, select line or polygon . 3. At the Fitted curve check box, determine whether a curve or a straight line joins the vertices.
Click on the option and a checkmark appears in the box. A best-fit curve draws, joining the vertices.
Click on the option again, and the checkmark disappears. A straight line draws, joining the vertices.
4. Enter the low limit for scaling the x coordinates of the line/polygon in the low entry field in the x-axis limits box. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. Enter the high limit for scaling the x coordinates of the line/polygon in the high entry field in the x-axis limits box. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 6. Enter the low limit for scaling the y coordinates of the line/polygon in the low entry field in the y-axis limits box. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 7. Enter the high limit for scaling the y coordinates of the line/polygon in the high entry field in the y-axis limits box. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.)
156
OW330_90
8.9 What is the Entry Field icon? 8. Enter the number of seconds after which the foreground updates in the Update Rate entry field. Use the increment/decrement buttons to adjust the value if necessary. Valid range is 1 through 32,767. 9. Enter the x, y coordinate pairs in the x y coordinate pairs scrolling list. Enter one x and y coordinate pair per line. Do not enter a comma between x and y. Valid values for x, y coordinates are integers, real constants, process point/record fields, or pointers/offsets. Note: For a dynamic polygon, at least three coordinates must be entered. 10. Select one of the following buttons: Ok — Saves the selected settings, and quits the Dynamic Line/Polygon window. Ap pl y — Saves the selected settings, but the Dynamic Line/Polygon window remains open. Cancel — Quits the Dynamic Line/Polygon window without saving any changes. 11. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the dynamic line or polygon. Do not release the mouse button while drawing the dynamic line or polygon. 12. Release the mouse button, and the dynamic line or polygon displays.
8. 9
Wha t is the Entry Fie ld icon? The Entry Field icon defines an area of the process diagram for displaying information that is entered by an operator or obtained from an Ovation Operator Station application program. There can be a maximum of 254 entry fields per diagram. You may select the size of the text characters and the text in either a vector or bitmap font (see page 120).
8.9. 1 To Create an Entr y Field 1. Select the Entry Field icon on the Draw toolbar. . The Entry Field window displays.
Figure 37: Entry Field Window 2. The drop-down menu is used to specify whether the Entry Fld # is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_entryfld_n argument. Use the increment/decrement buttons to adjust the value, if needed.
OW330_90
157
8.9 What is the Entry Field icon?
If integer is selected, enter a (hard-coded) positive whole number representing a standard entry field. Valid range = 1 through 254.
The $CONSTn format is to be used if the entry is on a macro file and the entry field number is to be a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
The macro_entryfld_n format is to be used if the entry is on a macro file and a local entry field is to be used (as opposed to a standard entry field). If macro_entryfld_n is selected from the drop-down menu, enter the associated index for the “macro_entryfld_n” nomenclature in the entry field to the right of the menu. For example, for macro_entryfld_3, enter a “3” in the entry field after selecting macro_entryfld_n from the drop-down menu, where n = 1 through 254.
3. From the Type choice buttons, select the entry field type. The choices are: Operator — allows the operator to enter data into this entry field, but not a graphics application program. Program — allows a graphics application program to enter data into this entry field, but not an operator. Both — allows an operator and a graphics application program to write to the entry field. 4. From the State choice buttons, select the entry field state. The choices are: On — activates the entry field when the diagram displays on the Ovation Operator Station. Off — deactivates the entry field when the diagram displays on the Ovation Operator Station. 5. From the Format Type drop-down menu, select how the data entered in the entry field is interpreted. The choices are ASCII, integer , real , byte , hex (hexadecimal) , and exponential . 6. Define the length of the entry field (number of characters) in the # of Chars entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range = 1 through 80. 7. Select one of the following buttons: Ok — Saves the selected settings, and quits the Entry Field window. Ap pl y — Saves the selected settings, but the Entry Field window remains open. Cancel — Quits the Entry Field window without saving any changes. 8. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the entry field string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 9. Release the mouse button to position the entry field string. The entry field string displays as a series of E’s on the drawing canvas. Note: On the process diagram, the entry field typically displays as a rectangle. You can type as many characters into the rectangle (entry field) as are specified at the # of Chars option on the Entry Field window.
158
OW330_90
8.10 What is the Function Key Command?
8. 10 Wha t is the Function Key C
ommand?
The FUNC_KEY command is used to run one or more application programs from a function key (F1 - F10) on the standard Ovation Operator Station keyboard and/or from a programmable function key (P1 - P10) on the membrane keyboard. (See Ovation Operator Station User Guide.) There are 10 pkeys (P1 - P10) on the membrane keyboard of which you can program any/all of using this command. There are 12 available function keys (F1 - F12) on the standard keyboard, of which only the first 10 (F1 - F10) can be programmed using this command. Programming function keys F11 and F12 is not supported in the Ovation system. Pressing P1 on the membrane keyboard runs the programs associated with key #1 in this command, pressing standard keyboard. Pressing P2/F2 the programs associated as with key #2,F1 andonsothe forth. The pkeys and the function keysruns are exactly the same functionality. The only difference between the function keys and the pkeys is the keyboard where they exist. There can be only one FUNC_KEY definition for each of the possible 10 function/pkey in any one graphic. Thus, a graphic can have a maximum of 10 FUNC_KEY commands in it. An error displays if you try to add duplicate function/pkeys. Note that this rule also applies with respect to inclusion in macros. A macro does not load if it contains a FUNC_KEY command for a function key that is already defined in the current graphic. The Function Key icon (on the Draw toolbar) adds a FUNC_KEY command to the Keyboard section of a graphic. There is no display item associated with the FUNC_KEY command. It is similar in function to a poke type #7. The association of the application program(s) to the given function key is local to the graphic in which the function key command exists. When a function key on the membrane keyboard is pressed, the application programs defined by the FUNC_KEY command in the graphic currently active for keyboard input are executed. The graphic currently active for keyboard input on the Ovation Operator Station has the “LAI” (last active instance) designation in the status bar. If no graphic is currently active for keyboard input, or if the graphic does not contain an applicable FUNC_KEY command, then no application programs run when the function key is pressed.
8.10. 1 To cr eate a Functi on Key 1. Select the Function Key icon on the Draw toolbar.
OW330_90
159
8.10 What is the Function Key Command? The Function Key/Pkey window displays.
Figure 38: Function Key/Pkey Window 2. From the Function Key drop-down menu, select a function key. Valid choices are 1 through 10. The dialog allows application programs to be defined for one function key at a time. 3. From the State choice buttons, select one of the following: On activates the function key when the di agram displays on the Ovation Operator Station. Off deactivates the function key when the diagram displays on the Ovation Operator Station. 4. The List entry field displays the index of the current program being created/edited. Also, this entry field is used when you want to view or edit a particular program after it has already been defined (if more than one program is defined. Use the increment/decrement buttons to navigate through the lists. The large buttons to the right of the List entry field are used to add or delete lists. The first button adds a new list (this differs from the increment button in that it is used to add a list in between existing lists). The second button (shown with the “X”), is used to delete a list. 5. Go to the Prog # entry field, and enter the app lication program number to be called by the poke field. The program number may be specified as an integer or as a $Pn $Im pointer/offset pair. 6. Enter the diagram number in the Diag # entry field. The diagram number may be specified as an integer (valid range is 0 through 65,535) or as a $Pn $Im pointer/offset pair. 7. Enter the arguments in the Ar gs scrolling list. Note that string arguments are limited to 130 characters. 8. After all of the arguments have entered, select the Create button. The scrolling list clears, and the List entry field increments for the next program list. 9. Continue entering information (Prog #, Diag #, and Args scrolling list) for all of the desired application programs. After completing the information for each program, select the Create button.
160
OW330_90
8.11 What is the OL Button icon? The following figure shows the Function Key/Pkey window complete with all applicable information.
Figure 39: Function Key/Pkey Window -- Completed 10. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Function Key window. Ap pl y — Saves the selected settings, but the Function Key window remains open. Cancel — Quits the Function Key window without saving any changes. Note: There is no display item associated with the Function Key. You do not drag/position anything, and you do not see anything on the graphic to represent the Function Key.
8.10.2 To Modify Functi
on Key Scrolli ng L ist Entri es
After the arguments have been entered in the scrolling list, it may be necessary to modify the entries. To do this, follow the steps below: 1. Enter the number of the program to be modified in the List entry field. 2. Modify the Ar gs scrolling list, as needed. 3. Select the Ok or Appl y button.
8. 11 Wha t is the OL Butto n icon? The OL Button icon defines a button on a process diagram that is activated when selected with the mouse. Thiswhen button appears when select it with mouseorataruntime, appears raised you releasedepressed the mouse. Thisyou button may havethe a trigger poke and functionality.
OW330_90
161
8.11 What is the OL Button icon?
8.11. 1 To cr eate an OL B utt on 1. Select the OL Button icon on the Draw toolbar.
The OL Button window displays.
2. From the Orientation choice buttons, select one of the following: Horz — button endcaps are on the left and right sides. Text labels display with horizontal text. Vert — button endcaps are on the top and bottom. Text labels display with vertical text. 3. Select the button endcap style from the Endcap Style choice buttons: Rounded — endcaps are rounded. Squared — endcaps are squared (like brackets). Note that this is only obvious when the button dimensions (w and h) are larger than the default button size. For the default button size, the squared and rounded endcap styles are identical (they appear rounded). 4. From the Label Type choice buttons, select one of the following options: Shape — the button has a shape from the Shape Library (see page 277) as a label. the next step discusses the next procedure to be performed if this option is selected. Text — the button has a text string as a label. The button is sized to the text label. Skip the next step if this option is selected.
162
OW330_90
8.11 What is the OL Button icon? Depending on the selection made for Label Type, the OL Button window appears different. Additional entry items may be required. 5. If Label Type is set to Shape
— enter the following parameters:
Enter the shape name in the Label entry field.
A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.)
For shape rotation, you may pull down the Shape rotation menu and select one of the 90
To clear or erase the conditional statement, press the clear button above the entry field. degree increment rotations, or you may also specify anything other than 90 degree increments by typing in the entry field. Valid range is -360 through 360. Negative degrees represent clockwise rotation. Positive degrees represent counterclockwise rotation.
From the Shape inversion drop-down menu, select an inversion: NONE (no inversion), TTB (top to bottom), RTL (right to left), BOTH (top to bottom and right to left).
Enter the button dimensions in the Button Dimensions (w) and (h) entry fields. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 16,383 for both dimensions.
Enter the shape dimensions in the Shape Dimensions (w) and (h) entry fields. Use the increment/decrement buttons, if needed. The shape dimensions must be less than the button dimensions. Valid range is 1 through 16,383 for both dimensions.
6. If Label type is set t o Text:
Enter the appropriate information in the Label entry field. The required format is listed as . Text labels can be a maximum of 30 characters and must be enclosed in either single or double quotes.
A conditional statement allows the value of a parameter in a graphics command to change based upon entry a specified condition. To create statement a conditional, place the cursor in the rules. Conditional field. Enter the conditional according to the applicable (See Ovation Graphics Language Reference Manual.) To erase the conditional statement, press the clear button above the entry field.
7. From the Functionality choice buttons, select a function for the button: Trigger — a trigger executes when this button is selected (pressed). The next step discusses the next procedure to be performed if this option is selected. Poke — a poke function (any of the standard types defined for the poke field, except poke type 0) occurs when this button is selected (pressed). The next step discusses the next procedure to be performed if this option is selected. 8. If Function ality is set to Trigger — The drop-down menu is used to specify whether the Entry Fld # is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_entryfld_n argument. Use the increment/decrement buttons to adjust the value, if needed.
OW330_90
If integer is selected, enter a (hard-coded) positive whole number representing a standard entry field. Valid range = 1 - 255.
The $CONSTn format is to be used if the entry is on a macro file and the entry field number is to be a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
163
8.12 What is the PolyBar icon?
The macro_entryfld_n format is to be used if the entry is on a macro file and a local entry field is to be used (as opposed to a standard entry field). If macro_entryfld_n is selected from the drop-down menu, enter the associated index for the “macro_entryfld_n” nomenclature in the entry field to the right of the menu. For example, for macro_entryfld_3, enter a “3” in the entry field after selecting macro_entryfld_n from the drop-down menu, where n = 1 through 255.
9. If Functionality is s et to Poke — From the Poke Type drop-down menu, select the desired type of poke. As different types are selected, The OL Button window changes to include the necessary parameters for the poke type selected. Enter the required information for the chosen poke type (see page 183). 10. Select one of the following buttons: Ok — Saves the selected settings, and q uits the OL Button window. Ap pl y — Saves the selected settings, but the OL Button window remains open. Cancel — Quits the OL Button window without saving any changes. 11. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag the button’s outlining rectangle to the desired position on the canvas. Release the mouse button. The button is drawn on the canvas. Note: The font size for OL Button is defined by the current font attributes on the Font Attributes window. The overstrike option is not applicable to this item.
8. 12 What is the PolyBar icon
?
The PolyBar choice icon, on the Bar/PolyBar window, displays a partially filled polygon on a graphic. The amount of the filled portion of the polygon represents the current value of a process point, scaled between the defined low and high limits. The unfilled portion of the PolyBar displays in solid ER color (by the Graphics Builder and at runtime). You cannot change a PolyBar into a bar or vice versa; the Graphics Builder does not support any form of conversion. The bias PolyBar fills up OR down from the 0 value position. At runtime, value 0 MUST fall between the low and high limits or an error is displayed in the Graphics Builder and the PolyBar gcode is skipped. See the following table for PolyBar fill information. POL YB AR T YPE
164
L OW TO U PPER L IMIT FIL L
DOWN
Top to Bottom
UP
Bottom to Top
RIGHT
Left to Right
LEFT
Right to Left
BIAS
Bottom to Top
OW330_90
8.12 What is the PolyBar icon? The PolyBar draws the outline of the polygon (in addition to filling the polygon based on the point value). The PolyBar utilizes the current line width, line pattern, and fill pattern drawing attributes. It can be filled with any fill pattern (except 'unfilled'), and it can be drawn with any line pattern as well as conditional line and fill patterns. The Graphics Builder:Line Pattern/Width dialog is used to set/change the PolyBar line pattern and width; the Graphics Builder:Fill Pattern dialog is used to set/change the PolyBar fill pattern. The Graphics Builder displays an error and does not allow you to create a PolyBar if/when the 'unfilled' fill pattern is selected or is used for the default or conditional fill. The Graphics Builder:Color dialog is used to set/change the fg, bg, or er colors for the PolyBar. The fg and bg colors are used in conjunction with the line and fill patterns specified. A PolyBar item can be inverted, but it cannot be rotated. When a PolyBar is inverted, note that the fill direction may change, see the following table. Polybars cannot be rotated because fill directions are not angular. POL YB AR T YPE
I NVERSION
DOWN
Vertical
UP
Vertical
RIGHT
Horizontal
LEFT
Horizontal
BIAS
None
FIL L
Polybars are NOT valid in shapes. This command is valid in the background, foreground, trigger and macro trigger sections. It typically goes in the foreground section so its display updates.
8.12 .1 To Draw a Poly Bar 1. Select the Bar/PolyBar icon on the Draw toolbar. The Bar/PolyBar window appears. Note: A PolyBar must have at least three points.
Figure 40: Bar/PolyBar Window 2. Select the PolyBar choice button on the Bar/PolyBar window.
OW330_90
165
8.13 What is the OL Check Box icon? 3. Select a fill usingthe procedure in Setting Fill Pattern attributes (see page 124), you can also set other attributes such as color, line pattern, and line width. 4. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 5. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 6. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 7. From the Direction choice buttons, select a bar direction. They are (from left to right): up , down , left , right , or bias . 8. Select one of the following buttons: Ok — Saves the selected settings, and quits the Bar/PolyBar window. Appl y — Saves the selected settings, but the Bar/PolyBar window remains open. Cancel — Quits the Bar/PolyBar window without saving any changes. 9. Move the pointer to the drawing canvas. Click the left mouse button to mark the start point of the polygon. 10. Move the pointer on the drawing canvas, and click again to mark the next point for the polygon. 11. Continue to move and click to mark all vertex points of the polygon. 12. Hold down the Control key and left-click to select the final vertex point. The polygon automatically closes. WhenHowever, the different PolyBar orientations display the Graphics Builder, all fillOperator to the same level. when the PolyBar displays in thein process diagram at thethey Ovation Station, it fills to a variable amount, depending on the value of the process point specified.
8. 13 Wha t is the O L Che ck Box ic on? The OL Check Box icon defines a check box item on a process diagram. The check box item is both an input and an output device. It displays/sets the value according to the boxes which are currently checked. For an exclusive check box item, the value is the ordinal number of the box selected, starting at 0. For a non-exclusive check box item, the value is a bit mask, where each set bit corresponds to a checked box. The value is read each time the diagram updates, and the display of the check box changes if the value changes. You can manually change the value by selecting/deselecting boxes with the mouse. The boxes are checked/unchecked when you select them with the mouse. When you check/uncheck a box, the value updates, and the control trigger is executed. It is your responsibility to code the trigger to interpret the check box value and take whatever action is desired based on that value.
8.13. 1 To cr eate an OL Check
Box
1. Select the OL Che ck Bo x icon on the Draw toolbar.
166
OW330_90
8.13 What is the OL Check Box icon? The OL Check Box window displays.
2. Enter the Check Box Value entry field with one of the following values.
$P with a $In offset.
local/global variable of type int, or int(n)
$D with a $I offset.
3. Enter the number of boxes to be included in the check box item in the Boxes entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 32. 4. From the Orientation choice buttons, select one of the following choices: Horz — boxes are placed horizontally. Vert — boxes are placed vertically. 5. From the Type choice buttons, select whether the check box item should be exclusive or non-exclusive: Exclusive — only one box may be checked at a time. Selecting a new box with the mouse unchecks the currently checked box first, and then checks the current box. Non-Exclusive — multiple boxes may be selected at a time. Selecting a new box with the mouse toggles the state of that box (that is, if the box is checked, it becomes unchecked and vice versa). 6. The drop-down menu is used to specify whether the trigger is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_trigger_n argument. Use the increment/decrement buttons to adjust the value, if needed.
OW330_90
If integer is selected, enter a (hard-coded) positive whole number representing a standard trigger. Valid range (0 - 255), 0 implies that no trigger is executed.
The $CONSTn format is to be used if the ol check box is on a macro file and the trigger number is to be a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
167
8.13 What is the OL Check Box icon?
The macro_trigger_n format is to be used if the ol check box is on a macro file and a local trigger field is to be used (as opposed to a standard trigger field). If macro_trigger _n is selected from the drop-down menu, enter the associated index for the “macro_trigger _n” nomenclature in the entry field to the right of the menu. For example, for macro_trigger _3, enter a “3” in the entry field after selecting macro_trigger _n from the drop-down menu, where n = 1 through 255.
7. Enter the virtual pixels between consecutive boxes in the Spacing entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 16,383. See the following figure for an example of the spacing for a check box item.
spacing
Figure 41 : Spacing f or Check Bo x Item 8. Enter the virtual dimensions of each check box area (including the implicit part reserved for the upper part of the checkmark) in the Box (w) and (h) entry fields. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 16,383 for both dimensions. See the figure below for an example of a check box item width and height. x, y
h
w
Figure 42 : Width and Height of Check Box 9. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Check Box window. Ap pl y — Saves the selected settings, but the OL Check Box window remains open. Cancel — Quits the OL Check Box window without saving any changes. 10. Move the pointer to the drawing canvas. Press and hold the left mouse button, and move the pointer to the desired location on the drawing canvas. As soon as the move operation begins, a rectangle representing the outlining rectangle of the check box item appears on the diagram. As you move the mouse, the rectangle drags along with it. Do not release the mouse button while dragging the rectangle. 11. Release the mouse button, and the OL check box item displays.
168
OW330_90
8.14 What is the OL Choice icon?
Note: The Graphics Builder always displays a check in the first box of the check box item, whether it is exclusive or non-exclusive. The erase color is used to display the OL check box at runtime. Set erase color (see page 114) equal to the diagram background color for proper display. The Graphics Builder does not use the erase color to display check boxes.
8. 14 What is the OL Choic e ico n? The OL Choice icon defines a choice item on a process diagram. The choice item is both an input and an output device. It displays/sets the value according to which choice boxes are currently selected an aexclusive choicechoice item, the value the ordinal number of theeach itemset bit selected,(pressed). starting at For 0. For non-exclusive item, the is value is a bit mask, where corresponds to a selected item. The value is read each time the diagram updates, and the display of the choice item changes if the value changes. You can manually change the value by selecting/deselecting the choice with the mouse. The choices are pressed/raised (selected/deselected) when you select them with the mouse. When you select/deselect an choice, the value updates, and the control trigger is executed. It is your responsibility to code the trigger to interpret the choice item value and take the appropriate action based on that value. Text or shape labels may be displayed on the choice item.
8.14. 1 To cr eate an OL Cho ice i tem 1. Select the OL Choice icon on the Draw toolbar.
OW330_90
169
8.14 What is the OL Choice icon? The OL Choice window displays.
2. Enter the Choice Value entry field.
$P pointer with a $In offset (scratch pad area). local/global variable of type int, real, int(n), or real(n).
$D pointer with a $In offset.
3. Enter the number of choices to be included in the choice item in the Choices entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 64. 4. From the Orientation choice buttons, select one of the following: Horz — boxes are horizontally spaced across the diagram. Vert — boxes are vertically spaced down the diagram. 5. From the Type choice buttons, select one of the following: Exclusive — only one item may be selected at a time. Selecting a new item with the mouse deselects (raises) the currently selected (pressed) item first, and then selects the current item. Non-Exclusive — multiple items may be selected at a time. Selecting a new item with the mouse toggles the state of that item (that is, if the item is deselected (raised), it becomes selected (pressed) and vice versa). 6. The drop-down menu is used to specify whether the trigger # is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_trigger_n argument. Use the increment/decrement buttons to adjust the value, if needed.
170
If integer is selected, enter a (hard-coded) positive whole number repersenting the standard trigger #. Valid ranges 0 - 255, 0 implies that no trigger is executed.
OW330_90
8.14 What is the OL Choice icon?
The $CONSTn format is used if the ol choice is on a macro file and the trigger number is a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
The macro_trigger _n format is used if the ol choice is on a macro file and a local trigger field is used (as opposed to a standard trigger). If macro_trigger_n is selected from the drop-down menu, enter the associated index for the “macro_trigger_n” nomenclature in the entry field to the right of the menu. For example, for macro_trigger_3, enter a “3” in the entry field after selecting macro_trigger_n from the drop-down menu, where n = 1 through 255.
7. From the Label Type choice buttons, select one of the following options: Shape — each choice item has a shape from the Shape Library (see page 277) as a label. Step 8 discusses the next procedure to be performed if this option is selected. Text — each choice item has a text string as a label. Choice boxes are sized by the text label. Step 9 discusses the next procedure to be performed if this option is selected. Depending on the selection made for Label Type, the OL Choice window appears different. The Labels scrolling list changes to reflect the syntax for the type of label selected. Also, additional entry items may be required. 8. If Shape is selected for Label Type
— Enter the following parameters:
Enter the appropriate information in the Labels scrolling list. Shape labels consist of a shape name, rotation, and inversion. The required format is listed as: .
Valid rotations are -360 through 360. Negative degrees represent clockwise rotation. Positive degrees represent counterclockwise rotation. If no rotation is specified, the rotation defaults to 0.
Valid inversions are NONE (no inversion), TTB (top to bottom), RTL (right to left), and BOTH (top to bottom and right left). Shape names must exist in the Shape Library. If no inversion is specified, the to inversion defaults to NONE.
Enter the dimensions of the choice boxes in the Choice box (w) and (h) entry fields. All choice boxes are the same size for shape labels. Valid range is 1 through 16,383 for both dimensions.
Enter the shape label dimensions in the Shape (w) and (h) entry fields. Valid range is 1 through 16,383 for both dimensions. The shape label dimensions must be less than the choice box dimensions. All the shape labels scale to the same size. The following figure shows the OL Choice window (for shape labels) complete with all applicable information.
9. If Text is selected for Label Type
— The OL Choice window appears.
Enter the appropriate information in the Labels scrolling list. The required format is listed as . Text labels can be a maximum of 30 characters and must be enclosed in either single or double quotes.
10. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Choice window. Ap pl y — Saves the selected settings, but the OL Choice window remains open. Cancel — Quits the OL Choice window without saving any changes.
OW330_90
171
8.15 What is the OL Cylinder icon? 11. Move the pointer to the drawing canvas. Press and hold the left mouse button, and move the pointer to the desired location. As soon as the move operation begins, a rectangle representing the outlining rectangle of the choice item appears on the diagram. As you move the mouse, the rectangle drags along with it. Do not release the mouse button while dragging the rectangle. 12. Release the mouse button, and the OL Choice item displays. Note: The font size for OL Choice is defined by the current font attributes on the Font Attributes window (see page 120). The overstrike option is not applicable to this item. The Graphics Builder always displays the first box of the choice item selected, whether it is exclusive or non-exclusive.
8. 15 Wha t is the OL C ylind er icon? The OL Cylinder icon defines a cylindrical bar graph on a diagram that is partially filled based upon a process point value. The cylinder has a three-dimensional appearance and is filled bottom up. The actual process point value is scaled between the low and high scales of the cylinder. The low limit end of the cylinder is the bottom; the high limit end is the top.
8.15. 1 To Draw an OL Cylin der 1. Select the OL Cylinder icon on the Draw toolbar. The OL Cylinder window displays.
Figure 43: OL Cylinder Window 2. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 4. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Cylinder window.
172
OW330_90
8.16 What is the OL Event Menu icon? Appl y — Saves the selected settings, but the OL Cylinder window remains open. Cancel — Quits the OL Cylinder window without saving any changes. 6. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the cylinder. Do not release the mouse button while drawing the cylinder. 7. Release the mouse button, and the cylinder displays. Note: In order to display the OL Cylinder correctly at runtime, erase color must be set to the same color as the diagram background color. The Graphics Builder does not use the erase color to display the OL Cylinder.
8. 16 What is the O L Event Menu icon? The OL Event Menu icon defines a list of event or alarm conditions and the text messages to display if the conditions are met at runtime. A maximum of 32 alarm/event conditions may be defined. The alarm/event conditions are defined by a point name, a record field, and a status word. There are three possible display states for this item on the Ovation Operator Station at runtime:
If no alarm or error conditions are met, nothing displays.
If one alarm or event condition is met, the text message for that alarm or event displays.
If more than one alarm or event condition is met, an abbreviated menu symbol is displayed on the diagram, along with the first alarm or event message string. x, y
a. If no events, nothing displays.
x, y
b. If 1 event, only the message displays.
Longest Event Message x, y
c. If more than 1 event, the first event message displays and the abbreviated menu symbol displays.
Longest Event Message
If you click on the abbreviated menu symbol on the Ovation Operator Station at runtime, a drop-down menu lists all of the applicable alarm or event messages. This menu is for display purposes only (that is, you cannot acknowledge alarms from this menu). If you click on the abbreviated menu symbol while the menu is displayed, the menu disappears. Note: The Graphics Builder always displays the abbreviated menu symbol and the longest alarm or event message. The Graphics Builder does NOT support popping up the event menu when you click on the abbreviated menu symbol.
8.16 .1 To cr eate an OL Even t Menu 1. Select the OL Event Menu icon on the Draw toolbar. The OL Event Menu window displays.
OW330_90
173
8.16 What is the OL Event Menu icon? 2. Enter the number of alarm/event conditions in the Events entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 - 32. 3. Enter the alarm/event conditions and the associated text message strings in the scrolling list. The format of the scrolling list entry field is defined in the scrolling list title. The format is: The event/alarm message strings may be a maximum of 50 characters and must be enclosed by single or double quotes. (See Ovation Graphics Language Reference Manual.) Note: The point record field is no t optional, and there are no defaults defined. You must enter a record field for each point. Also, the record field must be an integer or byte record field (that is, real or ASCII record fields are not accepted). (See Ovation Record Types Reference Manual.) The following figure shows the OL Event Menu window complete with all applicable information.
Figure 44: OL E vent Menu Wind ow -- Comp leted 4. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the OL Event Menu window. Ap pl y — Saves the selected settings, but the OL Event Menu window remains open. Cancel — Quits the OL Event Menu window without saving any changes. 5. Move the pointer to the drawing canvas. Press and hold the left mouse button, and move the cursor to the desired location. As soon as the move operation begins, a rectangle representing the outlining rectangle of the event menu item appears on the diagram. As you move the mouse, the rectangle drags along with it. Do not release the mouse button while dragging the rectangle. Note: The font size for the event menu item is defined by the current font attributes on the Font Attributes window (see page 120). The overstrike option is not applicable to this item. 6. Release the mouse button and the OL Event Menu item displays.
174
OW330_90
8.17 What is the OL Gauge icon?
8. 17 What is the O L Ga uge icon ? The OL Gauge icon defines a gauge on a diagram that is partially filled based upon a process point value. The gauge can be filled bottom up, top down, right to left, left to right, or up or down from the center (bias) depending on the gauge direction. The actual process point value is scaled between the low and high scales on the gauge. The gauge is filled from the low limit end in the direction specified up to the scaled process point value on the process diagram. The bias gauge is filled from position 0 up or down to the scaled process point value. For all directions except the bias gauge, the low limit end of the gauge is marked by the endcap.
8.17 .1 To Draw an OL Gauge 1. Select the OL Gauge icon on the Draw toolbar. The OL Gauge window appears.
Figure 45: OL Ga uge Windo w 2. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 4. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the full range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. From the Direction choice buttons, select the OL Gauge direction. The choices are (from left to right): up , down , left , right , or bias . 6. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Gauge window. Appl y — Saves the selected settings, but the OL Gauge window remains open. Cancel — Quits the OL Gauge window without savi ng any changes.
OW330_90
175
8.18 What is the OL Rectangle icon? 7. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the OL Gauge. Do not release the mouse button while drawing the OL Gauge. 8. Release the mouse button, and the OL Gauge displays. When the different OL Gauge orientations display in the Graphics Builder, they all fill to the same level. However, when the OL Gauge displays in the process diagram at the Ovation Operator Station, it fills to a variable amount, depending on the value of the process point specified.
8. 18 What is the OL Rectangle icon? The OL Rectangle icon is accessed to draw a rectangle on the diagram except that OL Rectangle gives a three-dimensional appearance to the rectangle on the diagram. This item is for display purposes only. It cannot be pressed or released like a button or a poke field. This item may be displayed in the normal (raised) or the invoked (depressed) state.
8.18 .1 To Draw an OL Rectan gl e 1. Select the OL Rectangle icon on the Draw toolbar. The OL Rectangle window appears.
Figure 46: OL Rectangle Window 2. From the State choice buttons, select one of the following options: Normal — rectangle appears raised. Invoked — rectangle appears pressed in. 3. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Rectangle window. Appl y — Saves the selected settings, but the OL Rectangle window remains open. Cancel — Quits the OL Rectangle window without saving any changes. 4. Move the pointer onto the drawing canvas. Press and hold the left mouse button, and drag the pointer to mark the lower right corner of the OL rectangle. Do not release the mouse button while drawing the OL rectangle. 5. Release the mouse button to complete the draw operation.
176
OW330_90
8.19 What is the OL Slider icon?
8. 19 What is the OL Slider ico
n?
The OL Slider icon defines a slider on a process diagram. The slider is both an input and an output device. It displays /sets a value scaled between a low and a high limit. The value is read each time the diagram updates, and the display of the slider changes if the value changes. You can manually change the value by moving the slider control box with the mouse. As you move the slider control, the value is continuously updated. In addition, you may specify a trigger (readout trigger) to be called as the slider control moves. A unique trigger (control trigger) may be specified to be executed when the slider control is released. Note: The OL Slider may be used to do digital set point entry. This is implemented by calling the RUN_PROGRAMS command to run the XPID_DIGITAL (121) application program from within the control trigger. (See Ovation Graphics Language Reference Manual.) You can display a digital readout for the slider via the readout trigger. The readout trigger should be coded to display a PROCESS_PT item, displaying the value of the scratch pad area associated with the slider.
8.19 .1 To Create an OL
Slid er
1. Select the OL Slider icon on the Draw toolbar. The OL Slider window displays.
2. Enter the Slider Value entry field, which can be:
$P with a $Bn, $In,$Sn, or $Rn offset (scratch pad area)
local/global variable of type int, real, int(n), or real(n)
$D with a $Bn, $In,$Sn, or $Rn offset
3. names/record Enter the low limit forpointers/offsets, the value in the real Lowconstants, Limit entryand field. Valid values are point through fields, integers [-2,147,483,647 2,147,483,647]. (See Ovation Graphics Language Reference Manual.)
OW330_90
177
8.19 What is the OL Slider icon? 4. Enter the high limit for the value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. From the Direction choice buttons, select the OL Slider direction. The choices are (from left to right): up , down , left , or right . 6. The drop-down menu is used to specify whether the readout trigger # is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_trigger_n argument. Use the increment/decrement buttons to adjust the value, if needed.
If integer is selected, enter a (hard-coded) positive whole number representing the standard trigger #. Valid range 0 - 255, 0 implies that no trigger is executed.
The $CONSTn format is to be used if the ol slider is on a macro file and the readout trigger number is to be a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
The macro_trigger_n format is to be used if the ol slider is on a macro file and a local trigger field is to be used (as opposed to a standard trigger). If macro_trigger_n is selected from the drop-down menu, enter the associated index for the “macro_trigger_n” nomenclature in the entry field to the right of the menu. For example, for macro_trigger_3, enter a “3” in the entry field after selecting macro_trigger_n from the drop-down menu, where n = 1 through 255.
7. The drop-down menu is used to specify whether the control trigger # is to be specified as an integer (that is, hard-coded) or specified as a $CONSTn or macro_trigger_n argument. Use the increment/decrement buttons to adjust the value, if needed.
If integer is selected, enter a (hard-coded) positive whole number representing the standard trigger #. Valid range 0 - 255, 0 implies that no trigger is executed.
The $CONSTn format is to be used if the ol slider is on a macro file and the control trigger number is to be a parameter passed into the macro. If $CONSTn is selected from the drop-down menu, enter the associated index for the “$CONSTn” nomenclature in the entry field to the right of the menu. For example, for $CONST2, enter a “2” in the entry field after selecting $CONSTn from the drop-down menu, where n = 1 through 256
The macro_trigger_n format is to be used if the ol slider is on a macro file and a local trigger field is to be used (as opposed to a standard trigger). If macro_trigger_n is selected from the drop-down menu, enter the associated index for the “macro_trigger_n” nomenclature in the entry field to the right of the menu. For example, for macro_trigger_3, enter a “3” in the entry field after selecting macro_trigger_n from the drop-down menu, where n = 1 through 255.
8. Select one of the following buttons: Ok — Saves the selected settings, and quits the OL Slider window. Appl y — Saves the selected settings, but the OL Slider window remains open. Cancel — Quits the OL Slider window without saving any changes. 9. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the OL Slider. Do not release the mouse button while drawing the OL Slider. 10. Release the mouse button, and the slider displays. In the Graphics Builder the OL Slider displays with the maximum value. When the OL Slider displays in the process diagram at the Ovation Operator Station, the value of the OL Slider is read and displayed from the specified scratch pad area.
178
OW330_90
8.20 What is the Page command icon?
8. 20 What is the Page com mand icon ? The Page command is used to configure the up/down/right/left runtime paging of the current graphic. That is, at runtime, this command configures which graphic displays when you press the up/down/right/left paging buttons.
8.20 .1 To c reate a Page 1. To open the Page command dialog, select one of the following:
Page command icon at the end of the draw toolbar.
"Page" from the View menu tab.
Alt+P from the keyboard.
2. Fill in the Diag # and Group # positioning information for UP, DOWN, LEFT, and RIGHT. 3. Select OK.
8. 21 What is the Plot icon? The Plot icon shows the current value of a process point plotted over time and scaled between a low and high value on the process diagram. The process point value is always plotted along a straight line. The orientation of the line may be up, down, left, or right. You also specify a plot character for each value and how to join successive values plotted over time.
8.21 .1 To Draw a Plo t 1. Select the Plot icon on the Draw toolbar.
OW330_90
179
8.21 What is the Plot icon? The Plot window appears.
Figure 47: Plot Window 2. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 4. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. From the Dir (Direction) choice buttons, select a direction for the plot. The choices are (from left to right): up , down , left , or right . 6. From the Type drop-down menu, select a plot type. The choices are: none — invisible cursor position moves to plot the point, but nothing visible is plotted. lines — draws a line between successive plotted values. squarewave — plots a dot at each plot point and then draws a horizontal and/or vertical line between successive plotted values (diagonal lines are not drawn).
180
OW330_90
8.21 What is the Plot icon? shape — uses a specified shape from the Shape Library to plot the point. When this option is selected, the shape-specific items are added to the window as shown below.
Figure 48: Plot Window -- Showi ng Shape Type 7. If shape is selected for Type Plot window:
— Enter the required information that appears on the updated
Enter the shape name, width (w), and height (h) in the applicable entry fields.
For rotation, you may pull down the rot (rotation) menu and select one of the 90 degree increment rotations, or you may also specify anything other than 90 degree increments by typing in the entry field. Valid range is -360 through 360. Negative degrees represent
clockwise rotation. Positive degrees represent counterclockwise rotation. Pull down the inv (inversion) menu and select either NONE (no inversion), TTB (top to bottom), RTL (right to left), or BOTH (top to bottom and right to left).
Shape names must exist in the Shape Library (see page 277). 8. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Plot window. Ap pl y — Saves the selected settings, but the Plot window remains open. Cancel — Quits the Plot window without saving any changes. 9. Move the pointer onto the drawing canvas. Press and hold the left mouse button to mark one end of the plot, and drag either a horizontal or vertical line (depending on the selected orientation) to mark the maximum length of the plot line. Do not release the mouse button while drawing the plot. 10. Release the mouse button when the plot line is at the desired maximum length.
OW330_90
181
8.22 What is the Point Group Text icon?
8. 22 Wha t is the P oint Group Text icon? The Point (Pt) Group Text icon displays one of three group text strings. These strings are defined in the point group which is displayed with the diagram at the Ovation Operator Station. (See Ovation Developer Studio User Guide.) You may select the orientation of the text. For all text items (time, date, text, entry field, and so forth), you may select the size of the text characters used to display the string and may display the text in either a vector or bitmap font (see page 120).
8.22. 1 To Displ ay Pont Group Text Strin g 1. Select the Pt Group Text icon on the Draw toolbar. The Pt Group Text window displays.
Figure 49: Pt Group Text Window 2. From the Pt Group Text Str choice buttons, select a group text string number. Valid range is 1 through 3. 3. Enter the number of characters in the string in the Fld Width entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 80. 4. From the Orientation choice buttons, select one of the following: horz displays the group text string horizontally. vert displays the group text string vertically. 5. Select one of the following buttons: Ok — Saves the selected settings, and quits the Pt Group Text window. Ap pl y — Saves the selected settings, but the Pt Group Text window remains open. Cancel — Quits the Pt Group Text window without saving any changes. 6. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the group text string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 7. Release the mouse button to position the group text string. The group text string displays as a series of G’s on the drawing canvas. Note: On the process diagram, the group text string displays with the information that is defined in the Ovation Database. (See Ovation Developer Studio User Guide.)
182
OW330_90
8.23 What is the Poke Field icon?
8. 23 What is the P oke F ield icon ? The Poke Field icon defines an invisible rectangular area (poke field) on a process diagram that is activated when selected with the mouse. Various functions can be performed, depending on the type of poke field selected. A poke field can be turned on or off. If a poke field is off, a box is not displayed around the poke field area on the Ovation Operator Station, and the operator cannot activate the poke by selecting it.
8.23 .1 To cr eate a Poke Fi eld 1. Select the Poke Field icon on the Draw toolbar. The Poke window displays (common display shown below).
2. External Tag - For the optional External Tag, enter the name in the label fill-in.
instance id - For the optional External Tag, select an instance id: If the Instance id is none (-1), go to the next step. If the instance id is any choice other than none (-1), use the pull-down to find the desired instance id .
3. From the State choice buttons, select one of the following options: on — Activates the poke field when the diagram displays at the Ovation Operator Station. of f — Deactivates the poke field when the diagram displays at the Ovation Operator Station. 4. From the HiLite choice buttons, select one of the following options: on — Highlights the selected tab and all tab controls in blue. of f — No highlighting is done to the tab or tab controls. 5. From the Type drop-down menu, select the type of poke field for the diagram.
OW330_90
183
8.23 What is the Poke Field icon?
Note: The Poke window changes depending on the type of poke field selected. The procedures for using the following poke field types are discussed in the applicable sections.
Poke type 0 (Process Point) - Displays information for a specified p rocess point. When you click on this poke field, the Point Menu pop-up window displays with the point name given at the top of the window. From the Point Menu, you can access the Ovation Point Information program for the given point. (See Ovation Graphics Language Reference Manual.)
Poke type 1 (Multi Process Points) - Operates similar to Poke type 0, but you can pass it up to 99 points. When you click on this poke field, a menu displays listing all of the points. When you select 1 point from this menu, the Point Menu window displays with the given point name at the top of the window. From the Point Menu, you can access the Ovation Point Information program for the given point. Poke type 2 (Dia gram & group) - Displays a specified process dia gram with a specified group of points.
Poke type 3 (Simple Application Program) - Runs an application program specified by a program number. No arguments can be passed using poke type 3, so this can only be used to run an application program which does not take any arguments. Also, this poke only runs one application program. Use poke type 7 to run application programs which take arguments and/or to run a set of application programs.
Poke type 7 ( List of Application Programs) - Runs one or more appl ication programs specified by program number and passes any required arguments.
Poke type 8 (Window) - Displays a specified window diagram with a point group and a list of points to substitute for $W points.
Poke type 9 (Operating System Command) defined by a command line.
Poke typ e 20 (Help) - Displays help on a defined item.
Poke type 23 (Control) - Similar to the Poke type 7 poke field except that the set number and set value specified here must match the set number and set value that was defined in the poke field that was used to select the device. (See Ovation Graphics Language Reference Manual.)
- Runs an operating system process
Note: Pokes have no color associated with them in the .diag file. In the Graphics Builder when loading a .diag file, the color for the poke field defaults to BG white, FG black, and ER white. Finish the Poke field creation by going to the selected Poke type:
184
Poke typ e 0 (see page 185). Poke typ e 1 (see page 185). Poke typ e 2 (see page 186). Poke typ e 3 (see page 186). Poke typ e 7 (see page 188). Poke type 8. (see page 187) Poke type 9. (see page 188) Poke type 20. (see page 188) Poke type 23. (see page 188)
OW330_90
8.23 What is the Poke Field icon? To Create a P roc ess Poin t (0) Poke Field 1. Make the proper selections in the Poke window (see page 183).
2. Enter the process point name and record field in the Pt Name entry field. (See Ovation Record Types Reference Manual.) 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the GBNT:Poke window. Appl y — Saves the selected settings, but the GBNT:Poke window remains open. Cancel — Quits the GBNT:Poke window without saving any changes. 4. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 5. Release the mouse button, and the poke field displays. To Create a Multi Proc ess (1) P oin t Poke Field 1. Make the proper selections in the Poke window (see page 183). 2. Enter all of the process point names in the Pt List entry field. (One point name per line.) 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the GBNT:Poke window. Appl y — Saves the selected settings, but the GBNT:Poke window remains open. Cancel — Quits the GBNT:Poke window without saving any changes. 4. Move the pointer to the drawing canvas. 5. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Note: Do not release the mouse button while drawing the poke field. 6. Release the mouse button, and the poke field displays.
OW330_90
185
8.23 What is the Poke Field icon? To Create a Diagram/G roup (2) Poke Field 1. Make the proper selections in the Poke window (see page 183). 2. Enter the diagram number in the Diag # entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 65,535. 3. Enter the group number in the Group # entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 5,000. 4. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the GBNT:Poke window. Ap pl y — Saves the selected settings, but the GBNT:Poke window remains open. Cancel — Quits the GBNT:Poke window without saving any changes. 5. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 6. Release the mouse button, and the poke field displays. To Create a Applic ation Prog ram (3) Poke Field 1. Make the proper selections in the Poke window (see page 183). 2. Enter the program number in the Prog # entry field. Use the increment/decrement buttons to adjust the value, if needed. (See Ovation Graphic Language Reference Manual.) 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Poke window. Ap pl y — Saves the selected settings, but the Poke window remains open. Cancel — Quits the Poke window without saving any changes. 4. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 5. Release the mouse button, and the poke field displays. To Create a n Opti ons (7) Poke Field 1. Make the proper selections in the Poke window (see page 183). Note: This type of poke field deals with graphics application programs. (See Ovation Graphics Language Reference Manual.) 2. The List entry field displays the index of the current program being created/edited. Also, this entry field is used when you want to view or edit a particular program after it has already been defined (if more than one program is defined). Use the increment/decrement buttons to navigate through the lists. The large buttons to the right of the List entry field are used to add or delete lists. The first button adds a new list (this differs from the increment button in that it is used to add a list in between existing lists). The second button (shown with the “X”), is used to delete a list. 3. Go to the Prog # entry field, and enter the ap plication program number to be called by the poke field. The program number may be specified as an integer or as a $P $In pointer/offset pair.
186
OW330_90
8.23 What is the Poke Field icon? 4. Enter the diagram number in the Diag # entry field. The diagram number may be specified as an integer (valid range is 0 through 65,535) or as a $P $In pointer/offset pair. 5. Enter the arguments in the Ar gs scrolling list. Note that string arguments are limited to 130 characters. 6. After all of the arguments have been entered, select the Create button. The scrolling list clears, and the List entry field increments for the next program list. 7. Continue entering information (Prog #, Diag #, and Args scrolling list, as described in Steps 4 through 6) for all of the desired application programs. After completing the information for each program, select the Create button. 8. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Poke window. Ap pl y — Saves the selected settings, but the Poke window remains open. Cancel — Quits the Poke window without saving any changes. 9. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 10. Release the mouse button, and the poke field displays. To Modify Options Poke Fie ld Scrolling List Entries After the arguments have been entered in the scrolling list, it may be necessary to modify the entries. To do this, follow the steps below: 1. Enter the number of the program to be modified in the List entry field. 2. Modify the Ar gs scrolling list, as needed. 3. Select the Ok or Appl y button. To Create a Window (8) Poke Field 1. Make the proper selections in the Poke window (see page 183). 2. Enter the diagram number in the Diag # entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 65,535. 3. Enter the group number in the Group # entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is -1 through 5,000. A group number of -1 means that the active group for the main screen diagram should be used with this window. 4. Enter the point name(s) to substitute for the $W pointer(s) in the Points scrolling list. (See Ovation Graphics Language Reference Manual.) 5. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Poke window. Ap pl y — Saves the selected settings, but the Poke window remains open. Cancel — Quits the Poke window without saving any changes. 6. upper Move left the corner pointerof tothe thepoke drawing Press and holdtothe mousedimension. button to mark the field,canvas. and drag a rectangle theleft desired Do not release the mouse button while drawing the poke field. 7. Release the mouse button, and the poke field displays.
OW330_90
187
8.23 What is the Poke Field icon? To Create an App licati on (9) (Poke Field 1. Make the proper selections in the Poke window (see page 183). 2. Enter an ASCII command string in the Cmd Line entry field. Do not enclose the string in quotes. The command line is limited to 130 characters. 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the GBNT:Poke window. Ap pl y — Saves the selected settings, but the GBNT:Poke window remains open. Cancel — Quits the GBNT:Poke window without saving any changes. 4. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 5. Release the mouse button, and the poke field displays. To Create a Help (20) Poke Field Help poke fields are not supported in the current release of the Ovation Windows software. To Create a Control (23) Poke Field 1. Make the proper selections in the Poke window (see page 183). Note: This type of poke field deals with graphics application programs. (See Ovation Graphics Language Reference Manual.) 2. You may hard code the set number, or you may specify the set number as a $SETn argument if the poke field is to be part of a macro file and the set number is to be a parameter to the macro. To hard code the set number, enter the set number in the Set Num entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 255. (See Ovation Graphics Language Reference Manual.) To specify the set number as a $SETn argument, select the $SET choice button and then enter the “n” index in the entry field to the right of the $SET choice button. For example, for $SET2, select the $SET choice button and enter a “2” in the entry field beside it. 3. Enter the set value in the Set Value entry field. Valid range is 0 through 32,767. (See Ovation Graphics Language Reference Manual.) 4. The List entry field displays the index of the current program being created/edited. Also, this entry field is used when you want to view or edit a particular program after it has already been defined (if more than one program is defined). Use the increment/decrement buttons to navigate through the lists. The large buttons to the right of the List entry field are used to add or delete lists. The first button adds a new list (this differs from the increment button in that it is used to add a list in between existing lists). The second button (shown with the “X”), is used to delete a list. 5. Go to the Prog # entry field, and enter the a pplication program number to be called by the poke field. The program number may be specified as an integer or as a $P $In pointer/offset pair. 6. Enter the diagram number in the Diag # entry field. The diagram number may be specified as an integer (valid range is 0 through 65,535) or as a $P $In pointer/offset pair.
188
OW330_90
8.23 What is the Poke Field icon? 7. Enter the arguments in the Ar gs scrolling list. Note that string arguments are limited to 130 characters. 8. After all of the arguments have entered, select the Create button. The scrolling list clears, and the List entry field increments for the next program list. 9. Continue entering information (Set Num, Set Value, Prog #, Diag #, and Args scrolling list) for all of the desired application programs. After completing the information for each program, select the Create button. The following figure shows the Poke window (for poke type 23) complete with all applicable information.
Figure 50: Poke Windo w Contr ol (23) Type -- Completed 10. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Poke window. Ap pl y — Saves the selected settings, but the Poke window remains open. Cancel — Quits the Poke window without saving any changes. 11. Move the pointer to the drawing canvas. Press and hold the left mouse button to mark the upper left corner of the poke field, and drag a rectangle to the desired dimension. Do not release the mouse button while drawing the poke field. 12. Release the mouse button, and the poke field displays. To Modify (23) Control Poke Field Scrolling List Entries After the arguments have been entered in the scrolling list, it may be necessary to modify the entries. To do this, follow the steps below: 1. Enter the number of the program to be modified in the List entry field.
OW330_90
189
8.24 What is the Process Point button? 2. Modify the Ar gs scrolling list, as needed. 3. Select the Ok or Appl y button. Poke fie ld displ ay in an edit session How Poke fields display in a GB edit session is configurable. 1. Select the Pull down the menu from the View menu and select Poke field display.
The standard poke field display is the first choice on the menu. The other choices display as unfilled rectangles with the stated line patterns. The color for the poke_fld is picked up from the applicable COLOR statement in the source file. Only the FG color is used in the line pattern The underlying background pixels on the graphic are maintained in the line pattern instead of the BG Color.
8. 24 Wha t is the Process P oint but ton? The Process Point button displays the contents of a process point record field (in ASCII format) on the process diagram. The contents of the record field may or may not be scaled between a low and high value before display. The record field is a conditional parameter (you may specify a conditional to determine which record field value is displayed). For all text items (time, date, text, entry field, and so forth), you may select the size of the text characters used to display the string and may display the text in either a vector or bitmap font (see page 120).
8.24. 1 To Displ ay a Process
Point on a Diagram
1. Select the Process Point button on the Draw toolbar.
190
OW330_90
8.24 What is the Process Point button? The Process Point window appears.
Figure 51 : Process Point Window 2. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.) To clear or erase the conditional statement, press the clear button beside the entry field. Note: The Pt Name/Rec Fld entry field must be set before a conditional may be applied since you must know the type of point for error checking of the conditional values. 4. Specify the number of characters for the process point display in the Fld Width entry field. Use the increment/decrement buttons to adjust the value, if necessary. Valid range = 1 through 80. 5. From the Point Quality choice buttons, select one of the following options: Off — does not display the point quality. On — displays the poin t quality (it uses one character of the total field width specified). (See Ovation Record Types Reference Manual.) 6. Enter the number of decimal places for the display in the Decimal Places entry field. Entering “-1” means that the decimal places specified in the FM record field for the given point should be used. Valid range = -1 through [Fld Width - 1] (that is, if field width is 10, valid range is -1 through 9).
OW330_90
191
8.24 What is the Process Point button? 7. From the Orientation choice buttons, select one of the following: Horz — displays the process point string horizontally. Vert — displays the process point string vertically. 8. From the Format Type drop-down menu, select one of the following:
right — right justified; left padded with blanks.
right0 — right justified; left padded with zeros.
center — centered left and right padded with blanks.
left — left justified; right padded with blanks.
hex — hexadecimal format (base 16) without the trailing “h”.
hex_h — hexadecimal format (base 16) with the trailing “h. binary — binary format (base 2).
exponential — exponential format.
technical — similar to exponential format but exponent must be divisible by 3.
date_only — displays the value of the U4 or U6 record fields as only the date. For example, 12/31/01.
time_only — displays the val ue of the U4 or U6 record fields as only the time. For example, 19:00:00.
date_time — displays the value of the U4 or U6 record fields as the date and time. For example, 12/31/01 19:00:00.
date_time_zone — displays the val ue of the U4 or U6 record fields as the date, time, and time zone. For example, 12/31/01 19:00:00 EST.
date_time_nosec — displays the value of the U4 or U6 record fields as the date and time, with no seconds shown. For example, 12/31/01 19:00.
date_noyear_time_nosec — displays the value of the U4 or U6 record fields as the date with no year and the time with no seconds shown. For example: 12/31 19:00. (For more information see Ovation Record Types Reference Manual.)
Note: If the Field Width parameter is not long enough to contain the format specified, the date/time display truncates to fit the specified width. 1. From the Scale choice buttons, select one of the following: On — displays the process point value as a percentage scaled between a low and high value. Off — displays the actual process point value with no scaling. 2. If on was selected for Scale, enter the low and high scale values in the % low and % high entry fields. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Process Point window. Ap pl y — Saves the selected settings, but the Process Point window remains open. Cancel — Quits the Process Point window without saving any changes. 4. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the process point string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string.
192
OW330_90
8.25 What is the Shape button? 5. Release the mouse button to position the process point string. The process point string displays as a series of question marks on the drawing canvas. Note: On the process diagram, the process point string displays with the contents of the point record specified on the Process Point window.
8. 25 What is the Shape but ton ? The Shape button displays the GBNT:Shapes window. Note that the same window displays when you select Shape Library from the File pull-down menu. Before 277). they can be used in a diagram, shapes must be added to the Shape Library (see page
8.25. 1 To Ad d a Shape to a Diagram 1. Select the Shape button on the Draw toolbar. The Shape Library window displays.
2. Select the tab containing the shape you want to draw, or select the "all" tab to view all shapes, or select the "all" tab if your not sure which tab contains the desired shape 3. can To select a shape, click by on simply it. The entering name of the the shape shape name appears in the shape entry field. You also select a shape in the shape entry field.
OW330_90
193
8.26 What is the Text button?
Note: To display the shape name at the mouse pointer, click the right mouse button while pointing at the shape in the window. 4. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Manual.) To clear or erase the conditional statement, press the clear button above the entry field. 5. Select one of the following buttons: Ok — Saves the selected settings, and qu its the Shape Library window. Ap pl y — Saves the selected settings, but the Shape Library window remains open. Cancel — Quits the Shape Library window without savi ng changes. 6. Move the pointer to the drawing canvas. Press and hold the left mouse button to display the shape’s outlining rectangle. Move the rectangle to the desired location on the screen. Do not release the mouse button while moving the rectangle. The outlining rectangle for a shape is a fixed size; therefore, it is not “dragged” like other outlining rectangles. 7. Release the mouse button, and the shape displays. Note: When a shape is drawn/added initially to a graphic, it is always drawn in its “as built” size. Once the shape is drawn/added to the graphic, it can be resized as desired. To separate a shape into its individual items, select the Unshape menu item from the Edit menu.
8. 26 What is the Text but ton ? The Text button is used to display three different types of text:
Single Text Multiple Text
Text Groups
Single Text is a text string of 80 characters or less. The string cannot contain linefeed characters. Multiple Text displays a maximum of 10 strings which are treated as a single entity. Multiple text strings are limited to 30 characters. You specify the justification and the interline spacing for the multi-text strings. Text Group strings are read from the active text group file. The text group file is an external ASCII file which contains up to 200 user-defined strings. The format of a line in this file is: , where index = 1 - 200, and string length is 80 characters or less. For all text items (time, date, text, entry field, and so forth), you may select the size of the text characters used to display the string and may display the text in either a vector or bitmap font. In addition, you may display various text strings depending on the evaluation of a conditional expression for all text types. 1. Select the Text button on the GBNT:Draw toolbar. 2. The GBNT:Text window displays (see the following sections for window examples).
194
OW330_90
8.26 What is the Text button?
8.26. 1 To use t he Sing le Text Opti on If Single Text is selected, the Text window appears as shown in the following figure.
Figure 52: Text Window (Single Text) 1. Enter a text string in the Text [no quotes] entry field. The maximum number of characters is 80. The string must no t be enclosed in either single or double quotes. 2. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules (See Ovation Graphics Language Reference Manual.) To clear or erase the conditional statement, press the clear button above the entry field. Note: Conditional text strings must be enclosed in quotes. The same quote (single or double) must be used to start and end the string (for example, “text” and ‘text’ are valid, but “text’ and ‘text” are not valid). Conditional strings are limited to 80 characters for normal text and 30 characters for multi-text. 3. From the Orientation choice buttons, select one of the following: Horz — displays the text string horizontally. Vert — displays the text string vertically. 4. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Text window. Ap pl y — Saves the selected settings, but the Text window remains open. Cancel — Quits the Text window without saving any changes.
OW330_90
195
8.26 What is the Text button? 5. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the text string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 6. Release the mouse button to position the text string. Note: You specify the orientation of the characters (horizontal or vertical) for single text and text groups only; horizontal is assumed for multiple text.
8.26. 2 To use th e Multip le Text Optio n If Multiple Text is selected, the Text window appears as shown in the following figure.
Figure 53: Te xt Wind ow (Multip le Text) 1. Enter at least two text strings in the Text Strings (no quotes) entry field. The maximum number of characters is 30. The strings must not be enclosed in either single or double quotes. 2. From the Justification drop-down menu, select one of the following: left — strings are left justified with the first string. right — strings are right justified with the longest string. center — strings are center justified with the longest string. 3. Enter the interline spacing for multiple text strings in the Spacing entry field. The spacing is in pixels. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 0 through 150. 4. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.)
196
OW330_90
8.26 What is the Text button? To clear or erase the conditional statement, press the clear button above the entry field. Note: Conditional text strings must be enclosed in quotes. The same quote (single or double) must be used to start and end the string (for example, “text” and ‘text’ are valid, but “text’ and ‘text” are not valid). Conditional strings are limited to 80 characters for normal text and 30 characters for multi-text. 5. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Text window. Ap pl y — Saves the selected settings, but the Text window remains open. Cancel — Quits the Text window without saving any changes. 6. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the text string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 7. Release the mouse button to position the text string. Note: You specify the orientation of the characters (horizontal or vertical) for single text and text groups only; horizontal is assumed for multiple text.
8.26. 3 To use th e Te xt Gro ups Optio n If Text Groups is selected, the Text window appears as shown in the following figure.
Figure 54: Te xt Wind ow (Text Groups) 1. Enter the text group string number in the Text Group entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 200. This is the index of the string in the text group file. (See Ovation Developer Studio User Guide.)
OW330_90
197
8.27 What is the Time button? 2. Enter the number of characters of the text group string to display in the Field Width entry field. Use the increment/decrement buttons to adjust the value, if needed. Valid range is 1 through 80. 3. A conditional statement allows the value of a parameter in a graphics command to change based upon a specified condition. To create a conditional, place the cursor in the Conditional entry field. Enter the conditional statement according to the applicable rules. (See Ovation Graphics Language Reference Manual.) To clear or erase the conditional statement, press the clear button above the entry field. Note: Conditional text strings must be enclosed in quotes. The same quote (single or double) must be used to start and end the string (for example, “text” and ‘text’ are valid, but “text’ and ‘text” are not valid). Conditional strings are limited to 80 characters for normal text and 30 characters for multi-text. 4. From the Orientation choice buttons, select one of the following: Horz — displays the text string horizontally. Vert — displays the text string vertically. 5. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Text window. Ap pl y — Saves the selected settings, but the Text window remains open. Cancel — Quits the Text window without saving any changes. 6. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the text string on the canvas. Move the pointer to the desired location. Do not release the mouse button while moving the string. 7. Release the mouse button to position the text string. Note: You specify the orientation of the characters (horizontal or vertical) for single text and text groups only; horizontal is assumed for multiple text.
8. 27 What is the Time but ton ? The Time button displays the current time on the process diagram. You may select the format for the time display. For all text items (time, date, text, entry field, and so forth), you may select the size of the text characters used to display the string and may display the text in either a vector or bitmap font (see page 120).
8.27. 1 To Disp lay Time on a Diagram 1. Select the Time button on the Draw toolbar.
198
OW330_90
8.28 What is the Trend button? The Time window displays.
Figure 55: Time Window 2. From the drop-down menu, select a time format. The choices are:
hh:mm:ss hh:mm:ss:t
hh:mm
where:
hh = hour (00 through 23)
mm = minute (00 through 59)
ss = second (00 through 59)
t = tenth of a second (0 through 9)
3. Select one of the following buttons: Ok — Saves the selected settings, and qui ts the Time window. Ap pl y — Saves the selected settings, but the Time window remains open. Cancel — Quits the Time window without saving any changes. 4. Move the pointer onto the drawing canvas. Press and hold the left mouse button to display the time string the canvas. Move the pointer to the desired location. Do not release the mouse button whileonmoving the string. 5. Release the mouse button to position the time string.
8. 28 What is the Trend but ton ? The Trend button displays a graph that shows the current value of a process point sampled over time on the process diagram. The process point value is scaled between low and high limits. You define the number of values to display and the time interval between successive values. You may trend the point showing time along the x or the y axis (horizontal or vertical orientation). The trend area is defined by an outlining rectangle, and the spacing between successive values is determined by dividing the length of the x or y axis by the number of values to trend. Multiple trends may exist in the same area of the diagram but with undesirable interaction.
8.28 .1 To Draw a Trend 1. Select the Trend button on the Draw toolbar.
OW330_90
199
8.28 What is the Trend button? The Trend window displays.
Figure 56: Trend Window 2. Enter the process point name and record field in the Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. Enter the low limit for the process point value in the Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 4. Enter the high limit for the process point value in the High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. Enter the time interval (time in seconds between successive readings of the values) in the Interval Time entry field. Use the increment/decrement buttons to adjust the value if necessary. Valid range = 1 through 10,000. 6. Enter the number of samples (value readings) to show in the trend in the # of Samples entry field. Use the increment/decrement buttons to adjust the value if necessary. Valid range = 1 through 600. 7. Select the trend direction using the Orientation choice buttons. The first option is time on the horizontal axis. The second option is time on the vertical axis. 8. Select one of the following buttons: Ok — Saves the selected settings, and qu its the Trend window. Ap pl y — Saves the selected settings, but the Trend window remains open. Cancel — Quits the Trend window without saving any changes. 9. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the trend. Do not release the mouse button while drawing the trend. 10. Release the mouse button, and the trend displays. Note: The x and y axes do no t appear on the process diagram at the Ovation Operator Station.
200
OW330_90
8.29 What is the XY Plot button?
8. 29 What is the X Y Plot butt on? The XY Plot button is used to plot two points sampled over time against one another on the process diagram. One point is scaled along the x-axis, the other point is scaled along the y-axis, and the point of their intersection is plotted. You define the rectangular area for the entire plot. The XY Plot is defined in a single orientation where 0, 0 is the lower left corner of the rectangular plot area. You specify the low and high scale values for each axis.
8.29 .1 To Draw an XY Plo t 1. Select the XY Plot button on the Draw toolbar. The XY Plot window displays.
Figure 57: XY Plot Windo w 2. Enter the process point name and record field associated with the x-axis in the (x-axis) Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 3. Enter the process point name and record field associated with the y-axis in the (y-axis) Pt Name/Rec Fld entry field. (See Ovation Record Types Reference Manual.) 4. Enter the low limit for the x-axis process point value in the (x-axis) Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 5. Enter the low limit for the y-axis process point value in the (y-axis) Low Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 6. Enter the high limit for the x-axis process point value in the (x-axis) High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 7. Enter the high limit for the y-axis process point value in the (y-axis) High Limit entry field. Valid values are point names/record fields, pointers/offsets, real constants, and integers in the range of [-2,147,483,647 through 2,147,483,647]. (See Ovation Graphics Language Reference Manual.) 8. Enter the number of seconds after which the XY Plot updates in the Update Rate entry field. Use the increment/decrement buttons to adjust the value, if necessary. Valid range is 1 through 32,767.
OW330_90
201
8.29 What is the XY Plot button? 9. At the Shape Plot check box, select or deselect the box. Selecting the box plots a shape instead of a dot. If the box is no t selected/checked, the dot is plotted. When the box is selected/checked, the XY Plot window appears as shown below.
Figure 58: XY Plot Windo w (Shape Plot bo x ch ecked) 10. If shape plot is selected — Enter the required information that appears on the updated XY Plot window:
202
Enter the name of the shape to be plotted to represent the current value in the shape entry field in the current value box. This must be a name from the active Shape Library (see page 277).
Enter the width and height to scale the current shape in the (W) and (H) entry fields. Use the increment/decrement buttons to adjust the value if necessary. The width and height are in virtual coordinates. Valid range is 1 through 16,383.
For rotation, you may pull down the Rot (rotation) menu and select one of the 90 degree increment rotations, or you may also specify anything other than 90 degree increments by typing in the entry field. Valid range is -360 through 360. Negative degrees represent clockwise rotation. Positive degrees represent counterclockwise rotation.
Select an inversion for the current shape from the Inv (inversion) drop-down menu. The choices are NONE (no inversion), TTB (top to bottom inversion), RTL (right to left inversion), BOTH (top to bottom and right to left inversion).
Enter the name of the history shape in the shape entry field in the history values box. The history shape is the shape from the shape library used to display past values of the xy plot. Remember that the xy plot does not clear the past values. The history shape may be the same shape as the current shape.
Select a width (w), height (h), rotation, and inversion for the history value as for the current value.
OW330_90
8.29 What is the XY Plot button?
Enter the maximum number of history shapes which may be plotted on the xy plot in the count entry field. Use the increment/decrement buttons to adjust the value if necessary. Valid range is 0 through 255.
11. Select one of the following buttons: Ok — Saves the selected settings, and quits the XY Plot window. Ap pl y — Saves the selected settings, but the XY Plot window remains open. Cancel — Quits the XY Plot window without saving any changes. 12. Move the pointer to the drawing canvas. Press and hold the left mouse button, and drag a rectangle representing the maximum dimensions of the XY Plot. Do not release the mouse button while drawing the XY Plot. 13. Release the mouse button, and the XY Plot displays.
OW330_90
203
S
9
ECTION
Unde rst anding Ma cro s
IN THIS SECTION What are Macros? ........................................................................................................... 205 What thepurpose macro diagram tagout (substitution) parameters?..................................... What are is the of the Macro Notes and Parameter Info dialog? ............................2 209 13 Specifying Default Values for Macro Point Parameters using a %s% substitution string216 What is the Macro Dialog? .............................................................................................. 219 What is an invalid parameters count error? .................................................................... 225 Local macro_triggers ....................................................................................................... 229 Local Macro Entry Fields................................................................................................. 230
9. 1
What are Ma cro s? Macros are graphic files built within the Graphics Builder which are used to integrate a set of graphics commands into another diagram. Logic, conditionals, pointer commands, as well as display items, can be used to create macros. (See Ovation Graphics Language Reference Manual.) Macros automate the tedious and repetitive tasks that would otherwise require you to repeatedly draw the same diagram or diagram section. After macros are created and integrated into a parent diagram, they function as a single entity. They can be moved, copied, grouped, resized, rotated, inverted and erased diagram. Thebe attributes of the items in the macro (color, line pattern, fill pattern, line width within and soa forth) cannot changed. The following sections discuss the use of macros:
Naming macros (see page 205)
Macro rules (see page 206)
Tagging macro parameters to be substituted in the macro file (see page 209)
Creating and editing macros (see page 220)
9.1.1 What are the general rul es for naming macro
s?
Macro diagrams must be named according to a predefined naming convention. It is your responsibility to follow this convention and to maintain the macro diagrams in the specified directory. If these rules are not followed, an error message displays when you try to use the macro in another diagram. Macro graphics reside in the system macro directory and are named in the following way: macr oN. di ag OR macr oN. sr c
OW330_90
205
9.1 What are Macros? where: N = the macro number (1 through 65,535) The macro name is not case sensitive. That is, macro1.src is the same as MACRO1.src. However, leading zeros are no t permitted in the number portion of the name. For example, macro0001.src is not a valid macro filename. It is your responsibility to create macro files in the proper directory. If the macro file does not reside in the proper directory, you cannot use the macro. If running the Graphics Builder offline, the system macro directory is defined as INSTALLATION_DIR/mmi/graphics/macros , where INSTALLATION_DIR is the path where the offline Graphics Builder was installed. If running the Graphics Builder online, the system macro directory is the Macros node under the system Graphics node in the Ovation Developer Studio hierarchy. (See Ovation Developer Studio User Guide.) When macros are created in the offline version of the Graphics Builder, they can only be added to the Ovation Developer Studio (online version of the Graphics Builder) by using the Import Graphics program (see page 325). When a macro graphic is saved/compiled, both a .src version and a .diag version is created (like any other graphic). The .diag version of the macro is read into the parent diagram when a macro is used — not the .src version. When you save a macro graphic in the Graphics Builder (either online or offline), or when you compile a macro file, an associated macro preview file is written. The macro preview file is an external bitmap file used to preview the macro on the Macro dialog. The file is created in the system macro directory where the macro graphic file resides. It is named the same as the macro graphic file but with a “.bmp” file extension. For example, the preview file for macro1.src is macro1.bmp . Note that the associated macro preview files are automatically generated during a batch compile from the Ovation Developer Studio. Similarly, when you define macro notes (see page 213) and comments for a macro graphic in the Graphics Builder, an external text file is created. The macro notes file is used to display notes/comments on the macro dialog. The file is created in the system macro directory where the macro graphic file resides. It is named the same as the macro graphic file but with a “.notes” file extension. For instance, the notes file for macro1.src is macro1.notes . When importing macros into the Ovation Developer Studio, the associated macro preview bitmap file and macro notes files are also imported.
9.1. 2 Macro Rules 1. When a macro is loaded into the parent diagram, the Graphics Builder checks that the correct number of parameters are passed to the macro for substitution. The exact number of expected parameters must be passed to the macro. It is not acceptable to pass too many or too few. For all parameter types, the number expected is determined by the largest index used in the macro file. For example, if $D1 and $D34 are the only $D tagout parameters specified in the macro file, then the number of expected process point parameters to be passed to the macro is 34. Therefore, when creating macro files, do no t skip indices. 2. The tagout parameters are NOT case sensitive. For example, “$T1” is the same as “$t1” and $SETn is the same as $setn. 3. The MACRO graphic command is valid in all sections of the parent graphic. However, depending on the contents of a particular macro, some macros are restricted as to where they can be added in the parent graphic. Consider the following:
206
OW330_90
9.1 What are Macros?
If a macro contains commands in more than one section (for example, commands in the background section and commands in the foreground section), the macro must be placed in the diagram section of the parent graphic.
If a macro contains only keyboard data, the macro can go in the diagram or the keyboard section of the parent graphic.
If a macro contains only background, or only foreground, or only trigger data, the macro can go in any section of the parent graphic, except keyboard, because the graphic commands valid in any one of these sections are also valid in the other sections.
4. Where a macro is placed in the parent graphic controls where the items comprising the macro are added. Consider the following:
If a macro exists in the diagram section of the parent graphic, all of the items in the background section of the macro are added to the beginning of the background section of the parent graphic, all of the items in the foreground section are added to the beginning of the foreground section, and so forth. Therefore, macro items display on the screen before items that are just part of the parent graphic (those not part of the macro).
If a macro exists in any other section (for example, background), the items comprising the macro are merged into that section according to where the MACRO command is placed in that section. Note that if macro5.src contains a process point value in the foreground, and you add macro5 to the background section of the parent graphic, the process point value merges into the background section, and it does not update even though it was in the foreground in the actual macro file.
Note: The place of items within the macro is always maintained if the macro is added to the diagram section of the parent graphic. 5. Macros can be inverted and rotated (valid range is -360 through 360). This is done by using the Invert/Rotate toolbar (see page 57). Note: If the macro contains 1 or more items which GB cannot rotate (such as text, bars, trends, and so forth), GB will not allow the macro to rotate. In these cases, GB will display an error. 6. When multiple MACRO commands exist in the diagram section of the parent graphic, the order of the MACRO commands defines the display order of the items comprising each macro on the parent graphic.
OW330_90
207
9.1 What are Macros?
9.1.3 Wha t is the process for inverting and rotating Ma
cros?
Macros can be rotated and/or inverted using the Invert/Rotate toolbar. However, if a macro contains a non-rotatable item (such as text, process points, bars, and so forth), it cannot be rotated. If you select a macro containing invalid items for rotation, an error displays. When a macro is rotated or inverted in the Graphics Builder, the source syntax automatically updates in the Integrated Source Editor. The new source syntax for the macro contains four additional parameters to support the enhanced rotation/inversion. These additional parameters are only present if/when a macro is rotated/inverted. These parameters function as a set, so either all four parameters are present or none of them are present. These four parameters represent the rotation (-360 through 360), inversion (NONE, RTL, TTB, or BOTH), a post-rotate width scale factor, and a post-rotate height scale factor. You should never add/modify these parameter via a source or text editor. They are automatically added/modified by the Graphics Builder during an invert, rotate, and resize operation. Notice in the following examples how rotation and inversion change the macro source syntax: Source syntax for Macro1640 when it is not rotated and not inverted: Macro 1640 4124 4629 1.000000 1.000000 0 0 0 0 0 0 0 0
Source syntax for Macro1640 when it is rotated by 45 degrees and inverted RTL: Macro 1640 4124 4629 1.000000 1.000000 RTL 45 1.000000 1.000000 0 0 0 0 0 0 0 0
To Invert and Rotate Macros 1. Create your macro (see page 219) and then select the macro. 2. Access the Invert/Rotate toolbar.
Figure 59: Invert/Rotate T ool bar 3. To invert the macro, use the first and second toolbar buttons. The buttons are invert horizontally and invert vertically. 4. To rotate the macro, first select the last button on the toolbar to display the Rotation Increment window (see page 242). From this window set the desired degree of rotation and press the OK button. The default is 90 degrees. 5. Select the macro. Use the third and fourth buttons to rotate the macro. The buttons are: rotate clockwise and rotate counterclockwise. The macro rotates the number of degrees that was specified on the Rotation Increment window.
208
OW330_90
9.2 What are the macro diagram tagout (substitution) parameters? What are the Ma cro ro tation restriction s?
9. 2
Do not put rotated shapes in macros which you intend to rotate. For example, consider macroNNN which contains a shape which is rotated by 45 degrees and is then sized to half its width and two times its height. When macroNNN is used in a graphic, macroNNN cannot be rotated because it contains a shape which is rotated by non-90 degrees and has been sized after it was rotated.
Macros that have been rotated and then resized after they were rotated cannot be rotated again. You should resize macros before you rotate them. This restriction applies to macros rotated by any number of degrees.
If a macro contains a non-rotatable item (such as text, process points, bars, and so forth), it cannot be rotated.
Wha t are the macro diagram
tagout
(substitu
tion) parame ters?
Macro diagrams can be created with tagout (that is, substitution) parameters so that you can pass data to the macro when it is loaded into the parent diagram. The following types of tagout parameters can be passed to macros:
$Dn pointers are used to tag substitutable process point names, where n = 1 through 99.
“$Tn” strings are used to tag substitutable text strings in the background section of a graphic, where n = 1 through 50.
“$Tn” strings are used to tag substitutable text strings in the foreground, trigger, and/or keyboard sections of a graphic, where n = 1 through 50.
$SETn variables are used to tag substitutable set numbers, where n = 1 through 256.
$CONSTn variables are used to tag substitutable integers/real numbers, where n = 1 through 256.
$STATUSn variables are used to tag substitutable status words, where n = 1 through 256.
$COLORn variables are used to tag substitutable colors, where n = 1 through 100.
$OL_COLORn variables are used to tag substitutable OL colors, where n = 1 through 100.
Replacing the tagout parameters with data (that is, point names, constants, colors, and so forth) can be done interactively through the Macro dialog or through the MACRO command via the integrated source editor. (See Ovation Graphics Language Reference Manual.)
9.2.1 What are the pro cess point parameter
($D n) sub sti tuti ons ?
You can specify a process point name to be passed into a macro with a $Dn tagout parameter. $Dn parameters are valid in any command in a graphic where a process point name is expected (for example, bar, process point, trend, and so forth). This includes operands to conditional expressions in graphics. Some examples of source commands with tagged-out point name parameters in a macro graphic are as follows: BAR 5000 6000 1000 4000 UP $D1 AV $D2 LL $D3 HL MATH $P1 $R0 ($D1 + $D2) PROCESS_PT 6920 1794 6 2 RIGHT0 ON HORZ VECTOR_OVER 321 734 1 $D1 AV 0 100
OW330_90
209
9.2 What are the macro diagram tagout (substitution) parameters? Once the $D tagout parameters are added to the macro graphic, you can pass the actual process points to the macro to replace the $D tagouts. Note that only point names — not point name/record field pairs — can be passed to a macro to replace $D tagouts. Record fields cannot be passed to a macro. Upon substitution, the Graphics Builder checks that each process point being substituted for a $D tagout is valid in the given context. If the $D tagout has an associated record field beside it in the macro file, the Graphics Builder checks that the point passed for that $D tagout is of the correct type for that record field. For example, if A100 is passed for $D1 DS, the Graphics Builder checks that A100 is a point type which has a DS record field.
9.2.2 What are the te xt strin g paramete r ($Tn) sub sti tuti ons ? You can specify a text string to be passed into a macro with a $Tn tagout parameter. The $Tn tagout parameters must be delimited by single or double quotes in the macro file. Always quote $Tn tagouts in dialogs unless told not to in the entry field label. “$Tn” tagout strings are valid in the following commands/dialogs: TEXT, MULTI_TEXT, RUN_PROGRAMS, POKE_FLD (type 7 and 23), OL_BUTTON, (poke type 7 and 23), and FUNC_KEY. Some examples of source commands with tagged-out text strings are as follows: TEXT 1000 1000 “$T1” ( A100>A200) “$T2” HORZ VECTOR_OVER 120 310 1 POKE_FLD 1000 1000 1000 1000 ON 7 1 2 0 4 “$T1” $CONST1 $D1 I D $SET1 The substitution strings passed to the macro (not including the quote characters) are limited to 80 characters. The exception to this limit is for strings substituted for MULTI_TEXT commands, which are limited to 30 characters. The macro text string substitution mechanism separates the “$T” tagouts in the background section of a macro from the “$T” tagouts in other sections (foreground, trigger, and keyboard) for purposes of backwards compatibility to earlier version of the Graphics Builder. For example, “$T1” in a TEXT command the background is distinct in from in a TEXT the in a foreground. However,in“$T1” in a TEXT command the“$T1” foreground is thecommand same as in “$T1” POKE_FLD command in the keyboard section and $T1” in a TEXT command in the trigger section. The default labels on the Macro dialog for “$Tn” tagouts in the macro file are: $T1(BG), $T2(BG) ... $Tn(BG) for background text and $T1(other), $T2(other) ... $Tn(other) for other sections.
9.2.3 What are the set num ber parameter
($S ET) sub sti tuti ons ?
You can specify a set number (or SETn variable) to be passed into a macro with a $SETn tagout parameter. $SETn tagout parameters are valid in the following source commands in macros:
The set number in the SETVAL command.
The set number in the poke type 23 POKE_FLD, the poke type 23 OL_BUTTON, and the poke type 23 BUTTON commands.
SETVAL $SET1 3
POKE_FLD 1000 2000 500 750 O N 23 $SET1 1 1 6 0 6 A100 D I A200 ID 1 9 2 OL_BUTTON 1000 2000 HORZ ROUNDED TEXT_LABEL VECTOR 120 310 1 “l abel ” EXEC_POKE 23 $SET1 1 1 6 0 6 A100 I D A200 I D 1 9 2
The SETn of a set conditional. COLOR FG BLACK ($SET1) 3 RED GREEN YELLOW
210
OW330_90
9.2 What are the macro diagram tagout (substitution) parameters?
The SETn operand in an expression conditional.
Integral set number arguments to application programs in a poke list. Poke BUTTON (poke type 7 + 23) lists exist in the POKE_FLD (type 7 and 23), OL_BUTTON (poke type 7 and 23), RUN_PROGRAMS, and FUNC_KEY commands.
COLOR FG BLACK ($SET1 = 2) RED
POKE_FLD 1000 2000 500 750 O N 23 1 1 1 6 0 6 A100 ID A200 ID 1 $SET1 2 OL_BUTTON 1000 2000 HO RZ ROUNDED TEXT_LABEL VECTOR 120 310 1 “l abel ” EXEC_ POKE 23 1 1 1 6 0 6 A100 I D A200 I D 1 $SET1 2 RUN_PROGRAMS 1 6 0 6 A100 ID A200 ID 1 $SET1 2 You can specify $SET tagouts in commands or from the applicable dialogs. However, there is no corresponding dialog for the SETVAL command. Use the $SET button on the Poke dialog or the corresponding button on the OL_Button dialog to specify a $SET tagout in a poke type 23. You can enter the $SET tagouts in conditionals on any of the dialogs that have conditional fields (Color, Process Point, Fill Pattern, Line Pattern, Shape Library, Blink, and Text). You can enter $SETn tagouts in the argument lists to application programs on the Poke, OL_Button, and Function Key dialogs. After the $SETn tagouts are added to the macro, you can pass integral set numbers (1 through 255) for the $SETn tagouts when the macro is used in a parent graphic. Depending on the context of the $SETn tagout, sometimes the integral set number is substituted, and other times the corresponding SETn variable is substituted.
9.2.4 What are the int eger/real con stant ($ CON STn) sub sti tut ion s? You can specify an integer/real number to be passed into a macro with a $CONSTn tagout parameter. $CONSTn variables are used to tag substitutable integers/real numbers, where n = 1 through 256. $CONSTn tagout parameters can be used to pass the following:
Integer/real operands in conditional expressions.
Integer/real operands in MATH expressions.
Integer/real arguments to a poke type 7 list in the RUN_PROGRAMS, POKE_FLD, OL_BUTTONS, and FUNC_KEY commands.
macro_trigger [n] numbers.
macro_entryfld[n] numbers.
No other integer/real numbers can be tagged out (that is, no x, y coordinates, widths, heights, and so forth). Some examples of source commands in a macro with tagged out integer/real data are shown below: COLOR FG RED (A199 AV > $CONST1) GREEN BG BLACK MATH $P1 $R0 (( A100 + $CONST1) / $CONST2) ) POKE_FLD 1000 2000 500 750 ON 23 1 1 1 6 0 6 A100 ID A200 I D 1 $CONST1 2 OL_BUTTON 1000 2000 HORZ ROUNDED TEXT_LABEL VECTOR 120 310 1 “l abel ” EXEC_POKE 23 1 1 1 6 0 1 A100 ID A200 I D 1 $CONST2 2 RUN_PROGRAMS 1 6 0 6 A100 ID A200 ID 1 $CONST1 2
OW330_90
211
9.2 What are the macro diagram tagout (substitution) parameters? In addition to the source commands, you can use the applicable dialogs to tag-out $CONST data in the macro file. However, there are no dialogs for the MATH and RUN_PROGRAMS commands, so $CONST tagouts for those commands must be entered via the source editor. In addition, you can interactively enter the $CONSTn tagouts in conditionals on any of the dialogs having conditional fields (Color, Process Point, Fill Pattern, Line Pattern, Shape Library, Blink and Text). Real numbers passed to the macro must have a digit before and after the decimal point. Note that either $CONSTn or $SETn tagout parameters may be used to pass an integer set number of an application program in a poke type 7 or 23 list (in the RUN_PROGRAMS, POKE_FLD, OL_BUTTON, or FUNC_KEY commands).
9.2.5 What are the status word parameter (
$ST ATUSn) sub stit uti on?
You can specify status word operands (Hdwfail, Good, Alarmack, and so forth) in conditional expressions to be passed into a macro with $STATUSn tagout parameters. An example of a tagged out status word in a source command in a macro is the following: COLOR FG BLACK (D100 DS = $STATUS1) GREEN BG WHI TE ( D100 DS = $STATUS2) YELLOW A list of valid status words is available. (See Ovation Graphics Language Reference Manual.)
9.2.6 What are the col or parameter ($ COLOR n) & O L colo r parameter ($OL_COLORn) substitution? You can specify a color or an OL color to be passed into a macro with a $COLORn or $OL_COLORn tagout parameter. An example of a color command in a macro file with tagged out colors and tagged out OL colors is as follows: COLOR FG $CO LOR1 BG $COLOR2 (D100 DS = SET) $COLOR3 ER $COLOR 4 OL $OL_COLOR1 The $COLORn and $OL_COLORn tagout parameters can be specified via the Color dialog (see page 114) or the COLOR command syntax. (See Ovation Graphics Language Reference Manual.) Unlike any of the other types of parameters that can be tagged out in a macro (for example, $Dn, $Tn, $SETn, and so forth), $COLORn tagouts must be assigned values in order to display the macro graphic in the Graphics Builder (otherwise, the Graphics Builder would not know what color to use to display the $COLORn items in the macro itself). The Graphics Builder defaults the display values for all $COLORn tagouts to black and defaults the display values for all $OL_COLORn tagouts to OL color 0. The $color values and $ol_color values buttons are used to set/change the default display colors.
212
OW330_90
9.3 What is the purpose of the Macro Notes and Parameter Info dialog?
9. 3
What is the pur pos e of the Macro Notes and Paramete r Info dialog? The Macro Notes & Parameter Info dialog is used to interactively create/edit the macro parameter descriptions/labels, the macro notes/comments, and the macro parameter default values. This dialog creates/edits the DEF_MACRO_PARAMS command. The macros notes, and macro parameter descriptions/labels, and parameter default values are used only on the Macro dialog. The use of notes, descriptions, and default values are optional. This dialog can be used by someone creating a macro to clarify the data that must be passed to the macro and to list any special usage instructions or comments. It can also be used to assign default values for 1 or more parameters on the MACRO dialog when attempting to add a macro to a parent graphic. The Macro Notes & Parameter Info dialog is only accessible when a macro graphic is loaded in the Graphics Builder. If a macro graphic is not currently open in the Graphics Builder, neither the toolbar button on the Draw toolbar nor the menu item on the Options menu is active. Note that if you are running the Graphics Builder offline and are creating a new graphic that has not yet been saved, it does not give you access to this dialog. To resolve this, simply save the new graphic and name it according to the macro naming convention (see page 205). As soon as you save the graphic, the toolbar button and the menu item for this dialog become active. Also note that this is not an issue when running the Graphics Builder online because you must specify the name of the macro in the Studio before the Builder is invoked. Note: In a multinetwork system, if the online version of the Graphics Builder is invoked from a read-only location, you cannot save macro notes in the graphic. The Graphics Builder displays “Read-Only GBNT” in the title bar so that you know you are viewing a graphic in a read-only system.
9.3.1 To U se the Macro Notes & Pa rameters Info Option 1. Select the Macro Not es/Params button on the Draw toolbar. The Macro Notes & Parameter Info dialog displays.
OW330_90
213
9.3 What is the purpose of the Macro Notes and Parameter Info dialog?
Note: The Macro Notes & Parameter Info dialog can also be accessed from the Options menu.
2. The top 2/3 of the dialog is the Parameter Info box. Inside the box is a row of parameter count labels and a row of associated counts immediately below the labels. These counts are read-only fields.
214
OW330_90
9.3 What is the purpose of the Macro Notes and Parameter Info dialog? The count labels and the associated counts are initialized and activated when the macro is initially loaded into the Graphics Builder, each time this dialog is displayed, each time the OK button is pressed, and when the Re-Scan fo r Parameters button is pressed. These counts are no t automatically updated as you add/delete items to/from the macro during an edit session. The counts tell you how many (and what kind of) data must be passed to the macro — thus for what data you can define descriptive and meaningful labels and/or assign default values. 3. Immediately below the counts is the parameter table . This table is generated by the Graphics Builder and reflects the number and types of parameters defined for the macro. This list directly correlates to the information shown in the counts. To enter parameter descriptions/labels, go to the parameter table. Click in the first description Label/column of the parameter to enter the label info. The parameter and text entry field are highlighted. Enter a description/label in the entry field. Up to 80 characters may be used. Single or double quotes may be used, but are not required. You are not required to specify descriptions/labels for any or all of the parameters in the table. To enter parameter default values into the parameter table, click in the Default Value column of the parameter to enter the value for. The parameter is highlighted and an entry field is displayed to enter the default value into. Default values are entered as text just like parameter description. The parameter list is initialized and activated when the macro is initially loaded into the Graphics Builder, each time this dialog is displayed, each time the OK button is pressed, and when the Re-Scan for Parameters button is pressed. 4. The Load History De scriptio ns button is only applicable when running the Graphics Builder offline. It is used to fill blank parameter description/label entry fields with the associated history label/description. This button does not update default values. For every possible macro parameter, the Graphics Builder maintains a history description/label during the current edit session. The applicable history values are updated every time a macro is loaded/opened in the Graphics Builder, and also when you enter/change a description/label from this dialog. The Load History Descriptions function gives you the capability to define descriptive labels for one macro, load a similar macro in the same instance of the Graphics Builder, and then copy the descriptions from the last macro without having to retype them. This button is only active if one or more descriptions in the description/label column of the parameter list is blank and a history value exists for it. History values are not stored between edit sessions of the Graphics Builder. This button is not applicable when running online because you cannot open a new graphic in the same Graphics Builder window. 5. Press the Re-Scan fo r Parameters button to rebuild the parameter table. Existing user-defined labels are restored when the table is rebuilt. Parameters may be added/deleted from the table if you have added/deleted/changed items in the macro during the current edit session since the last time the list was updated. 6. The Notes/Comments text field allows you to define/edit any notes, instructions, comments, and so forth that the end user of the macro may find helpful. This data is accessible from the Macro dialog (see page 220). When the OK button is pressed, the data in the Notes/Comments field is written to an external notes file named “macroN.notes” where N is the number of the currently loaded macro. This file is saved in the same directory as the macro graphic itself. 7. Once the desired information has been entered, select one of the buttons below: Ok — Saves the selected settings, and qui ts the Macro Notes & Parameter Info window.
OW330_90
215
9.4 Specifying Default Values for Macro Point Parameters using a %s% substitution string Cancel — Quits the Macro Notes & Parameter Info window without saving any changes. You are not required to specify descriptions/labels and/or default values for any or all of the parameters in the table. However, if you press the OK button and there are undefined descriptions, the Graphics Builder may display a warning message. Select one of the following buttons:
9. 4
Press Yes to return to the Macro Notes & Parameter Info window and define the parameters you missed.
Press No to keep the la bels blank and quit the Macro Notes & Parameter Info window.
Specify ing D efault Va lues for M acro Point Pa rameters %s% substitution str
usi ng a
ing
You can use ‘%S%’ (or ‘%s%’) as a substitution string within $Dn default values on the GBNT:Macro Notes & Parameter Info window in order to support partial point name substitution of points passed to macros:
216
OW330_90
9.4 Specifying Default Values for Macro Point Parameters using a %s% substitution string Configuring the default $Dn values using ‘%s%’ on the GBNT:Macro Notes & Parameter Info window ( or via the DEF_MACRO_PARAMS source command) is used in conjunction with the ‘Global substitution parameter(%s%):’ entry field on the GBNT:Macro window (see below) to specify the actual points passed to a macro instance using a substitution string. The string entered in the ‘Global substitution parameter(%s%):’ entry field is substituted for all occurrances of ‘%s%’ within the process point parameters shown on the GBNT:Macro window when the macro instance is added to the graphic.
OW330_90
217
9.4 Specifying Default Values for Macro Point Parameters using a %s% substitution string The ‘Global substitution parameter(%s%):’ entry field on the GBNT:Macro dialog is only enabled if/when one or more process point default values is defined on the GBNT:MacroNotes&ParameterInfo window containing ‘%s%’. It is not possible to do partial point name substitution in macros without first defining such default values for the point names. Entering ‘%s%’ within the actual point names on the GBNT:Macro dialog does not enable the ‘Global substitution parameter(%s%):’ entry field if there are no corresponding default values defined for the macro using ‘%s%’! The button on the GBNT:Macro dialog right of the ‘Global substitution parameter(%s%):’ entry field is used to store the displayed entry field value in the Windows Registry. Every time the Graphics Builder starts up, this value will be written to ‘Global substitution parameter(%s%):’ entry field on the GBNT:Macro window. The Graphics Builder performs the string substitution for the ‘%s%’ formats when you press the OK/Apply button on the GBNT:Macro dialog to draw/add a macro instance to a graphic. The MACRO command source generated by the GBNT:Macro dialog shows the expanded/substituted point names (see below). The MACRO command source syntax does NOT support ‘%s%’ formats within point name parameters – if you enter ‘%s%’ within a point parameter in the MACRO command syntax it is interpretted literally. There is no support for doing partial point name replacement within macro point parameters via batch compile operations.
9.4.1 Rules for Using ‘%s% ’ substitu tion stri ngs in $D n defa ult values 1. ‘%s%’ formats are only valid within process point default values ($Dn), not in text string ($Tn), $CONST, $SET, and so forth default values. 2. You can only specify a single substitution string per macro when doing partial point name replacement of macro point parameters. That single substitution string is used to replace all occurances of ‘%s%’ within the macro point names. There is no support for additional substitution formats; that is, ‘%s1%’, ‘%s2%’, and so forth on the GBNT:MacroNotes&ParameterInfo window and/or the GBNT:Macro window. 3. The ‘%s%’ substitution string is case-insensitive on both the GBNT:Macro window and GBNT:MacroNotes&ParameterInfo window, so ‘%s%’ and ‘%S%’ are identical. 4. There is no support for doing partial point name replacement within point parameters passed to macro via batch compile operations. The only way to do this is by interactively adding/editing a macro instance using the GBNT:Macro dialog.
218
OW330_90
9.5 What is the Macro Dialog?
9.4.2 Properties shown on the GBN ‘%s% ’ default values
T:M acro window fo
r a M acro De fined Using
When you add/draw a macro instance onto a graphic which has default point values configured with ‘%s%’ formats using the GBNT:Macro window, the Graphics Builder internally substitutes the user-defined ‘Global substitution parameter(%s%):’ value for all occurances of the ‘%s%’ formats BEFORE creating the MACRO command. Thus, the MACRO command source contains the expanded/substituted point name and does not include any ‘%s%’ formats. The Graphics Builder attempts to parse out the applicable ‘Global substitution parameter(%s%):’ value to display in the entry field from the actual expanded point names shown in the MACRO command syntax and the point name default values defined in the macros DEF_MACRO_PARAMS command. If point name default values containing ‘%s%’ formats defined for the given macro in the DEF_MACRO_PARAMS command, the Graphics Builderare will attempt to ‘reverse engineer’ the expanded point names into their srcinal ‘%s%’ formats on the GBNT:Macro dialog when showing the point name parameters. If the Graphics Builder can successfully ‘reverse engineer’ every point parameter which has a default value containing ‘%s%’, the Graphics Builder will replicate what was displayed on the GBNT:Macro dialog when the macro was added/drawn to the graphic. If, however, the Graphics Builder cannot ‘reverse engineer’ a single substitution string that applies to each point parameters whose default value contains ‘%s%’, the Graphics Builder shows the expanded point names (as shown on the MACRO source syntax) on the GBNT:Macro dialog and a warning message appears stating that it could not ‘reverse engineer’ the expanded macro point names. The above scenario can occur if someone edits the MACRO command syntax in a text editor and changes the point names being passed to the macro, or if someone edits the DEF_MACRO_PARAMS command syntax and changes the default values for point parameters. In either case, it may be possible that there is no single substitution string that can be replaced for each ‘%s%’ format in the default values that would yield the expanded point names in the MACRO source syntax.
9. 5
What is the Ma cr o Dialog? The Macro dialog is used to interactively add a macro to a graphic or change existing macros. It displays a list of all the available macros in your system. From this dialog, you can preview the macro, see how many parameters it has, view user notes/comments for it, draw it, and/or edit it. The following table gives an overview of the Macro dialog. Macro Dialog Fields and Descriptions D IALOG F IELD
D ESCRIPTION
Refresh List Button
Used to refresh the scrolling list of available macros. By default, this list is created once — when the Graphics Builder is invoked. The list is never updated after that except when this button is pressed. If you add/delete macros, or if you make any changes to the macro labels, then press this button to see the changes reflected in the list.
Scrolling List
Displays the list of available macros.
OW330_90
219
9.5 What is the Macro Dialog?
D IALOG F IELD
D ESCRIPTION
Preview Button and Box
Allows you to see a “preview” of the macro that was selected in the scrolling list (if an associated preview bitmap file exists for the selected macro). This is a scaled version of the macro if the macro is larger than the preview box. You can preview the macro in its actual size using the Windows PAINT program by clicking on the scaled preview box and/or by pressing the preview button again. If a preview bitmap file does not exist for the selected macro, the preview box is blank and the preview button is inactive. Note that you cannot edit a macro from the PAINT preview window.
Edit Button
Pressing the edit button invokes a new instance of the Graphics Builder with the given macro graphic loaded and ready for editing. Once the changes are saved, you can see the scrolling list.changes reflected on the Macro dialog, by reselecting the macro from the
Notes Button
Allows you to see the associated notes/comments for the macro selected from the scrolling list (if an associated notes file exists). The notes button displays the macro notes/comments in a pop-up dialog. These notes/comments are read-only from this pop-up dialog. Use the Macro Notes & Parameter Info dialog (see page 213) to create/edit macro notes and comments. If a macro notes/comments file does not exist, the notes button is inactive.
Load History Values Button
Used to fill the parameter values with the last displayed values in the current edit session. If there is at least one applicable history value for the selected macro, this button is active. Note that the Graphics Builder only stores history values throughout the edit session. Each instance of the Graphics Builder maintains its own history list, and when that instance of the Graphics Builder is closed, its history list is lost.
Parameter Counts
This is a row of 8 parameter count labels and a row of associated counts. Every time a new macro is selected from the scrolling list, the count labels and counts are activated accordingly. This immediately tells you how many (and what kind) of data must be passed to the macro. They are read-only fields.
Parameter
Displays the labels and values for the tag-out parameters. If default values are
List/Table
defined for any parameters, they will be displayed in the table.
Scale Factors (w), (h)
Used to scale a selected macro. Macros can be scaled as long as they do not contain bitmap text. If the selected macro contains as least one item created with bitmap text, the macro cannot be scaled and the scale factor fields gray out. To draw a macro in its as built size, set the scale factors to 1 (for larger macros, enter a value greater than 1; for smaller macros, enter a value less than 1). Valid scale factors are positive integer/real numbers. Note that the Graphics Builder checks that no individual item making up the macro is scaled too large or too small when the overall macro is scaled by the specified factors.
Global Substitution Parameter (%S%)
Entry field provided for entry to the substitution replacement string for any default values containing %S%. This entry field is grayed out if no default values are defined which contain %S%.
OK Button
Saves the selected settings, and quits the Macro window.
Apply Button
Saves the selected settings, but the Macro window remains open.
Cancel Button
Quits the Macro window without saving..
Help Button
Displays help on the Macro dialog window
9.5. 1 To Create a Macro Graphi c 1. Open the main Graphics Builder window.
220
OW330_90
9.5 What is the Macro Dialog? 2. Create a macro in the same way you would create any other type of diagram. Use display items, logic, conditionals, tagout parameters (where applicable in the draw item dialogs), and so forth. 3. Save the file. Make sure you save it to the macro directory and name it according to the macro naming convention (see page 205). 4. Once the file is saved, you can access the Macro Notes & Parameter Info dialog (from the Draw toolbar). All of the tagout parameters that were specified in the macro (that was just saved) display in this dialog (for example, it lists the number of $Dn parameters, $Tn (bg) parameters, $SETn parameter, and so forth). Make any desired changes to the tagout labels. If you do not make any customized labels, the defaults are used (the defaults are the actual parameters names such as $D, $T, and so forth). Select the OK button to save the changes. Assign any default values for any of the parameters. 5. Select the Macro button on the Draw toolbar to access the Macro dialog. Notice that the macro that was saved now appears in the scrolling list. The labels that were customized also appear on the window as do any defined default values. See the following figure.
Figure 60: Macro Window 6. To add parameters to the Macro window, see To Add Parameter Values to the Macro dialog (see page 222).
9.5.2 To access a Macro G raphi c 1. Access the Macro Notes & Parameter Info dialog (from the Draw toolbar). All of the tagout parameters that the were specified in the macro (that$Tn was(bg) justparameters, saved) display in this dialog (forand example, it lists number of $Dn parameters, $SETn parameter, so forth).
OW330_90
221
9.5 What is the Macro Dialog? Make any desired changes to the tagout labels. If you do not make any customized labels, the defaults are used (the defaults are the actual parameters names such as $D, $T, and so forth). Select the OK button to save the changes. Assign any default values for any of the parameters. 2. Select the Macro button on the Draw toolbar to access the Macro dialog. Notice that the macro that was saved now appears in the scrolling list. The labels that were customized also appear on the window as do any defined default values. See the following figure.
Figure 61: Macro Window To add parameters to the Macro window, see To Add Parameter Values to the Macro dialog (see page 222).
9.5.3 To Add Parameter
Values to the M acro Dialog
1. Select a macro from the scrolling list. 2. Go to the parameter list and select a tagout parameter. The text entry field highlights. Type in the value for that parameter. Note: The dividing line between the columns in the parameter list is moveable. To move the dividing line, position the mouse pointer over the dividing line until the pointer turns into a double-headed arrow, and then drag the dividing line to the desired position. 3. For certain parameter types, values must be obtained via pop-up dialogs. To obtain these dialogs, click on the desired entry field the button has three dots on it). A button displays on the right side of the entry field. Select the button and the dialog displays. See $SET (see page 223), $STATUS (see page 223), $COLOR (see page 224), and $OL_COLOR (see page 224) for procedures. 4. Once all of the parameter values have been defined, select the OK or Appl y button.
222
OW330_90
9.5 What is the Macro Dialog? The Graphics Builder checks the macro parameters and scale factors specified. If one or more errors is detected in the parameter list, the right column of the parameter list is highlighted in red and a pop-up error dialog displays. If no errors are found, the Graphics Builder enters draw mode, prompting you to drag the macro outlining rectangle to position it on the graphic. To Use the Select $SE Tn Value dialog 1. From the Macro window, go to the entry field of the parameter you wish to change. Click on the entry field and a button displays. See To Add Parameter Values to the Macro Dialog (see page 222). 2. Once you select the button, a dialog displays. For these procedures, the Select $SETn value dialog is discussed.
Figure 62: Select $SET n Value Windo w 3. Select set# or $SETn from the value type drop-down menu. Then select a value from the scrolling list. 4. Select the OK button. To Use the Select $STATU Sn Value dialo g 1. From the Macro window, go to the entry field of the parameter you wish to change. Click on the entry field and a button displays. See To Add Parameter Values to the Macro Dialog (see page 222). 2. Once you select the button, a dialog displays. For these procedures, the Select $STATUSn value dialog displays. 3. Pull down the value type drop-down menu and select either status# or $STATUSn. 4. Depending on the selection made in Step 2, the scrolling list changes.
If status# is selected, select a status number from the scrolling list.
If $STATUSn is selected, select a status word from the list. (See Ovation Graphics Language Reference Manual.)
5. Select the OK button.
OW330_90
223
9.5 What is the Macro Dialog? To Use the Select $COLOR n Value Dialog 1. Once you select the button, the Select $COLORn value dialog displays.
Figure 63: Select $COLO Rn Value Window In the Select $COLORn value window, notice that the current color setting is selected in the scrolling list. 2. Select a color from the scrolling list, and press the OK button. To Use the Select $OL_COLO Rn Value dialo g 1. Once you select the button, the Select $OL_COLORn value window displays.
Figure 64: Select $OL_COLO Rn Value Windo w In the Select $OL_COLORn value window, notice that the current OL color choice is selected on the dialog. 2. Select a color from the scrolling list, and press the OK button.
9.5. 4 To Edit a Macro F il e 1. Select a macro from the scrolling list on the Macro dialog. 2. Select the edit button. A new instance of GBNT displays with the given macro graphic loaded and ready for editing. 3. Edit the macro as desired in the new instance of GBNT. Then save the macro under the same name in the new instance of GBNT.
9.5.5 To C hange an I nst ance of a Macro on a P arent Graphic 1. Select the macro on the parent diagram that you want to change.
224
OW330_90
9.6 What is an invalid parameters count error? 2. Pull down the Edit menu, and select Properties . The GBNT:Macro dialog appears, showing the current settings for the macro selected. 3. Make changes to the macro on the GBNT:Macro dialog as desired. 4. Once all of the changes have been made, select the OK or Ap pl y button on the GBNT:Macro dialog.
9.5.6 To Displ ay Macro Notes The Macro Notes window allows you to view any notes that were entered on the Macro Notes & Parameter Descriptions dialog (see page 213). This window is accessed by pressing the notes button at the bottom of the Macro dialog. The Notes/Comments text field on the Macro Notes & Parameter Info dialog allows you to define/edit any notes, instructions, comments, and so forth, that the end user of the macro may find helpful. Note: The notes/comments that are entered do not go through any error checking. It is simply a way for a user to enter information that pertains to the macro.
9. 6
Wha t is an invalid
parame ters count e rror ?
Upon opening a graphic containing macros, the Graphics Builder checks that the parameters passed to a macro match the parameters defined in the macro. If there are too many or too few parameters passed to a macro, a Warning dialog (online Graphics Builder) appears stating that macro(s) with invalid parameter counts exist.
Figure 65: Invalid Parameters Warning
OW330_90
225
9.6 What is an invalid parameters count error? The "GBNT:macros w/invalid param counts" dialog appears at the same time and is situated behind the "GBNT" Warning dialog. Select OK on the "GBNT" dialog to access the "GBNT:macros w/invalid param counts" dialog. The "Macros w/invalid param counts" dialog contains a list of each instance of a macro that has one or more invalid parameter counts and an overall count of all such instances in the current graphic. The source for each invalid macro is displayed in the list (if the source extends across multiple lines, only the first line is displayed followed by '...'). Note: If you need to display the "GBNT: Macros w/invalid parameter counts" dialog at any time, a corresponding menu item can be found at the bottom of the "Options" menu. This menu item is only active when one or more macros w/invalid parameter counts exist.
Figure 66 : Invalid Parame ter Counts d ialog box Note: The following topics only deal with invalid number of macro parameters in the macro syntax. The software still will not load graphics with macros having any other type of error (such as the macro .diag file does not exist, the .diag file is not compatible with this release, and so forth.)
9.6.1 To re pair a macro with an invalid parame
ters count
1. Select the desired entry [that is: macro] from the list in the "GBNT: Macros w/invalid parameter counts" dialog (see page 225). The"GBNT: Macro" dialog box appears. The program automatically pages to the applicable source line in the integrated source editor. Handles are displayed on the macro to show which macro is in error. The dialog box shows each invalid parameter count in red directly below the corresponding required/expected parameter count.
226
The expected parameter counts are labeled "required".
The invalid parameter counts are labeled "current mismatches" in red.
The parameter entry fields for any missing parameters that must be specified are blank (and red to highlight they are absent).
OW330_90
9.6 What is an invalid parameters count error?
The parameter description/label for any parameters that have been removed from the macro and are no longer required are "** deleted **" (also in red).
Figure 67 : Macro dialog b ox 2. If required, add the missing parameters in the entry fields provided and press Ok/Apply , (No actionthe is required to removeparameter or delete parameters.) After is corrected, is removed from "Macros w/invalid counts" dialog, andthe anymacro deleted parametersit are removed from the dialog box. Note: You can correct macro parameter mismatches from the "Macro" dialog or from the "Integrated Source Editor" dialog.
9.6.2 Wha t is Sa ving a graphic containing macros wit count?
h an invalid para
meter
If you attempt to save a parent graphic without correcting all macros with invalid parameter counts, only the .src file is saved and a pop-up informs you that the .diag file will not be saved. You can continue editing the graphic without correcting the macros and changes are saved, with a few exceptions (see "Editing a graphic containing macros with invalid parameter counts" (see page 228).) If all invalid macros have been corrected, both the .src and .diag versions are written.
OW330_90
227
9.6 What is an invalid parameters count error?
9.6.3 Editing a graphic containing macros with invalid parame
ter counts
After the Graphics Builder loads a graphic with macros with invalid parameter counts, the Graphics Builder will not permit certain edits to the erroneous macro commands UNTIL the macros are corrected. Edits are always permitted to all valid commands. If you attempt any of the edits listed below, you will get an error complaining about the macro parameter count mismatches, and the edits aborted/canceled. The specific edits NOT supported when macro parameter mismatches are present are:
228
Global replace within the invalid macro commands from GBNT:Integrated Source Editor [also applies to global replace to such commands during import_graphics from the studio]. Global replace within any MACRO command having invalid parameter counts will fail with an error. The error will state that some parameter count is invalid.
Interactively changing the place of macros with invalid parameter counts [for example: moving a macro from the background to the foreground via the 'Change place' toolbar button.]
Interactive copy/paste of any macro with invalid parameter counts will fail. You will not be able to paste the macro back into any graphic if it has invalid parameter counts.
Move/Copy source cmds/blocks from the GBNT:Integrated Source Editor if any invalid MACRO commands and/or blocks containing any invalid MACRO commands are specified.
Un-commenting invalid MACRO commands from the GBNT:Integrated Source Editor.
OW330_90
9.7 Local macro_triggers
9. 7
Local macro_triggers Trigger sections can be defined that are local to a macro. A macro can define up to 255 local triggers. The default trigger sections in a graphic are denoted by ‘TRIGGER n’ statements; local trigger sections in a macro are denoted by ‘MACRO_TRIGGER n’ statements. Select 'macro_trigger n' from the place combobox to interactively add items to the local trigger section when editing the macro. You are not allowed to add items to these sections unless editing a macro graphic. The GB dialogs that allow you to specify a trigger number (for example: OlSlider, OlCheckbox, OlChoice, OlButton, Button, Poke_fld, and so forth) will also allow you to specify local macro_trigger numbers. A combobox is added to these dialogs to allow you to specify whether the trigger a standard trigger, macro_trigger, through or will betopassed the macro a $CONST param.will It isbe possible to pass localamacro_triggers nested to macros. Newvia reserved words (macro_trigger_1… macro_trigger_255) exist in the graphics language to reference a local trigger number in the source syntax of the following commands: Trig_on, Olcheckbox, Olchoice, Olslider, Olbutton, Button, Poke_fld, Run_programs and Func_key. These new reserved words differentiate between default trigger numbers and local macro_trigger numbers. Local macro_trigger numbers are supported anywhere in a macro where a default trigger number can be used.
This enhancement allows the creation of a macro (which can be used multiple times on a single graphic) containing an item such as an OlSlider, without having to manage IF/ENDIF/$SETn logic in the associated trigger. The user will now be able to associate a local macro_trigger in the macro with the OlSlider, and each instance of that macro will get its own local trigger. Local triggers can be passed through to nested macros by specifying the local trigger number as a $CONSTn in the nested macros, and then passing a macro_trigger_n parameter for the given $CONSTn parameter in the top-level macro.
OW330_90
229
9.8 Local Macro Entry Fields
9. 8
Loc al Macro Entry Fields You can define entry fields that are local to a macro. A macro can define up to 254 local entry fields. This is in addition to the default entry field support. The default entry fields in a graphic are denoted by an entry field number [N]. Reserved words (macro_entryfld_1 … macro_entryfld_254) are implemented in the graphics language to reference a local entry field number in the source syntax of the following commands: Entry_fld, Ef_state, Ol button, Button, Poke_fld, Run_programs and Func_key. These reserved words will differentiate between default entry field numbers and local macro entry field numbers. Local entry field numbers are supported anywhere in a macro where a default entry field number can be used. You will not be allowed to use macro_entryfld_N arguments unless editing a macro graphic. The GB entry field dialog that allows specifying an entry field also allows specifying a local macro entry field number. A combobox is added to this dialog to allow specifying whether the entry field will be a standard entry field, a macro entry field, or will be passed to the macro via a $CONST param. It is possible to pass local entry field triggers through to nested macros. Local entry fields can be passed through to nested macros by specifying the entry field number in the nested macro as a $CONSTn, and then passing a macro_entryfld_n parameter to the top-level macro for the $CONSTn parameter.
230
OW330_90
S
10
ECTION
Editing Graphics
IN THIS SECTION What are the ways to working with selected items and groups? ....................................231 What are the Editing Attributes?...................................................................................... 245 Editing Vertices?.............................................................................................................. 246 To Use the Snap to Grid Option ...................................................................................... 255 To Undo and Redo the Last Edit ..................................................................................... 255 What are the Aligning and Equi-Spacing functions?.......................................................256 What is Object-to-object Snap?....................................................................................... 275
10 .1 Wha t are the ways to working wi
th selecte
d items and groups?
After an item is drawn on the main Graphics Builder drawing canvas, it is often necessary to make changes. Before you can edit items, you must have an understanding of the method of selecting which item(s) in which to make the changes. Also, it is sometimes necessary to treat a set of items as a single entity. The grouping mechanism allows you to do this. Once a group is defined, it is selected/deselected in the same manner as a single item. Note: Some procedures call for pressing down on the Control key on the keyboard at the same time you left-click the mouse. Throughout this section, this is referred to as Ctrl + left-click .
10.1 .1 To Select an d Deselec t Items To select and deselect items/groups, follow the steps below:
To select an item for editing, left click on one of the lines comprising the object. Likewise, to select a group for editing, left click on one of the lines comprising one of the objects making up the group. When you select an item/group with the left click, any currently selected item/groups are deselected.
To select an additional item/group (while the first item/group remains selected), Ctrl + left-click on the additional item/group.
To deselect a single item/group, Ctrl + left-click on the selected item/group. Only that item/group is deselected.
To deselect all selected items/groups, left-click on the white space (white space is defined as any area on the diagram where there are no display items). All the items/groups become deselected, and the handles around them erase.
To toggle an item’s selection status, Ctrl + left-click on the item.
Once selected, handles (filled squares) display around the item/group.
OW330_90
If the item is currently selected, the item is deselected.
If the item is not currently selected, the item is selected.
231
10.1 What are the ways to working with selected items and groups?
To select all items on the screen, pull down the Edit menu, and select Select All .
To select all items within a specified area by dragging a rectangle, follow the procedures below:
Place the pointer in the white space above and to the left of the items to be selected.
Press and hold the left mouse button, and drag a rectangle around the items (do not release the mouse button while drawing the rectangle).
Release the mouse button and all the items completely within the rectangle are selected.
10. 1.2 To Select Overlaid Items To select overlaid items, follow the steps below:
To select an item underneath another item on the graphic, first click in the item with the left mouse button. the Graphics Builder will select the first item it finds that is within the tolerance (approximately five pixels) for selection.
If the item selected (marked by the selection handles) is not the item you want to select, press the Enter key on the keyboard to go to the next item under the mouse pointer.
If that is still not the desired item, press the Enter key again, and so forth. The Enter key will move you through a circular list of all possible items within the tolerance under the mouse pointer.
Note that the Enter key only selects the next item in the list of all possible items under the mouse pointer — it does not also move that item to the front. For example, if you have two overlaid filled rectangles or poke fields that are exactly the same size and the handles for both items are in the exact same places, it will appear that nothing is happening when you press the Enter key. To check if the selection is changing, access the integrated source editor window and see if the cursor in the source editor window moves to a different line when you press the Enter key. If nothing is happening after you press the Enter key, make sure that you are not pressing any other key or mouse button in combination with the Enter key. Also, make sure that you did the initial select of the item with the left mouse button prior to pressing the Enter key. is the keyboard accelerator for the option to hide the selected item(s). Use this keyboard accelerator to aid in the selection of overlaid items. If there are overlaid items on a graphic, and you attempt to select an item under one or more other items and the un-intended item is selected, use to hide the un-intended item and automatically select another item under the mouse pointer. If another item exists under the mouse when the is pressed, that item is automatically selected for you when the currently selected item is hidden. Continue pressing until the item you want is selected and in view. This functionality is similar to using the accelerator key to select an overlaid item, except that this function will also hide the currently selected item before selecting a new item.
232
OW330_90
10.1 What are the ways to working with selected items and groups?
10. 1.3 Abi lit y to Tempor arily Hide Items To aid in selecting/editing overlaid items on a graphic, you can temporarily hide display items during the edit session which obscure the item(s) you want to view/edit. Items are only hidden during the current edit session; all display items are automatically shown the next time the graphic is opened. The source for items is always visible in both the integrated and generic text editors (even if the display of the item on the graphic is hidden). You can:
Hide all selected items
Hide all non-selected items
Hide all items in the current place (BG,FG,TRIGGER, MACRO_TRIGGER, or KEYBOARD) Hide all items not in the current place (BG,FG,TRIGGER,MACRO_TRIGGER, or KEYBOARD)
Show all previously hidden items
Access the above functions from the ‘View’ menu or the ‘show/hide toolbar’:
The firsst toolbar button corresponds to the first menu item shown on the ‘View’ menu, the second toolbar button corresponds to the 2nd menu item shown above, and so forth. Note: Ctrl+H’ is the keyboard accelerator for hiding all seclected items; ‘Ctrl+Alt+H’ is the keyboard accelerator for showing all hidden items. To Hide non-se lected items to edit grouped it ems The Graphics Builder does NOT allow you to edit grouped items – you must ungroup first to edit the individual items making up a group. Be careful when editing the individual items and/or re-grouping afterwards if there are overlaid items on the graphic, or if there are lots of display items on the graphic around the group to be edited. Use the 'Hide non-selected item' function to easily edit the grouped items as follows: 1. Select the group to edit 2. Select the 'Hide non-selected items' menu item (or the corresponding toolbar button) to hide everything else on the graphic 3. Ungroup the group 4. Make desired changes to the individual items
OW330_90
233
10.1 What are the ways to working with selected items and groups? 5. Drag a rectangle on the graphic to select all the items (only the items that make up the group are visible) 6. Group the items 7. Press 'Ctrl+Alt+H' to show all items now that you are done editing the group (or select the corresponding menu item or toolbar button) Rules pertaining to the hide/show functionality:
When an item is hidden, it cannot be selected interactively (even by dragging a rectangle)
If the source for a hidden item is selected in the integrated source editor, that item (and only that item) is automatically shown on the graphic
If an item is grouped, the entire group is hidden or shown. It is not possible to hide part of a group.
The current place is set on the place dropdown menu on the 'Drawing Attrs' toolbar for the 'Hide current place' and 'Hide NOT in current place' functions:
If a macro command exists in the DIAGRAM section, and it contains display items in multiple sections (for example: BG, FG, and KEYBOARD data), and you execute the ‘Hide current place’ function when the current place is set to background, the entire macro is hidden. Macros, like groups, cannot be partially hidden. The entire macro is hidden.
The ‘Show hidden items’ functions shows all currently hidden items. It is not possible to only show a subset of the hidden items. Even if you hide items in multiple steps, when you select the ‘Show hidden items’ function, all of the hidden items will be shown.
To work on items made accessible by hiding ot
her items
1. Temporarily hide (see page 233) the desired items 2. If necessary, ungroup (see page 235) the items to be worked on. 3. Make any changes deemed necessary to the individual items. 4. Drag a rectangle to re-select all the items on the graphic (or select the ‘Select All’ menu item in the Edit menu). 5. Re-group (see page 235) any items as necessary. 6. Select the ‘Show’ toolbar button (or the ‘Show hidden items’ menu item) to redisplay all hidden items. Since all other items are hidden before you ungroup, re-grouping is easy after you make the changes. To Show temporarily hid den items 1. Select the show button to show all temporarily hidden items.
234
OW330_90
10.1 What are the ways to working with selected items and groups?
10. 1.4 To Group and Ungr oup Items To group items, follow the steps below: 1. To group two or more items, select the items. “Grouping” several items permits the items to be edited (moved, copied, resized, and so forth) together. Groups can be grouped to make bigger groups. 2. Pull down the Edit menu on the main Graphics Builder window, and select Group . The handles around the individual items erase, and one set of handles display for the group. Note: The grouping status is only maintained during the current edit session. If items are grouped and you save the graphic, the next time the file is loaded, the items will NOT be grouped. To ungroup items, follow the steps below: 1. Select the group selecting any item making up the group. 2. Pull down the Edit menu on the main Graphics Builder window, and select Ungroup . The handles for the group erase, and the handles for each individual item display. Note that this menu item does not dissassociate macros. Note: The Unshape menu is similar to ungroup. Unshape separates a shape displayed on the graphic into the individual items making up the shape.
OW330_90
235
10.1 What are the ways to working with selected items and groups?
10.1.5 Retain gr oupin g o utside GB edit session GB can maintain the grouping status of items outside of the current edit session. The menu item on the 'Options' menu "Retain Grouping On File Save" can be used to toggle this option. The default setting will be to save/retain grouping. The standard GB 'Save-defaults' function can be used to save your preference for this setting in the Windows registry.
236
OW330_90
10.1 What are the ways to working with selected items and groups? The grouping status will be saved/stored in the graphic .src file on FileSave operations if theis option is set. If there are 1 or more groups defined in GB (whether they are currently selected or not), those groups will still exist the next time that graphic is loaded - providing the stored grouping in the graphic source file was not corrupted by editing the file outside of the GB in the interim. The GROUP commands will be added by GB prior to saving the source file. The grouping will not be saved in the graphic .diag file. GB implements this feature by inserting group commands into the source file as part of the file save operation. When GB opens a .src file with GROUP commands, it replicates the grouping, and strip the GROUP commands out of the integrated source editor. You are not allowed to add GROUP commands via the integrated source editor. GB does not strip them out of the actual .src file. Thus, you will never see a GROUP command in the integrated source editor, but you will see those commands in the generic text editor (or in any other editor ; that is, WORD). Batch compile operations do not remove GROUP commands from the source file. Thus, compiling graphics in the studio after grouping has been saved in the source file does not remove/delete the grouping. Do not edit/add/remove/move these GROUP commands in the source file. The position of the GROUP commands in the source file relative to the display items being grouped is very important and cannot be changed. For instance, you cannot add any commands between the GROUP command and the subsequent display item (including comments and/or blank lines) without corrupting the stored grouping. Note: If you somehow corrupt the grouping, you will get a message when you attempt to load the source file, stating that the grouping has been corrupted outside of GB and that it cannot be restored. You must then re-group and re-save the file in GB to restore the grouping. If you manually edit 1 or more GROUP commands in the source file, the grouping will be corrupted and grouping will not be able to be restored. If the GROUP command syntax is corrupted, that is treated as a compile error and the file will not load. Graphic .src files with GROUP commands will not be backwards compatible with prior releases of GB or with any Solaris releases of GB. When running GB offline, users will lose the grouping status if they load .diag files. The grouping status will not be saved on auto-save operations.
10. 1.6 To Move an Item or Group 1. Select an item or group to be moved. 2. Press and hold the left mouse button on the item/group to move, and drag the item to the new location. Do not release the mouse button while dragging. Notice that the mouse pointer changes as soon as you initiate the move. Depending on the current setting for the drag/draw constraint (see page 89), the cursor changes to an arrowhead cursor which indicates the direction you can move the item/group. 3. Release the mouse button.
OW330_90
237
10.1 What are the ways to working with selected items and groups? What is the Jog mode? Jog mode allows you to move a selected item/group by one pixel at a time in any direction. This function is used when precise positioning of an item is desired. Jog mode can be used in conjunction with the move or resize operations. It can also be used in vertex edit mode (see page 246) to move a vertex of a line, polygon, rectangle, bar, trend, xy plot, poke field, or plot. While in jog mode, the arrow keys on the right keypad on the keyboard are used to manipulate the display item. To use jog mode to move all currently selected items on the screen by one screen pixel, simply press the arrow keys on the keyboard. To use jog mode to move a handle (for resize) by one screen pixel or to move a vertex (in vertex edit mode) by one screen pixel, select an item/group and start the move vertex or resize process. The arrow keys are not functional for these purposes until one of these processes have been initiated. While dragging the handle/vertex with the mouse, press down on one of the arrow keys on the keyboard (up, down, left, or right). Note that jog mode for these purposes requires using two hands (one hand is pressing down on the left mouse button during the drag, and the other hand is using the arrow keys to jog). Release the mouse button to terminate the resize or move vertex process. Note that the arrow keys do not override the drag/draw constraint (see page 89). If the drag/draw constraint is set to vert (which means you can only move up and down), and you press the left or right arrow key when an item is selected, nothing moves (including the mouse pointer). Similarly, if the drag/draw constraint is set to horz (which means you can only move left and right), and you press the up or down arrow key, nothing moves. Note: Jog mode moves the pointer by one screen pixel — not by one virtual pixel. Depending on the current zoom level, one screen pixel may not correspond to one virtual pixel. This is important if you want to abut lines (make them touch). You must zoom in to the lowest level (where one screen pixel corresponds to one virtual pixel) and then use jog mode to abut the lines. This guarantees that the lines touch at all zoom levels.
10.1 .7 To Resize an Item or
Grou p
1. Select an item or group to be resized. 2. Place the pointer on one of the eight handles of the item or group. 3. Press and hold the left mouse button, and drag the handle to the desired size. Do not release the mouse button while resizing. 4. Release the mouse button when the item or group is at the desired size.
238
OW330_90
10.1 What are the ways to working with selected items and groups?
10. 1.8 To Resize an Item or
Group by a Fa cto r
The resize-by-factor function is invoked from the edit menu, the resize toolbar, or the ‘Ctrl+R’ keyboard accelerator key. When you resize an item/group by factor, you are essentially multiplying the current width of the item/group by a width scale factor and multiplying the current height of the item/group by a height scale factor. You set the applicable width and height scale factors on the GBNT:Resize Scale Factors dialog (accessed from the Options menu, the resize toolbar [see the toolbar button showing ‘m=?’ and ‘n=?’], or the ‘Shift+R’ keyboard accelerator key). This dialog is used in conjunction with both the resize-by-factor and the resize-proportional-to-itemN (see section 10.1.9) functions. Only one item/group can be resized by factor at a time. The resize-by-factor menu item, toolbar button, and keyboard accelerator key are not active if more than one item/group is currently selected. 1. Select an item or group to be resized. Only one item/group can be resized at a time. If you want to change/view the resize-by-factor scale factors, perform Steps 2 through 4 below. If you want to use the existing settings, go directly to Step 5 below. 2. Pull down the Options menu, and select Resize scale factors . The Scale Factors window appears. 3. Set the desired width and height resize scale factors by entering the appropriate value in the width and height entry fields.Valid values are integer and real numbers >0. 4. Select "resize by factor" in the usage drop-down menu. Remember that this dialog si used for both resize-by-factor and resize-proportional-to-item functions. 5. Select one of the following buttons, and skip Step 5 below: Ok — Saves the selected settings, and q uits the Resize Scale Factors window. It also scales the currently selected item/group if only one item/group is selected. Ap pl y — Saves the selected settings, but the Scale Factors window remains open. It also scales the currently selected item/group if only one item/group is selected. Cancel — Quits the Scale Factors window without saving any changes. 6. Pull down the Edit menu on the main Graphics Builder window, and select Resize-by-factor (or use the corresponding toolbar button or the Shift+R keyboard shortcut). The selected item or group resizes by the specified factors. The position of the upper left corner of the item’s outlining rectangle remains the same after the resize. The Resize-by-factor function overrides the aspect ratio setting. That is, even though the Resize Aspect Ratio option may be set to “maintain,” the Resize-by-factor function resizes the selected item by the specified width/height factors regardless of whether aspect ratio changes or not. The resize-by-factor pin point is NOT configurable. It is always the upper left corner of the item’s outlining rectangle.
OW330_90
239
10.1 What are the ways to working with selected items and groups?
10. 1.9 Resize by ItemN Re lative t o ano ther Graphic Object The Resize-to-ItemN' pull-right menu item on the 'Edit' menu allows resizing a selected item/macro/group relative to some other item [itemN] on the graphic. When you resize-to-itemN, you are essentially setting the width of the selected item/group to the width of some other display item on the graphic (itemN) multiplied by a width scale factor and/or setting the height of the selected item/group to the height of some other display item on the graphic(itemN) multiplied by a height scale factor. You set the applicable width and height scale factors (when applicable) on the GBNT:Resize Scale Factors dialog (accessed from the Options menu, the resize toolbar [see the toolbar button showing ‘m=?’ and ‘n=?’], or the ‘Shift+R’ keyboard accelerator key). This dialog is used in conjunction with both the resize-by-factor (see section 10.1.8) and the resize-proportional-to-itemN functions. Only one item/group can be resized-proportional-to-itemN at a time. The resize-to-itemN menu item is not active if more than one item/group is currently selected. There is no corresponding toolbar button or keyboard accelerator key for this function. There are 4 variations available on the pull-right menu:
240
make same size as itemN - makes the selected item/group the same width and height as itemN.
make same width as itemN - makes the selected item/group the same width as itemN, the height of the selected item group does not change.
make same height as itemN - makes the selected item/group the same height as itemN, the width of the selected item group does not change.
make some user-defined proportion of itemN - make the selected item/group width and height some scale factor of itemN (makes selected item/group proportional to item N according to given width and height scale factors on the Resize scale factors dialog).
OW330_90
10.1 What are the ways to working with selected items and groups?
To Resize an Item or Group proportional to Item N 1. Select an item group on the graphic to be resized. 2. Select one of the four menu items from 'Resize-to-itemN' pull-right menu. ItemN can be any item/group/macro. (A footer message will tell you (Drag mouse & left click to select itemN (use ENTER for overlaid items). 3. If you selected the "make proportional+ItemN" item from the pull-down menu: a) Set the width and height scale factors used in conjunction with this function. b) Pull-down the Options menu and select the Resize Scale Factors menu item. The Resize scale Factors window appears. c) Set the desired width and height in the entry fields. Values are integers and real numbers >0.
OW330_90
241
10.1 What are the ways to working with selected items and groups? d) Select Resize-proportional-to -itemN in the usage drop-down menu. e) Select Ok/Apply 4. Move the mouse pointer over the desired itemN. As the mouse pointer moves on the canvas, hollow handles are displayed around the item/macro/group under the cursor, as a visual clue as to which item the mouse pointer is on. In the case of overlaid items, pressing the ENTER key repeatedly without moving the mouse will circulate thru a list of all of the possible items under the mouse (Using the ENTER key is the same mechanism used by GB to select overlaid items for any other edit function.) The note to use ENTER is incorporated into the footer message to remind you how to select overlaid items in GB. 5. As soon as the hollow handles are around the desired itemN, left-click to select it. The srcinal item will be resized. The GBNT: Resize Scale Factors dialog includes a 'usage' combobox so that you can invoke either resize-by-factor or resize-to-itemN functionality directly from this dialog. The 'usage' combobox will determine which function is invoked on OK/Apply if an item/group/macro is selected. If 'usage' is set to 'resize-proportional-to-itemN', GB will display the same footer as when invoked from the edit menu and will wait for you to select itemN just as it does when invoked from the edit menu.
10. 1.1 0
What is the Rotation Increment win dow ?
The Rotation Increment window allows you to specify the number of degrees an item can be rotated. This window is accessed from the Invert/Rotate toolbar. The default is 90 degrees of rotation. The rotation degree setting is saved as part of the Save Defaults function. In this way, you can configure the Graphics Builder to start with any rotation increment. To Set Rotation Increments 1. Access the Invert/Rotate toolbar.
Figure 68: Invert/Rotate T ool bar 2. Select the last button on the toolbar to display the Rotation Increment window.
Figure 69: Rota tion Increme nt Window 3. From this window, set the desired degree of rotation and press the OK or Ap pl y button. The default is 90 degrees.
242
OW330_90
10.1 What are the ways to working with selected items and groups?
To Rotate and Invert Items and Groups 1. Select the item or group to be rotated or inverted. 2. Access the Invert/rotate toolbar. If the toolbar is not currently displayed, pull down the View menu, pull right at Toolbars , and select invert/rotate . The Invert/Rotate toolbar displays five buttons. They are, from left to right:
Invert left to right.
Invert top to bottom.
Rotate clockwise by the number of degrees specified on the Rotation Increment window. Rotate counterclockwise the number of degrees specified on the Rotation Increment window.
Displays the Rotation Increment window (see page 242) which allows you to specify the number of degree to rotate a draw item.
3. Select the desired button. The selected item(s) or group inverts or rotates according to the setting on the Rotation Increment window. Note that all the currently selected items/groups rotate/invert. Multiple items/groups may be rotated/inverted in a single step.
10. 1.1 1
To Delete Items and Group s
1. Select the item or group to be deleted. Note that all the currently selected items/groups will be deleted. Multiple items/groups may be deleted in a single step. 2. Pull down the Edit menu, and select Delete. The selected item or group is deleted.
10.1.12
Wha t is Copying and Pasting items and group s?
The Graphics Builder supports two different types of copy and paste functions. You can copy and paste items from one graphic to another using the Copy and Paste items on the Edit menu. You can also make multiple copies of a draw item within a graphic using the Duplicates item on the Edit menu.
OW330_90
243
10.1 What are the ways to working with selected items and groups? To Copy and Paste from One Gra phic t o Ano ther GBNT supports an interactive copy and paste function which can be used to copy selected items/groups from one graphic to another. These functions are implemented via the Copy and Paste menu items found on the Edit menu on the main GBNT window. The items/groups are stored in an internal buffer. Only the selected items/groups and their attributes (color, conditionals, line width, and so forth) are copied to the internal buffer. The overall diagram background color is not copied. These functions cannot be used to copy and paste to/from the source editor window or the interactive conditional pop-up windows. If the aspect ratio of the items/groups copied to the internal buffer is to be maintained during the paste, it is necessary that the width/height of the diagram the items were copied from is the same as the width/height of the diagram the items are pasted into. If the dimensions of the diagram copied from are different than the dimensions of the diagram to paste into, aspect ratio will not be maintained. It is your responsibility to be aware of this and manage this if required. 1. To copy items/groups to the internal buffer, select the items/groups to be copied. Pull down the Edit menu on the main GBNT window, and select Copy (or use Ctrl+C on the keyboard). All of the items/groups selected will be copied. No processing message displays during the copy since it is almost instantaneous. 2. To paste from the internal buffer, pull down the Edit menu on the main GBNT window, and select Paste. Press and hold the left mouse button with the mouse pointer on the GBNT canvas, and do not release the mouse button. An outlining rectangle will appear at the location of the mouse pointer. This rectangle represents the dimensions of the items/groups being pasted. Drag/move the rectangle to the desired location and release the mouse button. The rectangle will be erased and the items/groups will be displayed. After the paste operation, whatever was pasted is selected on the graphic. Also, if more than one item was pasted, the items are grouped together. You can ungroup them by selecting Ungroup from the Edit menu. To Copy an Item/ Group usin g th e Duplicate s Function Use the following procedures to make copies of a single item/group using the Edit menu Duplicates function. 1. Select the item or group to be copied. 2. Pull down the Edit menu, and go down to Duplicates . Pull right to display the Duplicates menu. Note that the Duplicates function is only valid when a single item/group is selected. The Duplicates menu displays a list of numbers between 1 and 10. 3. Without releasing the mouse button, drag the pointer down the Duplicates menu to select the desired number of copies. Release the mouse button to choose the number of copies. A duplicate mode message displays in the left footer of the Graphics Builder window after selecting the count. The outlining rectangles of the copies are initially displayed overlaid on top of the item/group to copy, and the mouse pointer is initially positioned at the upper left corner of the item/group to copy. 4. spacing Without between pressing the anyupper mouse buttons, pointer. of Asthe theitem/group pointer moves, theand left corner begin of the moving outliningthe rectangle to copy the pointer is calculated. This is the spacing between successive copies. The outlining rectangles for the copies drag as the mouse pointer moves. 5. Click to mark the final position of the copies.
244
OW330_90
10.2 What are the Editing Attributes?
10 .2 Wha t are the E diting At
tribu tes?
In addition to editing draw items, you may also want to display the drawing attributes and edit them (color, font, fill patterns, and so forth). To do this, the following topics apply:
Displaying Attributes and Parameters for Editing (see page 245)
Changing Attributes (see page 245)
Note: The Button command does NOT use the color, font, line patterns, fill patterns, line width, or blink attribute dialogs. All drawing attributes are set/changed from the GBNT:Button dialog.
10. 2.1 To D isp lay Attr ibu tes and Parame ters fo r Editi ng To display the current attribute settings (such as color, font, blink, and so forth) for a draw item, the Properties function is used. 1. Select the item for which you want to display the attributes or parameters. Only a single item (not a group) can be selected to perform a Properties function. 2. Display the applicable attribute window (color, blink, font, line width, line pattern, or fill pattern). Note: The Properties function does not display the Color, Blink, font, Line Pattern, Line Width, or Fill Pattern windows if they are not already displayed. However, these windows are updated even if they are not currently displayed. If the selected item has its own parameter window (bar, plot, xy plot, trend, and so forth), the parameter window displays. You do no t have to display the parameter window manually. 3. Pull down the Edit menu, and select Properties . The attributes for the selected item displays in the attribute windows (including conditionals if they exist).
10. 2.2 To Change A ttri but es 1. Select the item whose attributes you want to change. 2. Pull down the Edit menu to At tr ib ut es. Pull right on Attr ibut es to display another menu. 3. Select the appropriate menu item from the Attributes menu. 4. Pull down the Edit menu, and select Properties . You must perform a Properties function to display the current attributes before you can edit them. 5. Follow the instructions to edit the desired attribute (see page 111). The procedures for editing attributes are the same as the procedures for setting them.
OW330_90
245
10.3 Editing Vertices?
10. 3 Editin g Ve rti ces? The Graphics Builder provides a mechanism for editing the individual vertices of lines, polygons, rectangles and rectangular types. Rectangular types include Bar, Plot, XY Plot, Trend, Poke, Dynamic Line, Dynamic Polygon, OL Rectangle, OL Gauge, OL Slider, and OL Cylinder. The mechanism is called vertex edit mode . A vertex is defined as the point at which two adjacent line segments intersect. The edit features supported for vertices are move, align, snap, and undo. For lines and polygons, add and delete features are also supported. Movement of vertices may be constrained to horizontal or vertical if desired. A vertex may be aligned to some point on another item (target), or to another vertex of the same item. When in vertex edit mode, the left footer of the main Graphics Builder window will display the message . Also, the item selected for vertex edit will have special handles, which are different from the standard item handles. Not all of the vertex edit features are valid for all items (for example, one cannot add/delete vertices for the rectangular items). Vertex edit features not supported for the selected item are grayed out on the vertex edit menu. Once vertex edit mode is initiated, you cannot access the standard edit menu. Therefore, you cannot resize, copy, delete, and so forth. You must manually exit vertex edit mode to return to normal operation. If you attempt to edit the graphic from any window (that is, to draw a new item, change attributes, or edit the source), vertex edit mode will be automatically exited.
10.3 .1 To Enter Vertex Edi t Mod e 1. Select the line, polygon, rectangle, or any rectangular type. Only one of these items may be currently selected to enter vertex edit mode. A group cannot be selected for vertex edit. The Vertex Edit menu item is not active if a group or multiple items are selected. 2. Pull down the Edit menu on the main Graphics Builder window, and select Vertex Edit .
246
OW330_90
10.3 Editing Vertices?
Note: The Vertex Edit option is inactive (grayed out) when invalid items are selected (that is, arc, circle, ellipse, groups, text items, multiple-selected items, and so forth). When you select Vertex Edit, the handles around the outlining rectangle for the line, polygon, rectangle, or rectangular type are replaced with a vertex edit handle on each vertex point. The vertex edit handle is an “x”. The special handles are a visual clue that you are in vertex edit mode. Also, a vertex edit mode message is displayed in the left footer of the Graphics Builder window.
Figure 70: Vertex Edit Mode
OW330_90
247
10.3 Editing Vertices?
10. 3.2 Selecting a new Item f or Vertex Edit During vertex edit mode, it is possible to change the item selected for vertex edit. To edit a different item, left-click on the new item. The currently selected item becomes deselected and the new item becomes selected — providing that the new item is a valid vertex edit item. If the new item is not valid for vertex edit, nothing happens. No notice window/error message are displayed. If the new item is valid for vertex edit, the “x” handles are erased for the srcinal vertex edit item, and “x” handles are displayed on the new item. A new item can be selected in vertex edit mode whenever the message is displayed in the left footer of the main Graphics Builder window. If some other vertex edit prompt is displayed in the left footer (such as ), it is not possible to change the selected item at that time. During the vertex edit mode, there is always exactly one item selected for vertex edit; it is not possible to have no items selected. Clicking on white space will not deselect the currently selected item in vertex edit mode as it does outside of vertex edit mode.
248
OW330_90
10.3 Editing Vertices?
10. 3.3 Selecting a Target Item for
Vertex Edit
In vertex edit mode, it is possible to align/snap to a point on some other item called the target item . The target item is selected in addition to the item selected for vertex edit. The target item is used in conjunction with the align x coords, align y coords, and snap to vertex menu items. The target item is never modified during vertex edit. Only one target item may be selected during vertex edit. ANY item/group may be selected as the target item. A target item can be selected in vertex edit mode whenever the message is displayed in the left footer of the main Graphics Builder window. If some other vertex edit prompt is displayed in the left footer (such as ), it is not possible to select a target item at that time. Once in vertex edit mode, to select the target item, Ctrl + left-click on the item/group. Target item handles (resemble snowflakes) display on the item/group. The handles mark the points on the item/group to which to align a vertex on the vertex edit item (“x” handles). The target item, if one is selected, always has “snowflake” handles; the vertex edit item always has “x” handles.
Figure 71: Target Item and Vertex Edit Item
OW330_90
249
10.3 Editing Vertices?
10. 3.4 Selecting a new Target Item During vertex edit mode, it is possible to change the target item selected for vertex edit. To specify a different target item, Ctrl + left-click on the new item. The currently selected target item becomes deselected and the new target item becomes selected. The filled circle handles are erased for the srcinal target edit item, and filled circle handles are displayed on the new target item. A new item can be selected in vertex edit mode whenever the message is displayed in the left footer of the main Graphics Builder window. If some other vertex edit prompt is displayed in the left footer (such as ), it is not possible to change the target item at that time. Clicking on white space will not deselect the currently selected target item in vertex edit mode.
10.3 .5 To Mo ve a Vertex 1. Enter vertex edit mode. 2. Position the pointer on the handle on the vertex to move. 3. Press and hold the left mouse button, and drag the pointer to the desired location for the vertex. Do not release the mouse button while dragging. Note: As you drag the vertex, all of the other vertex handles erase so that the handle on the vertex being moved does not obscure the vertex positioning. 4. Release the left mouse button when the vertex is at the desired location.
10.3 .6 To Ad d a Ver tex Vertices can only be added to lines and polygons. New vertices are added at the midpoint of the selected line segment of the item. 1. Enter vertex edit mode.
250
OW330_90
10.3 Editing Vertices? 2. Right-click anywhere on the drawing canvas to display the Vertex Edit menu.
Figure 72: Vertex Edit Menu 3. Select add vertex from the Vertex Edit menu. The message
