PLEASE NOTE: AVEVA Solutions has a policy of continuing product development: therefore, the information contained in this document may be subject to change without notice. AVEVA SOLUTIONS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENT, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. While every effort has been made to verify the accuracy of this document, AVEVA Solutions shall not be liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance or use of this material.
This manual provides documentation relating to products to which you may not have access or which may not be licensed to you. For further information on which Products are licensed to you please refer to your licence conditions. Copyright 1991 through 2004 AVEVA Solutions Limited
All rights reserved. No part of this document may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of AVEVA Solutions. The software programs described in this document are confidential information and proprietary products of AVEVA Solutions or its licensors.
For details of AVEVA's worldwide sales and support offices, see our website at http://www.aveva.com
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK
Revision History Date
Version
Notes
March 2003
11.5
Section 5.1.1 translucency values for transparent and opaque interchanged Use of REPR UPDATE command is now included in the descriptions of Sections 5.2.1, 2, 3, 4, 6 and 8. Section 5.2.4 title now includes 'for Piping Components.' Translucency values for opaque and transparent have been corrected. Section 5.2.5 is a new section to cover translucency for steelwork. Sections 5.2.* following 5.2.5 have been renumbered 'plus one'
June 2004
11.6
Section 7.4 – ISODRAFTMODE command
August 2004
11.6
Miscellaneous changes to Comparison Date text and mirror corrections.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
Revision History-i
Revision History
Revision History-ii
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
About the Design Reference Manual..........................................................................................1-1 Organisation of the Design Reference Manual...........................................................................1-1 Organisation of this Manual .......................................................................................................1-2
2
How to Use the Syntax Graphs.....................................................................2-1
2.1 2.2 2.3
2.4
Commands ..................................................................................................................................2-2 Command Arguments .................................................................................................................2-2 Standard Syntax Graphs .............................................................................................................2-4 2.3.1 Universal Expression .................................................................................2-4 2.3.2 Date/Time ..................................................................................................2-5 2.3.3 Physical Dimension ...................................................................................2-6 2.3.4 Design Element Type or ............................................................2-7 2.3.5 Design Element Identity ..............................................................................2-9 2.3.6 3D Design Points ..................................................................................2-12 2.3.7 Axial Position ..............................................................................2-13 2.3.8 3D Position .............................................................................................2-14 2.3.9 3D Axis Direction .....................................................................................2-15 2.3.10 3D Direction ............................................................................................2-16 2.3.11 Selection .................................................................................................2-17 Command Input Modes ............................................................................................................2-19
3
General PDMS Commands ...........................................................................3-1
3.1 3.2
Entering Design ..........................................................................................................................3-1 Saving .........................................................................................................................................3-1 3.2.1 Saving Design Work ..............................................................................................3-1 3.2.2 Saving and Restoring the Display ..........................................................................3-2 The Alpha Display......................................................................................................................3-2 3.3.1 Saving the Alpha Log.............................................................................................3-2 3.3.2 Clearing the Alpha Views ......................................................................................3-4 Leaving Design ...........................................................................................................................3-4 3.4.1 Changing Modules .................................................................................................3-4 3.4.2 Exit from Design without Saving Changes............................................................3-4 Setting Working Units and Tolerances.......................................................................................3-5 3.5.1 Setting Working Units............................................................................................3-5 3.5.2 Setting Output Precision of Distance Units............................................................3-6 3.5.3 Switching between Actual and Nominal Bores......................................................3-7 Audible Error Trace....................................................................................................................3-8 Switching Text Output Off .........................................................................................................3-8 Giving Operating System Commands from PDMS....................................................................3-9 General Querying Facilities........................................................................................................3-9 3.9.1 Querying Your Current Module...........................................................................3-10 3.9.2 Querying Your System.........................................................................................3-10 3.9.3 Querying Your Current Output Devices ..............................................................3-11 3.9.4 Querying the Command Implementation Mode...................................................3-12
3.3
3.4
3.5
3.6 3.7 3.8 3.9
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
Contents-i
Contents
3.9.5 3.9.6
4
Asking for a Unique Workstation Code...............................................................3-12 Querying Elements and Attributes in DBs...........................................................3-12
Design Databases and MDBs .......................................................................4-1
4.1 4.2 4.3 4.4 4.5
MDB Mode .................................................................................................................................4-1 Checking the Current User Status...............................................................................................4-2 Checking the Current System Status ..........................................................................................4-2 Listing Project Information.........................................................................................................4-3 Sessions ......................................................................................................................................4-5 4.5.1 Session Comments .................................................................................................4-5 4.6 Querying MDB Information.......................................................................................................4-6 4.6.1 Querying Individual Database Information............................................................4-6 4.7 Change Management ..................................................................................................................4-7 4.7.1 Querying the Last Modification to an Element or Attribute ..................................4-7 4.7.2 Querying the Session History for an Element or Attribute ....................................4-8 4.7.3 Querying Details of a Specific Session..................................................................4-8 4.7.4 Querying Session Number for a Given Time.........................................................4-8 4.8 The Comparison Date.................................................................................................................4-9 4.8.1 Setting the Comparison Date ...............................................................................4-10 4.8.2 Querying the Comparison Date............................................................................4-11 4.8.3 The MODIFIED Function....................................................................................4-12 4.8.4 The CREATED Function.....................................................................................4-14 4.8.5 The DELETED Function .....................................................................................4-14 4.8.6 The GEOM, CATTEXT, and CATMOD Special Attributes...............................4-14 4.8.7 Querying Any Attribute at the Comparison Date.................................................4-15 4.9 Using Multiwrite Databases .....................................................................................................4-16 4.9.1 User Claims..........................................................................................................4-17 4.9.2 Notes on Standard Multiwrite DBs ......................................................................4-18 4.9.3 Extract Databases.................................................................................................4-18 4.9.4 How to Find Out What You Can Claim...............................................................4-20 4.10 Comparing Database Changes..................................................................................................4-25 4.10.1 Comparing Database States at Different Times ...................................................4-25 4.11 Creating Database Update Macros ...........................................................................................4-26 4.12 Inter-DB Connection Macros ...................................................................................................4-27
Adding Elements to the Display .................................................................................................5-1 5.1.1 Selecting Graphics Colours Automatically............................................................5-3 5.1.2 Removing Elements from the Display ...................................................................5-5 5.1.3 Defining Colours....................................................................................................5-5 Element Representation ..............................................................................................................5-8 5.2.1 Setting Tube Representation for Piping Components ............................................5-8 5.2.2 Setting Profile Representation for Steelwork.........................................................5-9 5.2.3 Setting Drawing Level Representation ................................................................5-10 5.2.4 Setting Obstruction & Insulation Representation for Piping Components ..........5-11 5.2.5 Setting Obstruction Representation for Steelwork...............................................5-12 5.2.6 Setting P-Point Representation ............................................................................5-14 5.2.7 Setting Structural Node Representation ...............................................................5-15 5.2.8 Setting P-Line Representation..............................................................................5-16 5.2.9 Setting Holes Representation ...............................................................................5-17 5.2.10 Setting Arc Tolerance Representation..................................................................5-17 5.2.11 Refreshing the Graphical View............................................................................5-18
5.2
Contents-ii
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
Contents
5.3 5.4 5.5 5.6 5.7
Specifying Axes ........................................................................................................................5-18 Graphical Labelling of Design Elements..................................................................................5-19 Using Design Aids....................................................................................................................5-20 Highlighting Components in the Designs.................................................................................5-24 Spatial Maps .............................................................................................................................5-25 5.7.1 Checking the Spatial Maps...................................................................................5-25 5.7.2 Creating or Updating Spatial Maps......................................................................5-26
6
Using Rules to Define Attribute Settings.....................................................6-1
Interacting with a Graphical View.................................................................7-1
7.1
7.3 7.4
Identifying Displayed Items and Points......................................................................................7-1 7.1.1 Identifying Displayed Elements using the Cursor..................................................7-1 7.1.2 Identifying Tube using the Cursor .........................................................................7-2 7.1.3 Identifying Displayed Points using the Cursor ......................................................7-2 7.1.4 Identifying Items with a 2D Pick ...........................................................................7-3 3D Pins .......................................................................................................................................7-4 7.2.1 Setting a Pin’s Position and Direction Explicitly...................................................7-4 7.2.2 Making a Pin Visible..............................................................................................7-5 7.2.3 Locating a Pin by Copying or Connecting.............................................................7-6 7.2.4 Moving a Pin..........................................................................................................7-6 7.2.5 General Pin Moves.................................................................................................7-7 Constructs ...................................................................................................................................7-7 Isodraft Mode ...........................................................................................................................7-10
Elements .....................................................................................................................................8-1 8.1.1 Creating Elements ..................................................................................................8-1 8.1.2 Creating Elements at a Given Position in the Member List...................................8-2 8.1.3 Deleting Elements ..................................................................................................8-3 8.1.4 Reorganising the Hierarchy....................................................................................8-4 8.1.5 Copying …………… .............................................................................................8-5 8.1.6 Copying and Renaming..........................................................................................8-6 The Standard Design Element Attributes ...................................................................................8-7 8.2.1 The Type of Element and its Owner ......................................................................8-7 8.2.2 Naming Design Elements.......................................................................................8-8 8.2.3 Renaming Elements and their Offspring................................................................8-8 8.2.4 Locking Elements Against Alteration and Deletion .............................................8-8 8.2.5 The Position and Orientation Attributes.................................................................8-9 Navigation ................................................................................................................................8-10 8.3.1 Going to the Previously Accessed Element .........................................................8-10 8.3.2 Going to an Implied Tube or Rod ........................................................................8-11 8.3.3 Ascending the Design Hierarchy .........................................................................8-11 8.3.4 Other Navigation Commands...............................................................................8-12 Setting a Synonym for an Element Name.................................................................................8-12
7.2
8.2
8.3
8.4
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
Contents
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
Contents-v
Contents
Contents-vi
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
1 Introduction 1.1 About the Design Reference Manual The VANTAGE PDMS Design Reference Manual describes all the Design commands in detail. It also describes how the Design database is structured, the Design database elements and their attributes. Design is normally used interactively. The Graphical User Interface (GUI) provides discipline-based applications which help you to create, check and report on the model. How to use the applications is described in user guides and on-line help. This manual is written for experienced users of VANTAGE PDMS Design who need to use commands; for example, to write batch macros or to customise the GUI. If you are going to customise the GUI, you will also need to refer to the Plant Design Software Customisation Guide and Plant Design Software Customisation Reference Manual for information about PML, the AVEVA programming language.
1.2 Organisation of the Design Reference Manual The Design Reference Manual has four parts: •
•
•
•
Part 1 (this volume) describes general Design commands, which are used, for example, for setting up the display, and querying and navigating around the Design database. It also describes how to use the command syntax graphs, which are used to show all the options available for each command. Part 2, Creating the Model, describes the commands for creating database elements and setting their attributes. Part 3, Elements and Attributes, contains details of all the elements which can be created in the Design database, their position in the database hierarchy and their attributes. Part 4, Utilities, describes the Design Utilities for data consistency checking and clash detection, and for exporting Design data to programs such as Review.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
1-1
Introduction
1.3 Organisation of this Manual This manual, Part 1, is divided into the following chapters: •
•
•
•
•
•
•
•
1-2
Chapter 2 describes How to use the Syntax Graphs, and also shows the standard syntax graphs which are often referenced from other graphs. Chapter 3, General PDMS Commands, describes commands used for saving work, setting units and tolerances, and handling alphanumeric output. These commands are common to several PDMS modules, but are included here for convenience. Chapter 4, Design Databases and MDBs, describes how to handle multiple databases from within Design, database sessions, how to query information about the project, and how to used multiwrite databases. Chapter 5, Display, describes how to control the way the model is displayed in a graphical view. Chapter 6, Using Rules, gives some examples of using rules in Design to control attribute settings. Chapter 7, Interacting with a Graphical View, describes how commands can accept input from picked items in the graphical view, and how to define construction aids and label the design elements. Note that the commands in this chapter have generally been superseded by newer graphical facilities available from the GUI, and are only included as information for users maintaining older code. Chapter 8, Design Database Elements, describes the commands to create Design elements and set the attributes common to all Design elements, and how to navigate about a Design database hierarchy. Chapter 9, Error Messages, explains some of the error messages which may be generated by Design.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2 How to Use the Syntax Graphs The commands described in this chapter are presented in the form of syntax graphs . •
•
Syntax graphs are read from top left to bottom right. The start point is shown by >, and you can follow any path through the graph until the exit point, shown by >, is reached. Points marked with a plus sign (+) are option junctions which allow you to input any one of the commands to the right of the junction. For example: >----+--- ABC -----. | | |--- PQR -----| | | `-------------+--->
means you can type in ABC or PQR or just press Enter to get the default option. •
Text in angle brackets <. . . > is the name of another syntax graph. This convention is used for syntax which occurs in many places. The graphs referred to are described at the end of this section. For example: >----+--- ABC -----. | | |--- PQR -----| | | |--- ---| | | `-------------+--->
means you can type in ABC or PQR or any command allowed by the syntax given in diagram or just press Enter to get the default option. •
Points marked with an asterisk (*) are loop back junctions. Command options following these may be repeated as required. For example: .-----<-------. / | >---*--- option1 ---| | | |--- option2 ---| | | `--- option3 ---+--->
means that you can enter any combination of option1 and/or option2 and/or option3, where the options can be commands, other syntax diagrams, or command arguments. The simplified format:
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2-1
How to Use the Syntax Graphs
.----<------. / | >---*--- name ----+--->
means that you may type in a list of PDMS names, separated by at least one space.
2.1 Commands Commands are shown in a combination of uppercase and lowercase letters, where the capital letters indicate the minimum abbreviation. (Note: This convention does not mean that the second part of the command must be typed in lowercase letters; commands may be entered in any combination of uppercase and lowercase letters.)
For example, the command CONStruct
can be input in any of the following forms: CONS CONST CONSTR CONSTRU CONSTRUC CONSTRUCT
Commands shown in all uppercase letters cannot be abbreviated.
2.2 Command Arguments Command arguments are shown in lowercase letters. These are just descriptions of what you need to enter. The most commonly used descriptions are as follows:
2-2
integer
A positive or negative whole number. For example: 2 –5 25
value
A signed number with or without a decimal point. For example: 2.5 5 –3.8
letter
A single alphabetic character
word
A sequence of up to four letters, e.g. GATE WN P (may be longer in some cases, but only the first four characters are significant).
text
A string of alphanumeric or symbol characters, which may include spaces, enclosed between single closing quotation marks or | characters. This is normally used to add descriptive material to an appropriate attribute. For example DUTY ’Low Pressure’
space
The space bar (not usually specified unless of special significance)
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
name
A sequence of characters preceded by a slash / and representing a PDMS Element name. For example: /BRANCH7 /305.ABC /P4/NOZ A name should always be followed by a space Note: (unless at the end of a line).
filename
An external file name of the form /filename
varid
An identifier (for use with the VARIABLE command within macros) of the form !name where ‘name’ is a text string. For example:
!COUNTER, comma
!height
The ‘,’ character, which can be used to concatenate Design commands. For example:
NEW FLANGE SELECT WITH STYP WN, CONNECT plus minus star slash These are the + (add), – (subtract), * (multiply) and / (divide) operators, which can be used in arithmetic expressions. For example: (1 + 2), (1 – 2), (1 * 2), (1 / 2) Note that there must be a space before and after each of these operators. Note:
PML 1 expressions and variables are explained in the Plant Design Software Customisation Reference Manual.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2-3
How to Use the Syntax Graphs
2.3 Standard Syntax Graphs If a syntax graph refers to a second syntax graph, the name of the second graph is shown in angle brackets. This convention is usually used for standard syntax graphs which are widely used. These syntax graphs are summarised below, and then shown in detail.
Mathematical, textual or logical expressions
Physical dimension specification
or
Design element type
Design element identity
3D Design points (P-points, pins or P-lines)
or
Axial position
3D position
Axial direction
3D direction
Selection
2.3.1 Universal Expression If a value given in a command needs to be calculated from other known values, you can enter an expression, which is evaluated by Design as it executes the command. You will find details of PML 1 expressions in the Plant Design Software Customisation Reference Guide. On-line help describing expressions syntax is available from within Design applications.
2-4
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
2.3.2 Date/Time has the general format Time Day Month Year . Time has the format hour:mins. If no Time is given, the default is 23:59. Day is a single or two-digit integer. If no Day is given, the default is today. If no Time is given, Day must be specified. Month may be entered as a word, or as a number surrounded by spaced / characters.
If no Month is given, the default is the current month. Year may be entered as four digits or as two digits. Two-digit years are interpreted
within the date window current_year – 99
to
current_year
For example, in the year 2004: 03 04 05
means 2003 means 2004 means 1905
If no year is given, the default is the current year. Examples 12:00 22 August 1999 9:30 29 / 8 / 99
Note spaces in numeric date format
10:30
Assumes current date
22 / 8 / 1999
Assumes time to be 23:59
22 August
Assumes current year and time 23:59
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2-5
How to Use the Syntax Graphs
2.3.3 Physical Dimension This syntax allows you to override the working (default) units for dimensions . >--+-- value ----. | | `-- ---+-- EXponential value --. | | `-----------------------+-- MM ------. | | |-- Metres --| | | |-- INches --| | | |-- FT ------| | | |-- FEet ----| | | |-- text ----| | | `------------+-->
Examples
5
5
in current working units
EX3
5500
in current working units
5.3/4
5.75
in current working units
5’
5 feet
(only use when working units are FINCH)
5’6
5 feet 6 inches
(only use when working units are FINCH)
5’6.3/4
5 feet 6.75 inches
(only use when working units are FINCH)
5 INCHES
5 inches
(regardless of current working units)
5 M
5 metres
(regardless of current working units)
5’6.3/4 IN
5 feet 6.75 inches
(regardless of current working units)
(5 + 2) IN
7 inches
(regardless of current working units)
NOTE: Values are always held within Design as metric units. When output, values are
rounded as follows:
2-6
•
Millimetres to the nearest millimetre
•
Inches to the nearest 1/32 or 0.1 inch
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
2.3.4 Design Element Type or This syntax graph refers to an Element Type in the Design hierarchy. To save space, the available element types are presented as simple lists rather than as syntax diagrams: Administrative: WORLds
The following are soft-types for use with the HVAC Designer application: AHU BATT BRCO COWL DAMP FLEX GASK GRIL HACC HFAN HSAD IDAM MESH OFST PLAT PLEN SILE SKIR SPLI STIF STRT TAPE THRE TP TRNS
Air handling unit Battery: heater, cooler Branch connector: boot, square, fish, angled, tapered, mitred etc. Roof cowl Damper Flexible tube, flexible bend, material connection Gasket Grille Access panel Centrifugal fan Saddle Internal damper Mesh end Offset: cranked, mitred, radiused Spigot plate Spigot box, plenum Silencer Skirt Splitter: flow splitter, deflectrol, air turning vanes Stiffening flange Straight Taper Threeway: radiused, twin bend, breeches etc. Test point, test holes Transformation: square to round, square to flat oval, oval A to oval B etc.
Datums and Constraints: BOUNdary POInts GRDmodels
2-8
DRAWIngs IPOints TEXts
DATums TANpoints
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
2.3.5 Design Element Identity This syntax identifies a Design Element. The main syntax graph is , shown below. The sub-graphs follow.
LAst -----. | FIrst ----| | PREvious -| | NEXt -----+-- integer --. | | ‘-------------+-- MEMbers--. | integer -----------------------------+-- OF ->
Identification by physical position in the design model: .----<----. / | >- CLOSest -*- -+- WITH -. | | `---------------+- UP ----. |- DOWN --| |- EAST --| |- WEST --| |- NORTH -| `- SOUTH -+-. .----------------------------<--------------------’ `-+- EXTENT -. | | `-----------------+- AFTER -. | | `----------------+- FROM -. | | `---------------+->
WITH
specifies rule restricting choice of element (default is no restriction);
EXTENT
specifies how far to search before giving up (default is 10 metres);
AFTER FROM
specifies that search is to start after given distance in given direction (default is zero); specifies reference position from which search is initiated (default is CE).
Examples 2-10
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
/EQUIP10
Named design Element
SAME
Previous Element accessed
OWN
Owner of Current Element
GOTO SPRE
Specification of Current (piping) Element
NEXT 2
Second Next Element at same level
4
Fourth Member of Current Element
LAST 3 MEM
Third Last Member of Current Element
END
Next element up in hierarchy
SITE
Site above Current Element
ZONE 3
Third Zone
NEXT 2 PIPE
Second Next Pipe
PREV BOX FIRST ZONE OF /SITE 5 PIPE OF /VALV101 FIRST MEM OF BRAN3 OF /PIPE10 HEAD OF FIRST BRAN CLOSEST VALV EAST Closest valve to current element in East direction in design model (note that syntax accepts only cardinal directions, which must be entered in full) CLOS VALV NORTH FROM E100 N200 U300 Closest valve in North direction starting from given position (valves found before this position are ignored)
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2-11
How to Use the Syntax Graphs
2.3.6 3D Design Points This syntax describes 3D Design Points and their Attributes. A Design Point is •
and where: = >--+-- North --. | | |-- Y ------| | | ‘-- South --+-- --> = >--+-- Up ----. | | |-- Z -----| | | ‘-- Down --+-- --> = >--+-- East --. | | |-- X -----| | | ‘-- West --+-- --> = >--+-- WRT --. | | ‘-- IN ---+--
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
-->
2-13
How to Use the Syntax Graphs
Examples
E1000 East 1000 Z10
Up 10
E30 D10 S20East 30 Down 10 South 20 E0 IN SITE East 0 in Site
2.3.8 3D Position This syntax provides a 3D position in terms of a specified coordinate, a known identity or point, or a cursor position. General axial position:
>-- --+-- --. | | ‘------------+-->
(see previous subsection) 3D Design point:
(see above)
General element identity: (see above) Cursor position:
>-- @ -->
Examples
E300 N1000 U2500 Coordinate position PIN6
Pin position
/VESSEL10
Origin of /VESSEL10
@
Working grid position closest to the crosshair position and through the Current Element Origin plane
NOTE: Cursor positioning (e.g. AXES AT @) can only be carried out in orthogonal
views.
2-14
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
where: = >--+-- North ---. | | |-- Y ------| | | ‘-- South --+--> = >--+-- Up -----. | | |-- Z -----| | | ‘-- Down --+--> VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
= >--+-- East --. | | |-- X -----| | | ‘-- West --+--> = >--+-- --.
| | ‘-- value ---+-->
2-15
How to Use the Syntax Graphs
Examples
E
East
E45N
East 45 North
W-33D
West 33 Up
Y
North
N45E33D
North 45 East 33 Down
N10E10
North 45 East
2.3.10 3D Direction This syntax provides a 3D direction by making use of a specified axis direction, a design point, or two 3D positions. General axial direction
>-- --+-- ---. | | ‘-------------+-->
(See previous subsections for and ) 3D Design point direction:
(see above)
3D position direction: >--+-- FRom TOwards --> | ‘-- TOwards -->
(see above for )
2-16
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
Examples
N45E
Axis direction
PL
Design point direction
TOW E0 WRT SITE
From Current Element Origin to SITE origin
FROM PIN6 TO PIN7
From Pin 6 to Pin 7
2.3.11 Selection This syntax lets you describe elements you want to include in, or exclude from, operations. Typically, the following criteria are used to define a selection: •
•
•
•
•
A class of elements or element types to be selected. You can specify whether all members are to be included, or whether only items (the lowest level components in the hierarchy below a given element) should be included. See below. A logical expression to be satisfied for all selected elements. These expressions return either True or False, and are usually used to check the values of attributes. See the Plant Design Software Customisation Reference Manual. A physical volume in which all selected elements must lie. This volume is always orthogonal to the World coordinate axes. You can specify this in terms of two diagonally opposite points of an enclosing box, or as a volume around an element (with an optional clearance around the element selected). See below. A point in the hierarchy below which all selected elements must lie. You can follow this with an exclusion list to exclude elements from the selection. See below. A list (or collection), such as a drawlist, obstruction list or claimlist, of which the selected elements must be members.
All of these criteria are optional, except for class. If all element types are valid, this should be AL L . If you specify more than one criterion, the specifications must be in the above order, as shown by the following graphs:
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
allows you to specify a volume to be selected: = >-+- WITHIN -----------. | | ‘- EXCLusive WITHIN -+-- VOLume - -+- -. | | | | ‘--------| | | ‘- - TO - -------+->
gives the point in the hierarchy below which elements are to be selected: =
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
How to Use the Syntax Graphs
Examples ALL
Selects all elements
ALL FRMW
Selects all framework elements ALL BRANCH MEMBERS
Selects all piping components ITEMS OF EQUI /VESS1
Selects all primitives below /VESS1 (/PIPE1 /PIPE2)
Selects just /PIPE1 and /PIPE2 ALL WITH (XLEN GT 1000)
Selects all elements where XLEN is greater than 1000mm ALL WITHIN W8000N17000U1000 TO W1400N13500U1200
Selects all elements within the defined volume ALL PIPE WITHIN VOLUME /PIPE1 1500
Selects all piping elements within a volume defined as a box drawn around /PIPE1, with a clearance of 1500mm between the edges of /PIPE1 and the volume box.
You can minimise the time taken for any selection operation by making the selection criteria as specific as possible, so that only relevant parts of the databases are searched for the required elements. Where known, specify the element type (e.g. ALL BOX ...), the database element under which the search is to be restricted (e.g. ALL BOX FOR /ZONE1 ...), the volume in which you are interested (e.g. ALL BOX WITHIN N5000 E5000 U0 TO N10000 E12000 U8000 ...), and so on. If you do not do this, all databases in the current MDB will be searched, whether or not they contain relevant types of element, and performance will be impaired.
2.4 Command Input Modes Generally, in Design you are able to access the full range of Design command syntax. However there are two modes where the syntax is restricted to commands only relevant to that mode. The modes are: •
MDB mode allows you to change or query databases during a Design session.
Described in Chapter 4. •
DESCLASH mode allows you to check the design for clashes. Described in the Design Reference Manual Part 4: Utilities.
To return to normal Design mode, enter the command EXIT.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
2-19
3 General PDMS Commands 3.1 Entering Design Keyword:
Design
Description:
Enters Design. This command is available throughout PDMS.
3.2 Saving 3.2.1 Saving Design Work Keyword:
SAVEWORK [n] GETWORK [n]
Description:
SAVEWORK saves the current Design changes without leaving Design. It is good practice to use this command on a regular basis during a long Design session to ensure maximum data security. The optional number n can be used to specify a particular database for the command. The number is the number of the database in the order output by the STATUS command (see Section 4.2). If no number is given, the SAVEWORK applies to the whole MDB.
GETWORK refreshes the view of all READ databases to pick up any changes that other users may have made since you first opened them. The optional n works in the same way as for SAVEWORK. You would normally only use GETWORK if you know of specific changes you wish to pick up and use. Please note that GETWORK slows up subsequent database access, as the information has to be reread from disk. Therefore, you should use this command sparingly.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-1
General PDMS Commands
3.2.2 Saving and Restoring the Display Keywords:
RECREATE INSTALL
Description:
These commands let you save and restore the graphical view(s) and the forms as displayed before you exit from Design.
NOTE: Forms resized or moved using the cursor will be INSTALLed to their original size. Examples:
RECREATE /DS1
Saves the display definition in file /DS1.
RECREATE /DS1 OVER Saves the display status in file /DS1. Any existing file /DS1 is overwritten. RECRE DISPLAY /DS1 Saves modal settings, e.g. working grid, units, representation etc. Read back in using $M/ name INSTALL SETUP /DS1 Restores the display definition stored in file /DS1 Command Syntax: >-- RECReate --+-- DISPlay --. | | ‘-------------+-- name --+-- OVERwrite --. | | ‘---------------+--> >-- INSTALL SETUP name -->
3.3 The Alpha Display 3.3.1
Saving the Alpha Log
Keywords:
ALPHA LOG
ALPHA FILE
Description:
Lets you save the alpha display information to a text file. Two types of output are available, depending on the command used.
ALPHA LOG enables the contents of either or both of the COMMANDS and REQUESTS alpha regions to be written to a file. ALPHA FILE enables the contents of the REQUESTS regions only to be written to file.
3-2
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
General PDMS Commands
The ALPHA LOG and ALPHA FILE commands may be used to save data such as the results of a data consistency check, or be used as a general output facility. NOTE: After an ALPHA file has been opened, subsequent output will be directed to both
the file and the screen until the file is closed, or until you change to another PDMS module. Examples:
ALP LOG
/LF1 COMMANDS Log information displayed in the COMMANDS region in file /LF1
ALP LOG
/LF1 OVER COMM Log information displayed in the COMMANDS region in file /LF1. Any existing file /LF1 will be overwritten.
ALP LOG
/LF2
ALP FILE
/LF2
ALP LOG END ALP FILE END
Log information displayed in both alpha regions in file /LF2 Log information displayed in REQUESTS region only Finish logging data
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-3
General PDMS Commands
3.3.2 Clearing the Alpha Views Keywords:
ALPHA CLEAR
Description:
Each alpha region may be cleared by using a variation of the ALPHA command.
Examples:
ALPHA COMMANDS CLEAR Clears the text from the COMMANDS region only. ALPHA REQUESTS CLEAR Clears the text from the REQUESTS region only. Command Syntax:
3.4 Leaving Design 3.4.1 Changing Modules You can change to another PDMS module by typing the name of the module. Design automatically saves your work before changing module.
3.4.2
Exit from Design without Saving Changes
Keywords:
QUIT FINISH
Description:
QUIT exits from Design without saving any changes or the display setup. QUIT has the effect of deleting any changes made since the last SAVEWORK, module change or MDB change. FINISH also exits from Design without saving any changes, but in this case you are taken directly to the operating system of your computer.
Examples:
QUIT
Exit from Design (and enter Monitor)
QUIT ISODRAFT
Exit from Design and enter Isodraft
FINISH
Exit from Design to the operating system
Command Syntax:
3-4
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3.5 Setting Working Units and Tolerances These functions let you set the dimensioning units and precision for design placement and element searching operations. The designer can choose at any time to work with metric or imperial units and can differentiate between the units used for nominal pipe bores and for general linear dimensions. Tolerance settings are available for general 3D positioning, plus special tolerance controls for pipe and structural steelwork layouts. A search radius (the ‘hit radius’) can be specified for cursor picking operations.
3.5.1 Setting Working Units Keywords:
MILLIMETRE
MM
INCH
FINCH
Description:
You can choose to work with units for nominal bores and dimensions other than those specified in the Catalogue. The PDMS default is to work in millimetres for nominal bores and distances. However, the Catalogue can contain companyspecific instructions that alter the defaults; say, feet and inches. After the units setting is changed, all input and output will take place in the new units unless specifically stated.
Examples:
MM BORE All bores will be input and output in mm FINCH DIS All distances and coordinates will be input and output in feet and inches UNITS /PERCHES All distances and coordinates will be input and output in the units defined in the units definition element /PERCHES in the Properties Database UNITS DEF Uses the default Catalogue database units UNITS
‘Standard’ PDMS units
NOTE: 3 feet 6 inches must be input as 3’6 when using FINCH units.
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-5
General PDMS Commands
Command Syntax:
>--+-| |-| |-| ‘--
MILlimetre --. | MM ----------| | INch --------| | FInch -------+-- BOres ------. | | ‘-- DIstances --+-->
Gives tolerance and level settings, as well as unit settings
3.5.2 Setting Output Precision of Distance Units NOTE: You must not change the precision if you are customising the AVEVA Applicationware.
You should only use this command if you are writing a completely new application. Keywords:
PRECISION
Description:
Output dimensions, in the current units, are normally rounded to the following degrees of precision: Millimetres
To the nearest mm (e.g. 316)
Inches
To the nearest 0.1 inch (e.g. 38.8)
Feet and inches To the nearest 1/32 inch (e.g. 3’7.15/32) 3’7.15/32)
Output for setting variables defaults to the following, higher, precisions: Millimetres
To two decimal places (e.g. 316.25)
Inches
To two decimal places (e.g. 38.75)
Feet and inches To the nearest 1/64 inch (e.g. 3’7.31/64) 3’7.31/64)
You may control the output precision of distances in some modules by using the PRECISION command. This allows you to specify the number of decimal places for MM or INCH output, or the largest fraction denominator for FINCH output. Precision levels for general output and for the setting of variables are specified separately. To specify the output precision, use the command: 3-6
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
General PDMS Commands
PRECision opt1 DIstance opt2 value opt3
where the command options (opt1, opt2 and opt3) are as follows: opt1 defines how the specified precision is to be applied. It is one of the following: OUTput VARiables
For general dimensions For setting variables
If opt1 is omitted: •
Both Output and Variables are set if opt2 is DEFAULT
•
Output only is set if opt2 is TO
opt2 defines whether you are changing to a newly-defined precision or back to the
default settings. It is one of the following:
TO DEFault If opt2 is omitted, TO is assumed. opt3, which only applies if opt2 is TO, qualifies the number specified by value. The
available choices are:
DECimals DPls THs NDs
Decimal places Decimal places As in 64ths As in 32nds
If opt3 is omitted, value is assumed to apply as follows: •
If current units are MM or INCH:
value is Decimals
•
If current units are FINCH:
value is THs or NDs
Examples:
PREC OUT DI DEF
Set default precision for output
PREC VAR DEF
Set default precision for variables
PREC DI DEF
Set default precision for output and variables
PREC DI 1 DP
Set output to 1 decimal place (MM or INCH units)
PREC OUT DI 4 DEC Set output to 4 decimal places (MM or INCH units)
PREC VAR DI 3 DP Set variables to 3 decimal places (MM or INCH units) PREC DI 64THS
Set output to 1/64 inch precision (FINCH units)
3.5.3 Switching between Actual and Nominal Bores The PRECISION command also allows you to output actual bore dimensions (rather than Nominal bore values) when required. VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-7
General PDMS Commands
To switch to output of actual bore dimensions, use the command: PRECISION BORE ACTUAL
To switch back to using nominal bore values: PRECISION BORE NOMINAL
3.6 Audible Error Trace Keywords:
ALARM
Description:
When a macro error occurs, there is an audible alarm at the workstation to signal that the error has occurred. Occasionally, macro errors can be anticipated and no audible warning is required. This command allows the audible warning to be switched on or off either interactively or via a macro. If the audible warning is ON, it will sound whenever an error alert is displayed. The default setting is ON .
Examples:
ALARM ON
Sets the audible tone to be on.
ALARM OFF
Suppresses the audible tone until it is turned on again.
Command Syntax:
>-- ALARM --+-- ON ---. | | ‘-- OFF --+-->
3.7 Switching Text Output Off Keywords:
TRACE
Description:
This command, applicable in TTY mode only, controls the automatic output of the Current Element name and attributes. When macros are being run, TRACE is always set to OFF automatically.
Examples:
Note:
TRACE OFF
Stops the automatic output of Current Element name.
TRACE ON
Restarts automatic output of Current Element name.
ON is the default setting.
Command Syntax:
3-8
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
General PDMS Commands
>-- TRAce --+-- ON ---. | | ‘-- OFF --+-->
3.8 Giving Operating System Commands from PDMS Keywords:
SYSCOMmand
Description:
PDMS normally assumes that any command input in response to its prompt character (*) is an instruction to the current module, and will check its validity on that assumption. You can issue an operating system (OS) command to the host computer from within PDMS by entering the SYSCOM command followed immediately (without pressing Return) by the OS command enclosed between apostrophes (’) or vertical bars (|). The effect applies only to the single command line; as soon as the OS command has been executed, control is returned to PDMS.
NOTE: Do not try to issue OS commands which might disrupt PDMS operations; for example,
commands which would close or amend files currently in use by PDMS. Examples:
SYSCOM 'dir'
Lists directory from which you entered PDMS.
3.9 General Querying Facilities You will often find, when working in PDMS, that you need to check existing information about some aspect of the program’s operations; for example: •
Current usage in terms of users, modules and DBs.
•
The currently selected output device.
•
•
•
•
The unique code which identifies the process you are running and the station you are running it from (useful for generating unique workfile names). The current setting, perhaps the default setting, of a command option. The contents of part of a particular DB; for example, the current setting of an attribute or the list of member elements owned by a specific element. The elements which match specific selection criteria entered by you.
To ask for such information from within Design, type Query
(almost always abbreviated to Q)
followed by the relevant querying option as described in the following sections. (You also will find more specific querying syntax throughout this set of manuals.)
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-9
General PDMS Commands
3.9.1 Querying Your Current Module To check the version number or revision date of your current module, enter one of the following: Q BANner Q BANner FULL
This will cause PDMS to redisplay the banner which was shown when you first entered Design. For example: Design Mk11.3.1 (WINDOWS-NT 4.0) (29 Feb 2000 : 22.40)
(the FULL option will also display data about the software components used by Design).
3.9.2 Querying Your System To ask about your current MDB, enter Q MDB
To output all valid teams for the current user, enter Q TEAM
To output the current PDMS user name, enter Q USER
To output your login name, enter Q LOGIN/NAME
To output the value of an environment variable, enter Q EVARiable NOTE: If the environment variable name contains any non-letter characters, it must be
enclosed in quotes.
To output information about a file, enter Q FILE
To output information about an open file, enter Q OPENFILE
with the file identified by . The information returned is governed by the attribute which can be:
NAME MODE FULLName
3-10
The name of the file as typed in the OPENFILE Command The mode as given in the OPENFILE command The fully specified filename
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
General PDMS Commands
ENTRY SIZE
The entry name of the file (i.e. without directories) The size of the file in bytes when it was last closed (it does not increase as it is written to)
DTM OWNER LOCK
The date and time the file was last modified The owner (creator) of the file Indicates if the file is locked (valid only for OPENFILE) Type: File, Directory or Other (e.g. a link)
SORT
NOTE: In all the above, environment variables in filenames are always expanded, even for
NAME.
3.9.3 Querying Your Current Output Devices To check the current types of alphanumeric and graphics devices to which Design is expecting to send your output, especially if you have not changed the default settings, enter Q DEVice
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
3-11
General PDMS Commands
To check either type of device separately, enter one of the following: Q DEVice ALPha Q DEVice GRAphics
To check the current settings for your graphics device, enter any of the following (the list is not comprehensive): Gives all logical pen settings Q SETPens Gives setting for logical pen number Q SETPens number Gives line type (dotted, dashed etc.) Q LINESTyle Q COLours or Gives colours of all logical colour numbers Q COLORs Gives colour of logical colour number Q COLours number Q COLours BACKground Gives colour set for display background Q COLours ALPHa
Gives colour set for alphabetic characters and so on.
3.9.4 Querying the Command Implementation Mode To check the current state of the command implementation mode, that is, whether you have Actions On or Off , enter Q ACTions
3.9.5 Asking for a Unique Workstation Code To generate a unique string, based upon your current process and workstation in use, enter Q UNIQueid
This returns a unique string, which is machine dependent. This is useful for generating workfile names that will not clash with names generated by other users.
3.9.6 Querying Elements and Attributes in DBs To check what the current element is, enter Q CE
To check the membership list of the current element, enter Q MEMbers
The members will be listed in the order of their positions in the membership list. To find out which element owns the current element (the inverse of the preceding example), type Q OWNer
3-12
VANTAGE PDMS Design Reference Manual Part 1: General Commands Version 11.6
General PDMS Commands
To ask what types of element may legally be members of the current element, type Q LISt
To ask whether an element exists, type Q EXISTS [] [UPDATE]
The optional lets you check whether the identified element is of a given type. The optional UPDATE can be used to tell you whether the identified element can be updated or not. The responses to this query are:
TRUEA
If you did not specify and the element exists.
TRUE
If you specified and the element exists and is also of the given .
TRUEC
If the element exists and can be updated.
FALSEA
If the element does not exist.
FALSEB
If the element exists but is not of the given .
FALSEC
If the element exists but cannot be updated (if UPDATE was used).
To ask what elements match specified criteria, enter Q ALL