Disclaimer Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law. Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Trademarks AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA or Tribon trademarks is strictly forbidden. AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries, registered in the UK, Europe and other countries (worldwide). The copyright, trade mark rights, or other intellectual property rights in any other product, its name or logo belongs to its respective owner.
About the DESIGN Reference Manual The AVEVA PDMS DESIGN Reference Manual describes all the DESIGN commands in detail. It also describes how the DESIGN database is structured. 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. This manual is written for experienced users of AVEVA 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 Software Customisation Guide and 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 three parts:
1.3
•
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, Utilities, describes the DESIGN Utilities for data consistency checking and clash detection, and for exporting DESIGN data to programs such as Review.
Organisation of this Manual This manual, Part 1, is divided into the following chapters: •
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 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, Display, describes how to control the way the model is displayed in a graphical view.
•
Chapter 5, 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
DESIGN Reference Manual How to Use the Syntax Graphs
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:
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:
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.
DESIGN Reference Manual How to Use the Syntax Graphs
.----<------. / | >---*--- name ----+---> •
2.1
means that you may type in a list of PDMS names, separated by at least one space.
Commands Commands These 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 These are shown in lowercase letters. These are just descriptions of what you need to enter. The most commonly used descriptions are as follows:
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’
DESIGN Reference Manual How to Use the Syntax Graphs
space
The space bar (not usually specified unless of special significance)
name
A sequence of characters preceded representing a PDMS Element name.
by
a
slash/and
For example:
/BRANCH7
/305.ABC
/P4/NOZ
Note: A name should always be followed by a space (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 Software Customisation Reference Manual.
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.
DESIGN Reference Manual How to Use the Syntax Graphs
2.3.1
Mathematical, textual or logical expressions
3D Design points (P-points, pins or P-lines)
or
Axial position
3D position
Axial direction
3D direction
Selection
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 Database Reference Manual. On-line help describing expressions syntax is available from within DESIGN applications.
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
means
2003
04
means
2004
05
means
1905
If no year is given, the default is the current year.
DESIGN Reference Manual How to Use the Syntax Graphs
Examples:
2.3.3
10:30
Assumes current date
22 / 8 / 1999
Assumes time to be 23:59
22 August
Assumes current year and time 23:59
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: •
DESIGN Reference Manual How to Use the Syntax Graphs
| |-| |-| ‘->-+-| ‘->-+-| |-| |-| |-| | | ‘--
| -- -----| | OWNer -----------------| | END -------------------+---> TUBe--. | ROD --+--> 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
specifies that search is to start after given distance in given direction (default is zero);
FROM
specifies reference position from which search is initiated (default is CE).
DESIGN Reference Manual How to Use the Syntax Graphs
Examples:
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 valve to current element in East direction in design model (note that syntax accepts only cardinal directions, which must be entered in full)
CLOSEST VALV EAST
CLOS VALV NORTH FROM E10 Closest valve in North direction starting from given 0 N200 U300 position (valves found before this position are ignored)
2.3.5
D Design Points This syntax describes 3D Design Points and their Attributes. A Design Point is: •
= >--+-- North --. | | |-- Y ------| | | ‘-- South --+-- --> = >--+-- Up ----. | | |-- Z -----| | | ‘-- Down --+-- --> = >--+-- East --. | | |-- X -----| | | ‘-- West --+-- --> = >--+-- WRT --. | | ‘-- IN ---+-- -->
Examples:
2.3.7
E1000
East 1000
Z10
Up 10
E30 D10 S20
East 30 Down 10 South 20
E0 IN SITE
East 0 in Site
D 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)
DESIGN Reference Manual How to Use the Syntax Graphs
| | ‘-- South ---+-->
| | ‘-- West --+-->
= >--+-- Up -----. | | |-- Z ------| | | ‘-- Down ---+-->
= >--+-- --. | | ‘-- value ---+-->
Examples:
2.3.9
E
East
E45N
East 45 North
W-33D
West 33 Up
Y
North
N45E33D
North 45 East 33 Down
N10E10
North 45 East
D 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:
DESIGN Reference Manual How to Use the Syntax Graphs
2.3.10
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 ALL. If you specify more than one criterion, the specifications must be in the above order, as shown by the following graphs: = >-+- ALL -----------------------. | | | .------<-----. | | | | | ‘- -*- -’ | | | ‘----------------+--. | .-----------------<------------------------’ | +- WIth --. | | |- WHere -+- -. | | ‘--------------------+- -. | | ‘------------+- -. | | ‘------------+- -. | | ‘-------------+-->
allows you to specify a volume to be selected: = >-+- WITHIN -----------. | | ‘- EXCLusive WITHIN -+-- VOLume - -+- -. | | | | ‘--------| | | ‘- - TO - -------+->
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 DESIGN Databases and MDBs.
Entering DESIGN or Outfitting Design Keyword: DESIGN , OUTFITTING Description: Use the DESIGN command to enter Plant DESING or in the case of Marine projects use the OUTFITTING command to enter Outfitting Design. These command are available throughout PDMS.
3.2
Saving
3.2.1
Saving DESIGN Work See Database Reference Manual Section 7
3.3
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. 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: Log information displayed in the COMMANDS region in file /LF1
ALP LOG
/LF1 COMMANDS
ALP LOG
/LF1 OVER COMM Log information displayed in the COMMANDS region in file /LF1. Any existing file /LF1 will be overwritten.
ALP LOG ALP FILE
/LF /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
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:
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.
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 company-specific 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. Command Syntax:
>--+-| |-| |-| ‘--
MILlimetre --. | MM ----------| | INch --------| | FInch -------+-- BOres ------. | | ‘-- DIstances --+-->
Gives tolerance and level settings, as well as unit settings
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)
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)
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:
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
For general dimensions
VARiables
For setting variables
If opt1 is omitted: •
Both Output and Variables are set if opt2 is DEFAULT
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
Decimal places
DPls
Decimal places
THs
As in 64ths
NDs
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:
3.5.3
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)
Switching between Actual and Nominal Bores The PRECISION command also allows you to output actual bore dimensions (rather than Nominal bore values) when required. To switch to output of actual bore dimensions, use the command:
PRECISION BORE ACTUAL To switch back to using nominal bore values:
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:
TRACE OFF
Stops the automatic output of Current Element name.
TRACE ON
Restarts automatic output of Current Element name.
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. Example:
SYSCOM 'dir'
3.9
Lists directory from which you entered PDMS.
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.)
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.
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
The name of the file as typed in the OPENFILE Command
MODE
The mode as given in the OPENFILE command
FULLName
The fully specified filename
ENTRY
The entry name of the file (i.e. without directories)
SIZE
The size of the file in bytes when it was last closed (it does not increase as it is written to)
DTM
The date and time the file was last modified
OWNER
The owner (creator) of the file
LOCK
Indicates if the file is locked (valid only for OPENFILE)
SORT
Type: File, Directory or Other (e.g. a link)
Note: In all the above, environment variables in filenames are always expanded, even for NAME.
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 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):
3.9.4
Q SETPens
Gives all logical pen settings
Q SETPens number
Gives setting for logical pen number
Q LINESTyle
Gives line type (dotted, dashed etc.)
Q COLours or Q COLORs
Gives colours of all logical colour numbers
Q COLours number
ives colour of logical colour number
Q COLours BACKground
gives colour set for display background
Q COLours ALPHa
Gives colour set for alphabetic characters and so on.
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 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 is the selection expression. All elements matching your entered selection criteria will be output. For example
Q ALL BRANCH WHERE (HBORE GT 100) FOR /ATEST will output all branches in the element /ATEST which have values greater than 100 for the attribute HBORE. To check the settings of all attributes of the current element, type
Q ATTributes (Any user-defined attributes (UDAs) will be output at the end of the attribute list.) To check the setting of an attribute of a specific element, type
Q ( OF ) For example:
Q (XLEN OF BOX1) To check the settings of specific attributes only, query them by name, thus:
Q Q Q Q Q
XLEngth BORe POSition ORIentation :TESTED( where :TESTED is a UDA)
Display The commands described in this chapter control how the items are displayed in a 3D (Volume) View. For information about creating View windows, see the Software Customisation Guide and the Software Customisation Reference Manual.
4.1
Adding Elements to the Display Keywords: ADD COLOUR Description: Allows selected Design items to be added to the Draw List, which defines which elements are to be displayed. If an element is to be displayed in a colour which is different from the default colour, this can be specified as part of the command line. Items added to the display are added to all volume views with the scale and view direction appropriate to that view. The syntax applies to views attached to a Gobal drawlist. The Draw List can contain significant elements only. The following is a partial list of significant elements as an example: EQUI SUBE DATU GRDM PTRA BOUN BRAN HANG PVOL* RPLA* STRU SUBS SCTN PNOD PALJ PANE (* only if directly below a Site or Zone.) If an element below a significant element (i.e. a primitive) is added, then the whole significant element will be added as well. If an element above a significant element (e.g. a PIPE) is added, then all significant elements owned by that element will be added; not the high-level element itself. Only significant elements (e.g. an EQUI) appear in the drawlist. What appears in the 3D view are all the primitives (e.g. BOX, CYLI, ...) that are owned by the significant element. ADD ONLY will add the significant element to the drawlist but only add the given primitive(s) to the 3D view rather than all the primitives below the significant element.
integer --. | ACTive ---| | VISIble --| | CE -------| | CLASH ----| | OBST -----| | AIDS -----+-->
1 4:2
12.0
DESIGN Reference Manual Display
Querying:
4.1.1
Q DRAW
Queries the contents of the Draw List
Q DRAW COUNT
Queries the number of items in the Draw List
Q DRAW FULL
Queries the contents of the Draw List and the colour with which each Draw List member was added
Q DRAW r COLOUR
Queries the colour number of the referenced item, r. It returns unset if the item is not in the Draw List.
Q DRAW r TRANSLUENCY
Queries the translucency number of the referenced item, r. It returns unset if the item is not in the Draw List.
Selecting Graphics Colours Automatically Keywords: AUTOCOLOUR Description: Lets you define a set of rules for automating the selection of colours for items added to graphical views. Each rule consists of a set of selection criteria for particular types of element, together with an associated colour (which may be an explicit colour number or an expression). When an element is added to the drawlist, the selection rules are scanned in sequence until a rule is found to be true for that element. The element is then added in the colour corresponding to that rule. If the colour is invalid, the search is continued. If no rule is true for the element, the default colour is used. The order in which the rules are set up is significant, since the first rule found to be true determines the colour. Automatic colour selection may be switched on or off as required. If it is on, the colour specified by the rule is used rather than any other colour entered as part of the ADD command. If dynamic autocolouring is specified, the autocolour will be checked every time an attribute is changed and, if necessary, the relevant element will be re-added in the current colour. Each autocolour may be drawn either as a solid colour (default) or as a translucent shade. If using translucency, you can also specify whether or not the edges of an item should be drawn (as in wireline mode) to give a more distinct outline.
Examples:
AUTOCOLOUR ALL EQUI COLOUR 4 All Equipment items to be added in colour 4 AUTOCOLOUR ALL EQUI COLOUR 4 All Equipment items to be added in colour 4 TRANSLUCENCY 25 EDGES ON with 25% translucency and edges drawn. All Branches with head bores greater than 100 to be added in colour 10.
All Sections to be added as defined by the UDA :COLOUR derived via their SpecRefs.
AUTOCOLOUR ALL COLOUR (:COLOUR)
Uses the UDA :COLOUR to denote the colour for all displayed elements. If you enter this as the final rule, it will provide a default colour if all other rules prove false.
AUTOCOLOUR ON
Colours will be chosen according to autocolour rules. If Off (the default), colour specified in the ADD command will be used.
AUTOCOLOUR DYNAMIC ON
Updates autocolour each time an attribute changes. (Use with care!)
AUTOCOLOUR RESET
Clears all current autocolour rules.
AUTOCOLOUR REMOVE 2
Removes the second rule from the current list.
AUTOCOLOUR REORDER 2 TO 4
Moves rule number 2 to position 4 in the list.
Command Syntax: >- AUTOCOLOUR -+- selection_rule - COLOUR - expression -+-> | | | .-----------------------<--------------' | | | '- TRANSLucency - expression -+-> | | | '- EDGES - ON/OFF -> |- ON/OFF -> | |- DYNAMIC - ON/OFF -> | |- RESET -> | |- REMOVE - integer -> | ‘- REORDER - integer1 - TO - integer2 -> Note: The expression for Translucency must be in the range 0-99: the actual translucency will be set to the nearest of 12, 25, 37, 50, 62, 75 or 87 (99 = transparent; 0 = opaque). AUTOCOLOUR ON must be in force to see the effect of AUTOCOLOUR DYNAMIC ON.
Queries colour that would be selected for identified element (this is of most use for batch testing).
Q AUTOCOLOUR FOR id TRANSLUCENCY
Queries translucency setting for identified element.
Q AUTOCOLOUR FOR id EDGES
Queries whether or not edges are to be drawn for identified element (only relevant if translucency is being applied).
Removing Elements from the Display Keywords: REMOVE Description: These commands remove elements from the Draw List and the display.
Examples:
REMOVE ONLY /VESS1N1
removes only nozzle /VESS/N1 from the 3D view
REMOVE /BRANCH1
BRANCH1 will be removed from the Draw List and the display
REM SITE /PIPING
The site /PIPING will be removed
REM ALL
All items in the Draw List, and on the screen, will be removed
Note: If an element below a significant element (i.e. a primitive) is removed, then the whole significant element will be removed as well. To avoid this behaviour the Remove ONLY command should be used. REMOVE ONLY will not remove the significant element but only remove the given primitive from the 3D view (the primitives that have been added/removed can be seen on the primitives tab of the drawlist form). (Note: if the element being added/removed is significant or above a significant element then ADD/REMOVE ONLY will have the same effect as ADD/ REMOVE).
Description: These commands allow colours to be defined so that different types of item in the display may be distinguished by means of colour. Certain items such as current element and active element colours have default settings, but these may also be redefined. The colours may be assigned by using the COLOUR command to define the Red-GreenBlue mix for a colour number or to assign a predefined colour mix by name. DESIGN allows the use of 115 user-definable colours, plus some specific ones which are assigned to items which need to be readily distinguishable in the display. Definitions: •
The Active element is the significant element (and its components) being worked on.
•
The Current Element (CE) is the actual element currently being accessed.
•
The Visible design consists of the design elements which you wish to be displayed (but which you are not currently working on).
•
A Clashing element is an element whose current position and geometry are being tested for interferences against other elements in the design and which has been found to clash (see Design Reference Manual Pt 3: Utilities).
•
An Obstructing element is any of the elements in the design against which a clashing element is being tested for interferences and which has been found to clash (see Design Reference Manual Pt 3: Utilities).
•
An Aid includes tags (markers), axes and other graphical annotations.
The predefined colour mixes which you may specify by name are as follows: Predefined Colour Mixes black
COL 3 MIX RED 50 GRE 50 BLU 5 Colour 3 will change to the specified mix of red, green and blue Sets the colour for displaying active elements to bright red
COL ACTIVE BRIGHTRED
Note: When colours are mixed in their Red, Green and Blue constituents, the command line must contain values for all three constituents in the correct order. The numbers entered for the relative proportions of the basic colours must each be in the range 0100, but they are not percentages of the overall colour and so do not need to add up to 100. Command Syntax: >- COLour -+- integer -. | | |- ACTive --| | | |--AIDS-----| | | |- VISIble -| | | |- CE ------| | | |- CLASH ---| | | ‘- OBST ----+-- colour_name ---> | ‘-- MIX RED integer GREen integer BLUe integer ->
where colour_name is the name of any of the predefined colour mixes listed above. Querying:
>-- Q COLour --+-| |-| |-| |-| |-| |-| ‘--
4.2
integer -----. | CE ----------| | ACTive ------| | VISIble -----| | CLASH -------| | OBST --------| | AIDS --------+-->
Element Representation There are a number of options which determine how items in the graphical display are to be shown on the screen. These are controlled by the REPRESENTATION command.
Setting Tube Representation for Piping Components Keywords: REPRESENTATION TUBE CL (CENTRELINE) Description: The REPRESENTATION command allows tubing to be represented in a centreline or as a solid tube. In some cases, it helps to switch between the two representations to simplify an otherwise complicated view. TUBE and CENTRELINE representation are not instantly updated on the screen. To see the effects of a representation change, use the REPResentation UPDATE command to make any changes visible.
Examples:
REPR TUBE ON CL OFF
Sets tubing representation as solid tube.
REPR CL ON TUBE OFF
Sets tubing representation as centreline.
REPR TUBE ON CL ON
Sets both types of representation on (but centreline will not be visible in colour-shaded mode, as it will be hidden by solid tube).
Description: The REPRESENTATION PROFILE commands allow structural steel profiles to be represented in a centreline or solid profile format. In some cases, it helps to switch between the two representations to simplify an otherwise complicated view. TUBE and CENTRELINE representation are not instantly updated on the screen. To see the effects of a representation change, use the REPResentation UPDATE command to make any changes visible.
Setting Drawing Level Representation Keywords: REPRESENTATION LEVEL Description: This command enables individual drawing levels to be specified for the display of piping, nozzles, structural elements and other design database elements. Every basic primitive shape in the design has an associated drawing level range attribute (for piping and structural steelwork components, these are stored in the Catalogue). If the specified drawing level coincides with this range, the 3D object will be drawn when it is added to the Draw List.
The practical effect of this facility is that it allows you to minimise visible detail when representing Design items. For example, at drawing level 3 steelwork may be represented as single line only, whereas at level 1 the full detail may be visible. Level 3 may well be adequate for design purposes. LEVEL manipulation is not instantly updated on the screen. To see the effects of a level change, use the REPResentation UPDATE command to make any changes visible.
Examples:
REPR LEVEL PIPE 5
Sets piping level to 5. All pipes which are added after this command will be drawn at level 5. Those already in the view will remain unchanged.
Gives units and tolerance settings, as well as representation levels
Setting Obstruction & Insulation Representation for Piping Components Keywords: REPRESENTATION OBSTRUCTION INSULATION TRANSLUCENCY Description: Component Obstructions are often given LEVELS or TUBE and CENTRELINE settings which render them invisible. Setting the Representation of OBST On forces the system to
override normal LEVEL and TUBE settings and show all of the primitives, regardless of the other settings. Setting the Representation of INSU On or Off determines whether or not insulation is shown on primitives. These have the effect of considering all primitives which have an obstruction level greater than zero and all primitives which are affected by insulation parameters. The graphics display is not updated instantly. Use the REPResentation UPDATE command to make any changes visible. To avoid obscuring the view in colour-shaded mode, obstruction and/or insulation can be shown as translucent, the degree of translucency being controllable.
Examples: REPR OBST ON INSU OFF REPR INSU ON REPR INSU ON TRANSLUCENCY 25 Command Syntax: .------------------------------<---------------. / | >- REPResentation -*- OBSTruction -. | | | | ‘- INSUlation --+- ON --+------------------------| | | | | '- TRANSLucency - value -| | | ‘- OFF --------------------------+->
Note: value must be in the range 0-99: the actual translucency will be set to the nearest of 25, 50, 75 or 87 (99 = transparent; 0 = opaque). Querying:
4.2.5
Q REPR
Lists all Representation settings
Q REPR INSU
Queries if insulation is ON or OFF
Q REPR OBST
Queries if OBST is ON or OFF
Q REPR INSU TRANSL
Queries translucency setting for insulation
Setting Obstruction Representation for Steelwork Keywords: REPRESENTATION PROFILE OBSTRUCTION ON/OFF TRANSLUCENCY Description: Structural Steel Obstructions are often given LEVELS or TUBE and CENTRELINE settings, which render them invisible. Setting the Representation of OBST On forces the system to
override normal LEVEL and TUBE settings and show all of the primitives, regardless of the other settings. Setting the Representation of INSU On or Off determines whether or not insulation is shown on primitives. These have the effect of considering all primitives which have an obstruction level greater than zero and all primitives which are affected by insulation parameters. The graphics display is not updated instantly. Use the REPResentation UPDATE command to make any changes visible. To avoid obscuring the view in colour-shaded mode, obstructions can be shown as translucent, the degree of translucency being controllable.
Examples: REPR PROF OBST ON REPR PROF OBST OFF REPR PROF OBST ON TRANSLUCENCY 25 Command Syntax: > REPResentation--PROFile--OBSTruction -+- ON - TRANSLucency - value --. | | ‘- OFF ------------------------+->
Note: value must be in the range 0-99: the actual translucency will be set to the nearest of 25, 50, 75 or 87 (99 = transparent; 0 = opaque). Querying:
Q REPR PROF OBST TRANSL
4.2.6
Queries translucency setting for obstructions
Setting P-Point Representation Keywords: REPRESENTATION PPOINTS LENGTH NUMBERS Description: P-point representation may be set to ON or OFF. The default setting is PPOINTS OFF, although p-points will be shown automatically as part of an identification operation. When p-points are on, they are drawn as small arrows with a cross at the p-point position and with the arrow indicating the p-point direction. The size of the arrow is controlled by the LENGTH option. P-point numbers may also be displayed, as controlled by the NUMBERS option.
As with changes to other representation settings, the graphics display is not updated instantly. Use the REPResentation UPDATE command to make changes to the display of ppoints visible. Examples:
REPR PPOINTS ON
Sets the p-point representation to ON
REPR PPOINTS LENGTH 5
Sets size of p-point arrows
REPR PPOINTS NUMB ON
Shows p-point numbers
Command Syntax: .----------<----------. / | >-- REPResentation --*-- PPoints --+-- ON ---| | | |-- OFF --+--> | |-- LENgth -- value --> | ‘-- NUMbers --+-- ON ---. | | ‘-- OFF --+--> Querying:
Description: These options allow Primary and/or Secondary Nodes on structural steelwork items to be shown on the display in specified colours and sizes. By default, both types of node are shown in the current visible colour, with a size equivalent to 10mm diameter. Examples:
REPR PNOD ON
Only Primary Nodes will be shown in the display.
REPR SNOD OFF
The display of Secondary Nodes will be suppressed.
Setting P-Line Representation Keywords: REPRESENTATION PLINES LENGTH PKEY Description: P-line representation for structural Sections may be set to ON or OFF. The default setting is PLINES OFF. When p-lines are on, the size of the arrow showing their direction is controlled by the LENGTH option. P-line identifiers, in the form of the settings of their PKEY attributes (TOS, BOS, NA, etc.) may also be displayed, as controlled by the PKEY option. As with changes to other representation settings, the graphics display is not updated instantly. Use the REPResentation UPDATE command to make changes to the display of plines visible.
REPR PLINES LENGTH 6 Sets size of p-line arrows REPR PLINES PKEY ON
Shows p-line identifiers (settings of PKEY attributes)
Command Syntax: .---------<----------. / | >-- REPResentation --*-- PLINes --+-- ON ---| | | |-- OFF --+--> | |-- LENgth -- value --> | ‘-- PKEY --+-- ON ---. | | ‘-- OFF --+--> Querying:
Q REPR PLINES
4.2.9
Setting Holes Representation Keywords: REPRESENTATION HOLES Description: Determines the appearance of holes in volume views. ON gives a more realistic view of a hole, with objects behind the hole being visible through it. OFF represents holes as patterned regions on the surface of the component.
Example:
REPR HOLES ON
Sets the holes representation to ON
Command Syntax:
.---------<----------. / | >-- REPResentation --*-- HOLes ---+-- ON ---| | | ‘-- OFF --+--> Querying:
Description: Controls the arc tolerance used when representing certain curves as polygon segments or faceting planes. The smaller the arc tolerance, the smoother the curve drawn, but the slower the graphical performance. The tolerances used for most curve drawing in DESIGN are controlled automatically by the graphical system. The REPRE DARC command controls the following aspects only: Filleted vertices used in the representation of extrusions; for example, Section Profiles from the Catalogue, Panel Loops, etc. Items which include holes (but only when REPRE HOLES is set to On; see Setting Holes Representation). The default setting is 10 mm. The minimum permitted setting is 1mm. Example:
Refreshing the Graphical View Keywords: REPRESENTATION UPDATE Description: Lets you refresh the graphical display, after modifying any of the representation settings, without having to remove and add back all items in the drawlist.
Specifying Axes Keywords: AXES Description: Lets you specify and position a set of axes on the display. The axes represent the compass directions of the World co-ordinate system and may be positioned anywhere on the display. Axes remain visible until they are switched off or deleted. Switching axes off renders them invisible, whilst deletion removes them altogether. Switched-off axes can be made visible again by switching them back on.
Examples:
AXES AT @
Positions a set of axes at the graphics cursor
AXES HEIGHT 300 AT @ Positions a new set of axes at the graphics cursor, with a height of 300mm (default size is 1000mm)
AXES OFF
Removes axes from the screen (although they still exist)
AXES ON
Redisplays axes as previously shown.
AXES DELETE
Deletes axes (i.e. AXES ON will have no effect)
Command Syntax:
.---------<---------------------------. / | >-- AXEs --*-- HEIght value -----------------------| | | |-- AT --------------------------| | | |-- AT POLar DISTance ---' | |-- AT @ ----. | | |-- ON ------| | | |-- OFF -----| | | |-- DELete --| | | ‘------------+----------------------------->
Graphical Labelling of Design Elements Keywords: MARK
UNMARK
Description: This facility allows specific design elements or lengths of Tube to be labelled in the display. Frequently referenced items may be marked with a constant graphic label which will stay with that item even if it is moved or rescaled. Items can also be unmarked (which removes the label). Labels are shown in all permitted regions where the item’s origin is within the current subview. The label always points to the origin or, in the case of a Branch or Hanger, to its Head or Tail (where the name will be suffixed with + or - respectively). You can specify selection criteria for marking, and specify any textual expression for the marker. Examples:
MARK /DATUM5
Element /DATUM5 will be labelled with its name.
UNMARK /DATUM5
The specified element will cease to be labelled.
MARK WITH ’Outer Boundary’ ID @
Labels the picked element with the given text.
MARK WITH NAME ALL BRAN
Labels all Branches with their PDMS names.
MARK WITH NAME OF SPREF ALL VALVE WHERE PBORE GT 100
Labels all valves larger than the specified bore with their specification references in the catalogue.
UNMARK ALL
Removes all marking from the screen.
Command Syntax:
>-- MArk --+-- WITH -- text expression --. | | ‘-----------------------------+-- --> >-- UNMark -- -->
4.5
Using Design Aids Keywords: AID LINE ARROW CEARROW ARC SPHERE BOX CYLINDER
Description: This facility lets you incorporate lines, arrows, arcs, spheres, boxes or cylinders in a view to help you with the design construction. Design aids can be grouped together (using the NUMBER option) and given a number for identification. Aid lines are drawn between two defined 3D positions. The linestyle can be solid, dashed, dotted or dash-dot, and you can label them with text markers at defined positions. Aid arrows are used to complement lines for showing dimensions etc. You can control both the overall height of an arrow and the proportion of its height occupied by the conical arrowhead, thus changing its emphasis. A special aid arrow, the CEArrow, is positioned automatically to point to the current element. You can specify whether the arrow points to the Origin (default), P-arrive or P-leave of the current element. Note: These terms relate primarily to piping components. For other element types, they are interpreted in a logical way. For example, for a SCTN, Origin = P-arrive = POSS, Pleave = POSE; for a PANE, Origin = Vertex 1; for a VERT, Origin = vertex position; etc. Aid arcs are defined in terms of two points at their extremities and either a third 'through' point or a tangent point through which a second-order Bezier curve is constructed. Aid spheres are defined by the position of the centre and the radius. Aid boxes are defined in terms of their position, orientation, and X,Y,Z dimensions. They may be drawn in wireline mode (like penalty volumes or clipping boxes) or in solid mode (like box primitives). Aid cylinders are defined in terms of their position, orientation, diameter and height. They may be drawn in wireline or solid (filled) mode.
Examples:
AID LINE E1200S3500U0 TO E760N1200U50
Draws a line between the two 3D positions.
AID LINE NUMBER 5 E1200S3500U0 TO E760N1200U50 LINESTYLE DOTTED
Groups the new line with other such lines with the same number (5 this example) and draws it in the dotted linestyle.
AID CLEAR LINE 5
Deletes line number 5
AID ARROW AT E760N1200U50 DIR E HEI 100 PROP 0.5
Positions 100mm arrow with given position and direction; arrow head is 50mm long.
AID BOX POS PIN 6 ORI X IS UP Y TOWARDS /PUMP1 XLEN 200 YLEN 200 ZLEN 200 FILL OFF
Positions a wireline cubic box, with 200mm sides, at Pin 6 with the specified orientation.
(Gives next available aid number for specified type)
4.6
Highlighting Components in the Designs Keywords: ENHANCE
UNENHANCE
SOLELY
Description: This facility lets you highlight components visually in the design. For example, all sections of implied tube and rod could be highlighted, all piping components and so on. A particular use of this facility would be to highlight components which fail error checking. The SOLELY keyword clears all previous highlighting before highlighted the defined components. You can also highlight specific lengths of tube or rod.
Examples: Highlights all RED components that match the ENHANCE SOLELY ALL REDU WITH (ABOR GT 10) COLOUR 13 selection criteria with colour 13 (turquoise)
ENHANCE /PIPE1 /PIPE2 COLOUR 5
Highlights PIPE1 and PIPE2 in green
ENHANCE LENGTH 20 OF LEAVE TUBE COLOUR 7
Highlights 20mm of LEAVE TUBE in blue
Command Syntax: >-- ENHANCE --+-- SOLELY ---. .--------------. | | | | ‘-------------+-- --+-- --’ | | | ‘-- COLour -- --. | | +- LENGth - - OF -. | | | | ‘- TOTAl ----------------+- -----+--> Where is:
Spatial Maps Spatial maps of the model are based on the obstruction limit boxes surrounding each Design element, rather than using fully detailed geometric representations. The spatial maps allow faster data access, and they are used for tasks such as clash detection where fast data access is required and where the simplified representation is adequate. Spatial maps are maintained automatically as the design model is updated, but may need to be rebuilt explicitly if the Catalogue data, from which the map geometry is derived, is changed.
Description: You can check one or more of the spatial maps to ensure that they accurately reflect the current state of the design. To avoid spurious results, it is advisable to do this before carrying out a clash check. This is particularly important if the geometry of any geometry elements has been modified.
Examples:
MAP CHECK MDB
Checks the spatial maps for all DESIGN DBs within the current MDB against the current design and catalogue data. If there are any discrepancies, appropriate messages are output; you should then rebuild the map (see Creating or Updating Spatial Maps)
MAP CHECK PIPES/AREA1 Checks the up-to-date status of the spatial map for the named DESIGN DB only. Command Syntax: >--- MAP CHEck ---+--- MDB -------------------------------. | | | .-----------<---------. | | / | | ‘--- word ---*--- name --+-- word ---’ | | | ‘--------------+---> where word and name define the full name of a current DESIGN DB.
4.7.2
Creating or Updating Spatial Maps Keywords: MAP BUILD Description: Lets you update existing spatial maps to take into account all design and catalogue changes which have taken place. This is only necessary if the MAP CHECK command (Checking the Spatial Maps) shows that the map is out of date.
Examples:
MAP BUILD MDB
Updates the spatial maps for all DESIGN DBs within the current MDB.
MAP BUILD STEEL/AREA2 Updates the spatial map for the DB STEEL/AREA2. Command Syntax:
DESIGN Reference Manual Interacting with a Graphical View
5
Interacting with a Graphical View Note: The commands described in this chapter should not be used very often. Most of the functionality they provided has been superseded by Event-driven Graphics, and they are included here for compatibility with earlier versions of PDMS.
5.1
Identifying Displayed Items and Points A displayed element from the visible model can be accessed directly by moving the cursor over it and clicking the left-hand mouse button. The following sections describe the different ways of selecting database elements from the display by using the cursor. These commands let you use the visible design in order to move to elements in the DESIGN hierarchy and points in 3D space. In each case, an appropriate prompt is displayed.
5.1.1
Identifying Displayed Elements using the Cursor Keywords: IDENTIFY Description: If a particular type of element is to be located, a selective search can be made using the IDENTIFY command followed by a keyword identifying the element type. If a specific element type is not requested, the element hit will always be a geometric primitive or component. Any displayed line or p-point of an item may be hit. To abort, press the Cancel button on the displayed form.
Examples:
ID @
Pressed Enter (or Return), move the cursor over the desired item and click the left-hand mouse button. The name of the element under the cursor is displayed on the command line. The picked element becomes the current element and is displayed in a different colour. (This is the general response to all variations of the IDENTIFY command.)
ID EQUIP @
As above, but the search is restricted to EQUI elements.
Identifying Tube using the Cursor Keywords: IDENTIFY TUBE Description: Variable length Tube (and Rod) from the visible design can be accessed by picking with the cursor. As Tube is not an element in the DESIGN hierarchy, it cannot be accessed. Instead, the component on the upstream side of the Tube (downstream if routing backwards) will be accessed. This means that the next component to be created will be inserted in the picked Tube. Any visible Tube can be picked regardless of whether it is shown in single or double line representation.
Example: The name of the component on the upstream side of the Tube under the cursor is displayed on the command line.
ID T @
Command Syntax:
>-- IDentify Tube @ -->
5.1.3
Identifying Displayed Points using the Cursor Keywords: IDPPOINT
PPOINT
Description: The cursor can be used to pick any p-point in the visible design or any mapping pin. This form of picking will not change the current element. Note: IDPPOINT cannot be used in isolation. It must be used with another command. Only those p-points which are defined in the Catalogue as being visible in DESIGN will be available for picking in this way.
DESIGN Reference Manual Interacting with a Graphical View
Example:
Q IDP @
Press and hold down left-hand mouse button when cursor is over element. Element will be highlighted with p-points visible and cursor will change to a square shape. With left-hand mouse button still held down, move cursor over required p-point. When over a p-point, cursor will change to a square shape with crosshairs. Release the button to select the p-point
CONnection --------------. | BORe --------------------| | OD ----------------------| | POSition ---. | | | DIRection --| | | | East -------| | | | X ----------| | | | West -------| | | | North ------| | | | Y ----------| | | | South ------| | | | Up ---------| | | | Z ----------| | | | Down -------| | | | GRADient ---| | | | BOP --------| | | | TOP --------+-- --| | | ‘------------+-->
1 5:3
12.0
DESIGN Reference Manual Interacting with a Graphical View
5.1.4
Identifying Items with a 2D Pick Use a working plane in preference to this older functionality. Keywords: TWODPLANE TWODPICK Description: This facility lets you define a plane which is normal to the view direction. You can then use the cursor to pick a point in an orthogonal view such that the third coordinate of the required point is derived automatically from this plane. The TWODPLANE command defines the 2D picking plane in terms of a point within the plane. The AT TWODPICK @ command may then be used to request a cursor position which identifies a point within the 2D picking plane. The plane is generated dynamically from the TWODPLANE point and the view direction.
Examples:
TWODPLANE E 1000 N 2000 U 500
Defines 2D picking plane which passes through given point and which is normal to view direction
AT TWODPICK
Using the preceding 2D picking plane definition, a cursor hit at E 1234 N 5678 in a plan view will return the position E 1234 N 5678 U 500 in World coordinates
Note: Cursor positions are always returned in World coordinates. In order to obtain the correct result, the 2D picking plane must therefore be set to an absolute World position. Command Syntax:
>-- TWODPLane -- --> >-- AT TWODPick @ --> Querying:
>-- Q -- TWODPLane -->
5.2
D Pins The Design pins are a set of ten temporary marker points which have a 3D position and direction. They can be moved around using positioning and orientation commands similar to those available for permanent Design elements. Once positioned, a pin may either be used as a static reference point or as a temporary ppoint. The commands described here only show how to make pins visible and position and orientate them. Once this has been done they can be used for positioning and orientating Design elements in any command that uses point as an argument.
DESIGN Reference Manual Interacting with a Graphical View
5.2.1
Setting a Pin’s Position and Direction Explicitly Keywords: PIN AT DIRECTION Description: The position and direction of a pin can be set explicitly in the same way as an ordinary design element. Unless stated otherwise, the positional parameters described below are in the coordinate system of the current element.
Examples:
PIN 5 AT E1000
Pin 5 will be moved to the coordinate position East 1000 from the Site origin.
PIN5 DIR W WRT SITE
Pin 5 will be orientated in a direction West with respect to the current SITE.
>-- Q PIn integer POSition --+-- --. | | ‘------------+--> >-- Q PIn integer DIRection --+-- --. | | ‘------------+-->
5.2.2
Making a Pin Visible Keywords: PIN Description: This command allows a particular pin to be switched in and out of the Display. When a pin is visible, it will be drawn as a numbered arrow marker which indicates its position and direction in each volume view. Visible pins can be hit with the cursor during any IDPPOINT operation. When a pin is switched off, it is erased from the display, but it still exists and can be referred to by name.
DESIGN Reference Manual Interacting with a Graphical View
Examples:
PIN 5
Pin 5 will be drawn into all volume views, and can be hit by the cursor.
PIN 5 OFF
Pin 5 will be erased.
Command Syntax:
>-- PIn integer ----+-- OFF --. | | ‘---------+--> Querying: (As in previous subsection.)
5.2.3
Locating a Pin by Copying or Connecting Keywords: PIN COPY CONNECT Description: A pin’s position and direction can be set by copying or connecting to any other p-point or pin, the only difference being that the CONNECT operation orientates the specified pin in the opposite direction (see examples below). Examples:
PIN 5 C0PY IDP @
Pin 5 will be placed at the same position and orientation as the p-point or pin hit by the cursor.
PIN 5 CONNECT TO PH
Pin 5 will be placed at the Branch Head, but pointing in the opposite direction to HDIR (Head direction). This command must be given at BRANCH level. Pin 5 can be an existing pin or a new one.
Command Syntax: >-- PIn integer --+-- Copy --------------. | | ‘-- CONnect --+-- TO --| | | ‘--------+-- --> Querying: >-- Q PIN integer --+-- POSition ---. | | ‘-- DIRection --+-- WRT --. | | |-- IN ---+--