You are on page 1of 217

Plant Design System (PDS)

Equipment Eden Interface

Version 2011 (V12)


June 2011
DPDS3-PB-200041F

Copyright
Copyright 1984-2011 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret
law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph
Corporation.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813

Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the
licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license
for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this
software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee
permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and
delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or
redistribution.

Warranties and Liabilities


All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or
its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in
this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms
of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS
TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Convert, I-Export, I-Sketch, SmartMarine, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation
and/or its affiliates. MicroStation is a registered trademark of Bentley Systems Inc, all rights reserved. Other brands and product
names are trademarks of their respective owners.

Contents
Preface PDS ................................................................................................................................................. 9
What's New in Equipment Eden Interface ............................................................................................... 11
The Eden Basics ........................................................................................................................................ 13
Equipment Symbol Processor............................................................................................................... 13
Tutorial Definition Table ........................................................................................................................ 17
Forms Interface ..................................................................................................................................... 22
Eden Language Structure ......................................................................................................................... 23
Beginning Statements ........................................................................................................................... 23
Ending Statements ................................................................................................................................ 24
Begin............................................................................................................................................... 24
Begin EQP Category ...................................................................................................................... 25
Variables ............................................................................................................................................... 26
Local Variables ............................................................................................................................... 27
Global Variables Common to Piping, Equipment, and Pipe Support Modeling ............................. 28
Global Variables Common to Equipment and Pipe Support Modeling .......................................... 29
Global Variables (EQP Specific) .................................................................................................... 30
Subscripted Global Variables ......................................................................................................... 30
Common Keywords ............................................................................................................................... 31
TYPE Statement ............................................................................................................................. 32
DESCRIPTION Statement ............................................................................................................. 32
Comments ............................................................................................................................................. 33
Operators .............................................................................................................................................. 33
Arithmetic Operators....................................................................................................................... 33
Relational Operators ....................................................................................................................... 34
Logical Operators ........................................................................................................................... 34
Expressions ........................................................................................................................................... 34
Replacement Statements ............................................................................................................... 35
Call Statement ................................................................................................................................ 35
Do While Statement........................................................................................................................ 36
Indexed Do Statement .................................................................................................................... 36
If - then - else Statement ................................................................................................................ 37
Functions ............................................................................................................................................... 37
Primitives ............................................................................................................................................... 38
Convert NPD to Subunits ............................................................................................................... 40
Define Active Orientation ................................................................................................................ 40
Draw Cone ...................................................................................................................................... 41
Draw Cylinder ................................................................................................................................. 42
Draw Eccentric Cone ...................................................................................................................... 43
Draw Projected Rectangle .............................................................................................................. 44
Draw Projected Triangle ................................................................................................................. 45
Draw Semi-Ellipsoid ....................................................................................................................... 46
Draw Sphere ................................................................................................................................... 47
Draw Torus ..................................................................................................................................... 47
Abort ............................................................................................................................................... 48

Plant Design System (PDS) Equipment Eden Interface

Contents
Convert Unit .................................................................................................................................... 48
Define Active Point ......................................................................................................................... 49
Define Datum Point ........................................................................................................................ 49
Define Library ................................................................................................................................. 50
Define Nozzle ................................................................................................................................. 51
Define Orientation By Points .......................................................................................................... 52
Define Placepoint ........................................................................................................................... 53
Define Point .................................................................................................................................... 54
Display Message ............................................................................................................................ 55
Display Tutorial ............................................................................................................................... 55
Draw Arc ......................................................................................................................................... 57
Draw Complex Surface................................................................................................................... 58
Draw Con Prism ............................................................................................................................. 60
Draw Curve ..................................................................................................................................... 61
Draw Ecc Prism .............................................................................................................................. 61
Draw Ecc Transitional Element ...................................................................................................... 62
Draw Ellipse .................................................................................................................................... 63
Draw Line ....................................................................................................................................... 64
Draw Line String ............................................................................................................................. 64
Draw Proj Hexagon ........................................................................................................................ 65
Draw Proj Octagon ......................................................................................................................... 66
Draw Proj Shape ............................................................................................................................ 67
Draw Rectangular Torus................................................................................................................. 68
Draw Revolved Shape .................................................................................................................... 69
Draw Shape .................................................................................................................................... 70
Draw Transitional Element ............................................................................................................. 71
Get Arc Points ................................................................................................................................ 71
Get Arc Size ................................................................................................................................... 72
Get Date ......................................................................................................................................... 73
Get EQP Category.......................................................................................................................... 73
Get Line Size .................................................................................................................................. 74
Get Point ......................................................................................................................................... 74
Move Along Arc .............................................................................................................................. 76
Move Along Axis ............................................................................................................................. 77
Move Along Line ............................................................................................................................. 77
Move By Distance ........................................................................................................................... 78
Move Data ...................................................................................................................................... 79
Move To Placepoint ........................................................................................................................ 79
Place COG ..................................................................................................................................... 80
Position Cursor ............................................................................................................................... 81
Put Field ......................................................................................................................................... 81
Read Table ..................................................................................................................................... 82
Retrieve Nozzle Parameters .......................................................................................................... 83
Rotate Orientation .......................................................................................................................... 84
Start Complex Shape ..................................................................................................................... 84
Stop Complex Shape...................................................................................................................... 85
Store Orientation ............................................................................................................................ 86
Store Nozzle Parameters ............................................................................................................... 86
User Function ................................................................................................................................. 87
Creating a New Equipment Component .................................................................................................. 97
Setup for Equipment ............................................................................................................................. 97
Default Project Control Data ................................................................................................................. 98

Plant Design System (PDS) Equipment Eden Interface

Contents
Extracting Sample Modules .................................................................................................................. 99
Editing Modules................................................................................................................................... 100
Compiling New Modules ..................................................................................................................... 100
Revising Modules ................................................................................................................................ 101
Basic Use of Forms ............................................................................................................................. 101
Input Fields.......................................................................................................................................... 102
System-Defined Field Numbers .......................................................................................................... 102
Application Commands ....................................................................................................................... 103
User-Defined Application Commands ................................................................................................. 103
System-Defined Application Commands ............................................................................................ 103
Additional Features of the Form Interface .......................................................................................... 104
Defining Symbols .................................................................................................................................... 107
Eden Debugger ........................................................................................................................................ 111
Invoking the Debugger ........................................................................................................................ 111
Exiting the Debugger .......................................................................................................................... 111
Concurrent Display ............................................................................................................................. 112
Debugger Commands ......................................................................................................................... 112
Switch Modes (ON and OF) ......................................................................................................... 112
Set Line Break (B) ........................................................................................................................ 113
Call Tutorial (C) ............................................................................................................................ 113
Deposit Global (DG) ..................................................................................................................... 114
Deposit Local (DL) ........................................................................................................................ 114
Examine Local Variables (EL) ...................................................................................................... 114
Examine Global Variables (EG) ................................................................................................... 115
Examine Symbol Name (ES) ........................................................................................................ 116
Examine Source File Segments (TYPE) ...................................................................................... 116
Move to Specific Source Line or Continue (Go) ........................................................................... 117
Step through Source Code (S) ..................................................................................................... 117
Step into User Function (SI) ......................................................................................................... 117
Switch the Prompt Terminal (P) ................................................................................................... 118
Appendix: Codelist (CL330).................................................................................................................... 119
Appendix: Equipment Data Definition ................................................................................................... 125
Equipment Group Database Table ..................................................................................................... 126
Equipment Nozzle Database Table .................................................................................................... 126
Appendix: EQP Eden Program Examples ............................................................................................. 129
Example 1 (Use of loops) .................................................................................................................... 129
Example 2 (Use of arrays and loops) ................................................................................................. 130
Example 3 (Placing nozzles) ............................................................................................................... 130
Example 4 (Use of character string variables) .................................................................................... 131
Example 5 (Graphic selection commands) ......................................................................................... 131
Example 6 ........................................................................................................................................... 132
Example 7 ........................................................................................................................................... 132
Example 8 ........................................................................................................................................... 133
Example 9 ........................................................................................................................................... 133
Example 10 (Insulation Graphics) ....................................................................................................... 137

Plant Design System (PDS) Equipment Eden Interface

Contents
Appendix: Delivered Parametrics .......................................................................................................... 139
Circular Platform (A001) ..................................................................................................................... 141
Miscellaneous Platform (A003) ........................................................................................................... 143
Holes for Platforms (A015) .................................................................................................................. 145
Holes for Miscellaneous Platforms (A016) .......................................................................................... 147
Thru Ladder A (A021) ......................................................................................................................... 149
Thru Ladder Details (A029) ................................................................................................................. 150
Side Ladder A (A031) ......................................................................................................................... 152
Side Ladder Details (A039) ................................................................................................................. 153
Stairs A (A041) .................................................................................................................................... 154
Handrail A (A051)................................................................................................................................ 156
Davit A (A061) ..................................................................................................................................... 157
Davit B (A063) ..................................................................................................................................... 159
Define (E200) ...................................................................................................................................... 160
Define Weights (E201) ........................................................................................................................ 161
Complex Vertical Cylindrical Equipment, Skirt (E205) ........................................................................ 163
Simple Vertical Cylindrical Equipment, Skirt (E210) ........................................................................... 165
Simple Vertical Cylindrical Equipment, Legs (E215) .......................................................................... 167
Spherical Equipment (E230) ............................................................................................................... 169
Complex Horizontal Cylindrical Equipment (E240) ............................................................................. 170
Simple Horizontal Cylindrical Equipment (E245) ................................................................................ 172
Horizontal Shell and Tube Exchanger (E305) .................................................................................... 174
Kettle Exchanger (E307) ..................................................................................................................... 176
Vertical Shell and Tube Exchanger (E310) ......................................................................................... 178
Exchanger Ends (E319) ...................................................................................................................... 180
Double Pipe Exchanger (E320) .......................................................................................................... 181
Plate Exchanger (E325) ...................................................................................................................... 183
Air Cooler (E330) ................................................................................................................................ 185
Induced Draft Air Cooler Bay (E332) .................................................................................................. 186
Forced Draft Air Cooler Bay (E334) .................................................................................................... 188
Horizontal Rotating Equipment and Driver (E405) .............................................................................. 189
Vertical Rotating Equipment and Driver (E410) .................................................................................. 191
E1 Ends (E905) ................................................................................................................................... 193
E2 Ends (E906) ................................................................................................................................... 194
E3 Ends (E907) ................................................................................................................................... 195
Complex Vertical Cylindrical Equipment (N205) ................................................................................. 196
Simple Vertical Cylindrical Equipment (N210) .................................................................................... 197
Simple Vertical Cylindrical Equipment (N215) .................................................................................... 197
Spherical Equipment (N230) ............................................................................................................... 198
Complex Horizontal Cylindrical Equipment (N240)............................................................................. 198
Simple Horizontal Cylindrical Equipment (N245) ................................................................................ 199
Horizontal Shell and Tube Exchanger (N305) .................................................................................... 199
Kettle Exchanger (N307) ..................................................................................................................... 200
Vertical Shell and Tube Exchanger (N310) ........................................................................................ 200
Double Pipe Exchanger (N320) .......................................................................................................... 201
Plate Exchanger (N325) ...................................................................................................................... 201
Air Cooler (N330) ................................................................................................................................ 202
Horizontal Rotating Equipment and Driver (N405) ............................................................................. 202
Vertical Rotating Equipment and Driver (N410) .................................................................................. 203
Gear Cover (U850) ............................................................................................................................. 203
Round Torus Miter (U860) .................................................................................................................. 204
Rectangular Torus Miter (U861) ......................................................................................................... 206
Vertical Oval Torus Miter (U862) ........................................................................................................ 207

Plant Design System (PDS) Equipment Eden Interface

Contents
Flat Oval Torus Miter (U863) .............................................................................................................. 208
Flat Oval Prism (U870) ....................................................................................................................... 209
Flat Oval Torus (U880) ....................................................................................................................... 210
Rectangular 90 Cone Torus with Offset (U881) .................................................................................. 212
User Projected Shape (USRPRJ) ....................................................................................................... 213
Index ......................................................................................................................................................... 215

Plant Design System (PDS) Equipment Eden Interface

Contents

Plant Design System (PDS) Equipment Eden Interface

Preface PDS
This document provides command reference information and procedural instructions for the Plant
Design System (PDS) Equipment Eden Interface task.

List of PDS Documentation

DPDS3-PB-200003 - DesignReview Integrator (PD_Review) Reference Guide


DPDS3-PB-200004 - Drawing Manager (PD_Draw) User's Guide
DPDS3-PB-200005 - EE Raceway Modeling Reference Guide
DPDS3-PB-200006 - Interference Checker/Manager (PD_Clash) User's Guide
DPDS3-PB-200010 - PDS 3D Theory User's Guide
DPDS3-PB-200013 - PDS EDEN Interface Reference Guide Volume I : Piping
DPDS3-PB-200015 - PDS Equipment Modeling (PD_EQP) User's Guide
DPDS3-PB-200017 - PDS ISOGEN Reference Guide, Vol. 1
DPDS3-PB-200022 - PDS Piping Component Data Reference Guide
DPDS3-PB-200023 - PDS Project Setup Technical Reference
DPDS3-PB-200025 - PDS Stress Analysis Interface (PD_Stress) User's Guide
DPDS3-PB-200026 - Pipe Supports Modeler Reference Guide
DPDS3-PB-200028 - Piping Design Graphics (PD_Design) Reference Guide
DPDS3-PB-200030 - Project Administrator (PD_Project) Reference Guide
DPDS3-PB-200033 - Project Engineer HVAC (PE-HVAC) Reference Guide
DPDS3-PB-200034 - Reference Data Manager (PD_Data) Reference Guide
DPDS3-PB-200035 - Report Manager (PD_Report) User's Guide
DPDS3-PB-200041 - PDS EDEN Interface Reference Guide Volume 2 : Equipment
DPDS3-PB-200042 - PDS EDEN Interface Reference Guide Volume 3 : Pipe Supports
DPDS3-PE-200016 - PDS Express Project Creation Quick Start Guide
DPDS3-PE-200052 - PDS Ortho Draw User's Guide
DPDS3-PE-200029 - Piping Model Builder (PD_Model) Reference Guide
DPDS3-PE-200031 - Project Engineer HVAC Getting Started Guide
DPDS3-PE-200032 - Project Engineer HVAC Overview
DPDS3-PE-200045 - PDS Label Library Merger Utility
DPDS3-PE-200047 - PDS Reference Data Auditing Tool
DPDS3-PE-200048 - Pipe Supports Explorer Utility
DPDS3-PE-200050 - Batch Services Quick Start Guide
DPDS3-PE-200051 - Batch Services User's Guide

Plant Design System (PDS) Equipment Eden Interface

10

Plant Design System (PDS) Equipment Eden Interface

What's New in Equipment Eden Interface

What's New in Equipment Eden Interface


The following changes have been made to the Equipment Eden Interface:
Version 2011 (V12)
No changes were made for this release.

Plant Design System (PDS) Equipment Eden Interface

11

SECTION 1

The Eden Basics


Eden is a high-level symbol definition language modeled on the FORTRAN programming
language that allows you to design your own symbols for equipment, piping, instrumentation, and
specialty items.
The Eden language syntax is not case sensitive. You can write code with whatever case
conventions make it easiest for you to read. While you do not need a programming background to
write Eden programs, any programming experience is highly recommended.
Most of the symbol definition functions are built into Eden's command structure. This high-level
command structure makes it easier to share code among several different symbol definitions.
Eden is flexible enough to allow you to design codes specific to your company's needs, yet offers
predefined subroutines, called primitives, which carry out functions often repeated within symbol
definitions.
For example, the following primitive draws a cone with a length of X units, a diameter at the active
point (first end) of Y units and a diameter at the opposite end of Z units:
Call Draw_Cone (X, Y, Z)
The output produced will look similar to the following graphic:

You can call up to five nested subroutines within a program.

Equipment Symbol Processor


The symbol processor is the Eden code that defines an equipment component. It calls all the
subroutines or modules that activate forms, check input data, assign placement points, and place
graphics.
The first line of an Eden module defines the module name. The following statement is used in the
Eden modules to indicate a symbol processor module:
Symbol_Processor 'MODULE NAME'
The module name should be entered using UPPER CASE characters. For example:
Symbol_Processor 'APUMP'
The following example symbol processor defines a horizontal pump:

Plant Design System (PDS) Equipment Eden Interface

13

The Eden Basics


SYMBOL_PROCESSOR 'E405'
!
#TYPE =Pumps,All equip
#DESC =Hor Rot Equip & Driver
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! E405 : Horizontal Rotating Equipment and Driver
!
! APPLICATION COMMAND
! 4075 - HELP (SPECIFIC)
! 4074 - HELP (GENERAL)
! 4073 - DEFINE
! 4072 - DEFINE CG
! 4051 - RETURN (from help menu)
! 4052 - UPDATE DATE
!
! SYSTEM DEFINED COMMAND USED
! 4001 - EXIT
! 4002 - ACCEPT
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
INT2 accepted
LOCATION pointzero [3]
!
pointzero = POINT_0
Dimension [100] = 0.0
accepted = 0
tutname = 'E405'
Cstring [29] = 'E405'
Call Get_Date( Cstring [38] )
!
Do While ( accepted .EQ. 0 )
Call Display_Tutorial ( tutname )
Call Put_Field( Cstring [29], 19 )

14

Plant Design System (PDS) Equipment Eden Interface

The Eden Basics


If( LAST_INP_TYPE .EQ. USER_KEYIN ) then
If( LAST_INP_NUM .GE. 2 .AND. LAST_INP_NUM .LE. 18 ) then
Call User_Function ( 'E405_CHECK' )
accepted = Dimension [100]
Else
accepted = 0
Endif
Else
If( LAST_INP_TYPE .EQ. APPLICATION_CMD ) then
if( LAST_INP_NUM .eq. 4075)then
Call Display_Tutorial ( 'H405' )
accepted = 0
else
if( LAST_INP_NUM .eq. 4074)then
Call Display_Tutorial ( 'H200A' )
accepted = 0
else
If( LAST_INP_NUM .eq. 4073)then
Call User_Function ('E200')
accepted = 0
Else
If( LAST_INP_NUM .eq. 4072)then
Call User_Function ('E201')
accepted = 0
Else
If( LAST_INP_NUM .eq. 4052 )then
Call Get_Date( Cstring [1] )
accepted = 0
Else
accepted =1
Endif
Endif
Endif
Endif
endif
else
accepted = 1
Endif
Endif
Enddo
!
! define PLACE POINTS and DATUM POINTS
Call Define_Active_Orientation ( NORTH, UP )
Call Define_Placepoint ( PP1, POINT_0 )
Call Define_Datum_Point ( DP [1], POINT_0)
offset = Dimension [4] + Dimension [11]
Call Move_Along_Axis ( - offset, SECONDARY )
Call Define_Placepoint ( PP2, POINT_0 )
Call Define_Datum_Point ( DP [2], POINT_0)
! Draw base plate

Plant Design System (PDS) Equipment Eden Interface

15

The Eden Basics


base_length = Dimension [1]
base_width = Dimension [2] + Dimension [3]
base_thickness = Dimension [4]
offset_base = 0.5 * Dimension [1] + Dimension [5]
offset_norm_base = 0.5 * base_width - Dimension [3]
Call Move_To_Placepoint (PP2)
Call Move_Along_Axis ( offset_base, PRIMARY )
Call Move_Along_Axis ( offset_norm_base, NORMAL )
Call Rotate_Orientation ( 90.0, NORMAL )
If( base_length .gt. 0.0 .and. base_width .gt. 0.0 .and. base_thickness
.gt. 0.0 ) then
Call Draw_Proj_Rectangle ( base_length, base_width, base_thickness )
Else
Call Abort (0)
Endif
! Draw driver
driver_length = Dimension [6] + Dimension [7]
driver_width = Dimension [8] + Dimension [9]
driver_thickness = Dimension [10] + Dimension [11]
vert_offset_driver = - Dimension [11]
horiz_offset_driver = 0.5 * driver_length - Dimension [6]
norm_offset_driver = 0.5 * driver_width - Dimension [9]
Call Move_To_Placepoint (PP1)
Call Move_Along_Axis ( vert_offset_driver, SECONDARY )
Call Move_Along_Axis ( horiz_offset_driver, PRIMARY )
Call Move_Along_Axis ( norm_offset_driver, NORMAL )
Call Rotate_Orientation ( 90.0, NORMAL )
If( driver_length .gt. 0.0 .and. driver_width .gt. 0.0 .and.
driver_thickness .gt. 0.0 ) then
Call Draw_Proj_Rectangle ( driver_length, driver_width, driver_thickness
)
Endif
! Draw shaft
Call Move_To_Placepoint (PP1)
Call Move_Along_Axis ( Dimension [7], PRIMARY )
If( Dimension [12] .gt. 0.0 .and. Dimension [13] .gt. 0.0 ) then
Call Draw_Cylinder ( Dimension [12], Dimension [13] )
Endif
! Draw housing
house_length = Dimension [14]
house_width = Dimension [15] + Dimension [16]
house_thickness = Dimension [17]
vert_offset_house = - Dimension [11]
horiz_offset_house = 0.5 * house_length + Dimension [12] + Dimension [7]
norm_offset_house = 0.5 * house_width - Dimension [16]
Call Move_To_Placepoint (PP1)
Call Move_Along_Axis ( vert_offset_house, SECONDARY )
Call Move_Along_Axis ( horiz_offset_house, PRIMARY )
Call Move_Along_Axis ( norm_offset_house, NORMAL )
Call Rotate_Orientation ( 90.0, NORMAL )
If( house_length .gt. 0.0 .and. house_width .gt. 0.0 .and. house_thickness
.gt. 0.0 ) then
Call Draw_Proj_Rectangle ( house_length, house_width, house_thickness )
Endif

16

Plant Design System (PDS) Equipment Eden Interface

The Eden Basics


! define CGs
Call Move_To_Placepoint ( PP1 )
Call Place_Cog (DRY, Dimension [71], Dimension [72], Dimension [73])
Call Place_Cog (OPERATING_1, Dimension [74], Dimension [75], Dimension
[76])
Call Place_Cog (OPERATING_2, Dimension [77], Dimension [78], Dimension
[79])
Call Move_To_Placepoint ( PP2 )
STOP
END

Tutorial Definition Table


You can create or modify tutorial definition tables using an ASCII editor. The first line in a tutorial
definition table defines the tutorial name. This entry must begin in column 1.
Each input field in a tutorial must have a corresponding row in a tutorial definition table. Each row
includes seven entries: field number, data type, global variable, nozzle number, input attribute,
default string, and field name.
1.

field number

The tutorial field number defining the form (gadget number).

2.

datatype

The data type of the field. This entry is a number whose values include:

3.

number

1=

linear dimension

2=

angular dimension

3=

integer (no units)

4=

length for NOZ_LENGTH1

5=

length for NOZ_LENGTH2

6=

length for NOZ_RADIUS

7=

equipment entity database attribute

8=

nozzle entity database attribute

9=

field to receive values for CSTRING_x variables

A table data entry which the system interprets differently for each data
type:
For data types 1, 2, and 3, number is a value that can range from 1 to
100 defining the global variable DIMENSION_n, which holds the fields
input. For example, if number is set to 10 in the table, then any input
into the field is placed by the software into DIMENSION_10. The
symbol can then refer to DIMENSION_10 and use it in any of its
calculations. For data types 4, 5, and 6, this field is ignored.
For more information on the Equipment Modeling DDL, refer to
Appendix: Equipment Data Definition (on page 125).
For data types 7 and 8, number defines the attribute number in the
appropriate database entity to which the field inserts input. These
numbers provide the link to the database.

Use the following numbers for the respective attribute:

Plant Design System (PDS) Equipment Eden Interface

17

The Eden Basics


equip_group ( datatype = 7 )
1 , equip_indx_no , integer
2 , equip_no , character(30)
3 , equip_descr_1 , character(40)
4 , equip_descr_2 , character(40)
5 , tutorial_no , character(6)
6 , equip_class , character(2)
7 , dry_weight , double
8 , oper_weight_1 , double
9 , oper_weight_2 , double
10 , insulation_thk , double
11 , construction_stat , short
, standard note 130
12 , equipment_division , short
, standard note 69
13 , approval_status , short , standard note 35
14 , insulation_purpose , short , standard note 220
equip_nozzle ( datatype = 8 )
1 , nozzle_indx_no , integer
2 , nozzle_no , character(10)
3 , equip_indx_no , integer
4 , nominal_piping_dia , short
5 , rating
, character(8)
6 , preparation
, short , standard note 330
7 , piping_mater_class , character(16)
8 , unit_no
, character(12)
9 , fluid_code , short , standard note 125
10 , unit_code
, character(3)
11 , line_sequence_no , character(16)
12 , heat_tracing_reqmt , short , standard note 200
13 , heat_tracing_media , short , standard note 210
14 , insulation_purpose , short , standard note 220
15 , insulation_thk , double
16 , table_suffix , short
, standard note 576
17 , service , character(20)
18 , schedule_thickness , character(8)
19 , nor_therm_growth_X , double
20 , nor_therm_growth_Y , double
21 , nor_therm_growth_Z , double
22 , alt_therm_growth_X , double
23 , alt_therm_growth_Y , double
24 , alt_therm_growth_Z , double
25 , construction_stat , short , standard note 130
For example, if the data type is 7 and number is 1, then any input to this field is put in the
equipment entity, attribute number 1 (or equipment name) field of the record that is
written to the database when the component is placed. Refer to the model database
DDL for a complete description of each attribute in both the equipment and nozzle
entities.
For data type 9, number specifies the CSTRING variable to receive the value.

18

Plant Design System (PDS) Equipment Eden Interface

The Eden Basics


4.

nozzle

A number that identifies the nozzle with which a field will be


associated. This field is only needed for data types 4, 5, 6, and 8. Each
nozzle in a parametric symbol must be assigned a unique umber.
(Refer to the DEFINE_NOZZLE and the
RETRIEVE_NOZZLE_PARAMETERS primitives.) This number is the
same as the RETRIEVE_NOZZLE_PARAMETERS primitive. Each
nozzle in a parametric requires a set of fields for defining the nozzle
size, rating, facing, tag, possibly length, and possibly other database
attributes. The nozzle number allows the software to distinguish one
nozzle tag input field or one nozzle size input field from another.

5.

attributes

An entry that describes the input field itself. The available values for
this item include:
1-

User input is optional.

2-

User input is required.

3-

User input is optional but causes return to the symbol.


This type of field has also been called a terminated key-in
field. Refer to the DISPLAY_TUTORIAL primitive for
more information on how to handle these fields from the
symbol.

4-

User input is required but causes return to the symbol.


This is also a terminated key-in field.

Example:
A tutorial has a field for which the attribute entry in the tutorial definition
table contains the number two. You are not allowed to select the
ACCEPT field to exit from the tutorial until you have provided a valid
input for the field.
6.

default

An entry allowing you to define a default for a particular tutorial input


field. The entry can take on several forms. All of the expressions
outlined below must be surrounded by single quotes in the tutorial
definition table.
The default types include:
"XXX-"

A literal string used for defaulting character string input


fields.
The double quote must be included as a delimiter.
Example:
"101-C"

Fxxx-

Use the current value of tutorial field number xxx as the


default for this field. Note that user-defined field numbers
can range from 1 to 200. (System-defined fields range
from 201 to 256 and may not appear in default
expressions.) Example: F23

Plant Design System (PDS) Equipment Eden Interface

19

The Eden Basics


Dxxx-

Use the contents of DIMENSION_xxx as the default for


this field. There is no practical limit on the number of
tutorials that a symbol can activate. Therefore, any
calculations that were made before the symbol definition
activated the current tutorial can provide defaults for that
tutorial. Example: D23

Cxx-

Use the contents of CSTRING_xx as the default for this


field.

xx.x-

Decimal constant with or without a decimal point. All


distances are assumed to be in English subunits
(inches). If the default is a metric constant, then the
constant should be given a suffix of M. Example: 125M

expr-

Combine any of the above three default types to form a


valid arithmetic expression. Valid operators are +, -, *, /,
and . Use parentheses to alter order of evaluation. An
expression is not evaluated until all fields are defined.
Example: (F1+F2)/2+30. This expression is not
computed until both fields 1 and 2 are defined.

Default expressions are currently limited to 20 characters in length.


Example:
101-C - default for an equipment item name field
Example:
F1/2+10 - use the first input to field 1 divided by 2 plus 10 inches as
the default.
7.

name

Defines an alphanumeric name for the field which will be used in future
software releases for reporting and alphanumeric placement of
parametrics. The field name can be a maximum of 10 characters in
length.
The gadget numbers 1-10 (Column 1 - Field) in the tutorial definition table correspond to gadget
numbers 951-960 on the form.
1 = 951
2 = 952
3 = 953
4 = 954
5 = 955
6 = 956
7 = 957
8 = 958
9 = 959
10 = 960
Gadget numbers 11, 12, 13 ... remain 11, 12, 13 ....

Example
The following example tutorial definition table displays a piece of equipment with 7 dimensional
inputs (rows 1-7), 4 nozzles (rows 11-26), and 3 fields for equipment entity database attributes
(rows 8-10).

20

Plant Design System (PDS) Equipment Eden Interface

The Eden Basics


EXCHNG
1, 1, 1, , 1, 30, DIA
2, 1, 2, , 1, , NOZ1
3, 1, 3, , 1, F2, NOZ2
4, 1, 4, , 1, , NOZ3
5, 1, 5, , 1, , SUPP1
6, 1, 6, , 1, , SUPP2
7, 1, 7, , 1, , PROJ
8, 7, 1, , 1, , EQPNAM
9, 7, 2, , 1, , DESCR
10, 7, 5, , 1, "C", CLASS
11, 8, 1, 20, 1, , TAG1
12, 8, 3, 20, 1, , SIZE1
13, 8, 4, 20, 1, , RATING1
14, 8, 5, 20, 1, 21, FACING1
15, 8, 1, 19, 1, , TAG2
16, 8, 3, 19, 1, F12, SIZE2
17, 8, 4, 19, 1, F13, RATING2
18, 8, 5, 19, 1, 21, FACING2
19, 8, 1, 18, 1, , TAG3
20, 8, 3, 18, 1, , SIZE3
21, 8, 4, 18, 1, , RATING3
22, 8, 5, 18, 1, 21, FACING3
23, 8, 1, 17, 1, , TAG4
24, 8, 3, 17, 1, F20, SIZE4
25, 8, 4, 17, 1, F21, RATING4
26, 8, 5, 17, 1, 21, FACING4

In the tutorial above, the default value for field 1 on the tutorial is 30 inches.
Since the default value for field 3 is F2, your first input to field 2 is displayed in field 3 by the
system.
Since the second column is equal to 1 for fields 1 through 7, they are all linear dimension
inputs. Your input into these fields is placed in variables DIMENSION_1 through
DIMENSION_7.
Field 8 collects your equipment ID (equipment entity, attribute number 1). In general, it is
easier to place the symbol if the equipment ID field is put directly on each tutorial.
There is a set of four fields on the tutorial for each nozzle defined in the parametric (tag, size,
rating, end prep). This is the minimum number of fields that can be present to allow complete
definition of a nozzle. If you do not define the nozzle tag for a particular nozzle, then that
nozzle will not be placed.
Nozzle tag numbers cannot be defaulted.
Since there is no field on the tutorial that explicitly collects individual nozzle lengths, the
symbol logic must calculate them.
Each nozzle has a default end prep of 21 (nozzle entity, attribute number 5). This is a
code-listed attribute in the database. The value 21 is the codelist value for a raised face. The
default expression can also be entered as "RFFE", which is the codelist text for raised face
end prep.

Plant Design System (PDS) Equipment Eden Interface

21

The Eden Basics

Forms Interface
Forms in equipment modeling serve to collect input via key-in fields or command buttons. They
also provide feedback information to the user through message fields.
Input fields and application commands have unique identification numbers. These numbers are
used with the tutorial definition table (TDF) to communicate to the software the use for each field
or command. The data entered through the forms serves as the input that defines the values of the
global variables used by the symbol processor. When a new equipment item is defined through
Eden, a form has to be created to define the component's parameters. DBAccess is used to build
forms.

22

Plant Design System (PDS) Equipment Eden Interface

SECTION 2

Eden Language Structure


Eden is similar to the FORTRAN programming language. Therefore, the general rules for
evaluating expressions in Eden are identical to those in FORTRAN.
You do not need to know FORTRAN to use the Eden language.
Eden definitions are usually simpler than FORTRAN programs. To use Eden, you must be able to
visualize the symbol (in 3D) that you want to develop.
The Eden language structure incorporates:
Statements
Beginning
Ending
Variables
Local
Global
Keywords
Operators
Arithmetic
Relational
Logical
Expressions
Functions
Primitives (or Subroutines)

Beginning Statements
Beginning statements define the types of modules being entered. Names within the single quotes
must be all upper case.
SP - Symbol_Processor '6CHAR'
UF - User_Function_Definition '28CHAR'

Examples
Symbol_Processor 'A001'
User_Function_Definition 'A001_CHECK'

Plant Design System (PDS) Equipment Eden Interface

23

Eden Language Structure

Ending Statements
Ending statements mark the end of the module in which the system has been processing. Ending
statements in the symbol and subsymbol processor include:
Stop
End
Ending statements in the user functions include:
Return
End

Begin
The Begin primitive allows you to generate graphics for 2D shadow, envelopes, various light steel
categories, and holes.

Syntax
Call Begin <category>

Options
category

Keyword specifying the graphics category you want to place. Allowable


category keywords for each class of graphics include:
Regular equipment graphics
EQUIPMENT

This is executed at the beginning of symbol execution.


It is needed if you have placed some other category
and want to resume equipment graphics.

Interference envelope graphics


ENVELOPE_MAINTENANCE_HARD
ENVELOPE_MAINTENANCE_SOFT
ENVELOPE_ACCESS_HARD
ENVELOPE_ACCESS_SOFT
ENVELOPE_SAFETY_HARD
ENVELOPE_SAFETY_SOFT
ENVELOPE_CONSTRUCTION_HARD
ENVELOPE_CONSTRUCTION_SOFT
2D footprint graphics
SHADOW
Light steel graphics
LADDER
PLATFORM
HANDRAIL
MISCELLANEOUS
Holes

24

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


HOLE
NOHOLE

The keywords HOLE and NOHOLE are different from


other keywords in that they do not represent a
separate category of graphics. You can include
Begin(HOLE) within another Begin category. A
Begin(HOLE) remains in effect across other Begin
calls until a Begin(NOHOLE) is reached. Hole
graphics are given the level and symbology of holes.

Surface Type
SOLID
SURFACE

The keywords SOLID and SURFACE set the active


surface type of subsequent graphics. The default is
SOLID. This results in capped surfaces. With the
SURFACE keyword, you can place uncapped shapes
such as open-ended cylinders.

Except for nozzles and placepoints, all graphics assume the level and symbology of the last
executed Begin statement. Placepoints always belong to the equipment/parametric cell. If your
symbol executes no EQUIPMENT category graphics, an otherwise empty parametric equipment
cell is created for housing the placepoints.
A Begin statement can repeat itself any number of times. After execution, it becomes the active
category for subsequent element placement calls. A (non-EQUIPMENT) Begin statement must
be followed by at least one call to generate graphic elements; otherwise, that Begin statement will
have no effect on symbol graphics.

Begin EQP Category


The Begin EQP Category primitive allows you to create graphics for various EQUIPMENT
subcategories each having its own level and symbol.

Syntax
Begin_EQP_Category (subcategory)

Options
subcategory

is a character string indicating the subcategory. There are presently 20


subcategories available. A valid subcategory must be one that has been
defined via the Project Administrator Module. Alternatively, you can use
one of the following:
EQP_CATEGORY_1,
EQP_CATEGORY_2,
..
..
..
EQP_CATEGORY_20
The argument is checked only when you place the symbol and not
during compilation.

Restrictions
You can use this call only within the Begin (EQUIPMENT) call. Also, you cannot make this call
when Draw Complex Surface or Start Complex Shape is in progress. By default, the Begin

Plant Design System (PDS) Equipment Eden Interface

25

Eden Language Structure


(EQUIPMENT) and Begin EQP Category ('EQP_CATEGORY_1') calls are active when a symbol
executes.

Example

The following example is a valid code fragment:


Call Begin (ENVELOPE_MAINTENANCE_HARD)
.. ! place envelope graphics
..
Call Begin (EQUIPMENT) ! to set category next
Call Begin_EQP_Category ('PUMPS') ! 'PUMPS' must be a valid
! category for project
Call Draw_Complex_Surface (4, 0)
.. ! pump graphics
..
Call Begin (HOLE) ! HOLE is allowed anywhere
..
..
Call Draw_Complex_Surface (-99, 0) ! end pump

The following example is not a valid code fragment:


Call Begin (LADDER)
Call Begin_EQP_Category ('PUMPS') ! Begin (EQUIPMENT) not active
..
..

This example is not a valid code fragment:


Call Draw_Complex_Surface (4, 0)
Call Begin_EQP_Category ('PUMPS') ! cannot change within surface

Variables
Variables in Eden can be either local or global. They can contain either numeric or alphanumeric
data. Internally, numeric data is stored as REAL*8 (double precision). If a different data type is
required in the context of an expression, then the conversion is performed at the time the
expression is evaluated.
Variable names can be either upper or lower case. Symbols tend to be easier to read when
you use all lower case for local symbols and all upper case for global symbols or vice versa.

Examples

When converting a floating point number to an integer, the fractional part of the floating point
number is truncated.
A variable used in a logical expression evaluates to TRUE when the value of the variable is 1
and 0 when the logical value is FALSE.
Variables that hold values representing distances are assumed to be in subunits. A variable
containing the value 25 represents 25 inches in an English unit design file and 25 millimeters
in a metric unit design file.
Be careful when using hard coded numbers or when using the system_of_units variable.

26

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Local Variables
Local variables are user defined and declared in the symbol definition. You can refer to a local
variable only when you are in the same module as the local variable.
Local variable names are formed using alphanumeric (a-z), numeric (1-9), and special (_ and $)
characters. They must begin with an alphanumeric character and must be less than or equal to 31
characters in length.
The Eden compiler does not verify the spelling of local variables within call statements.
It assumes a null value for the misspelled variable at component placement time.
The Eden language refers to constants as local variables. Both character strings and numeric
constants are valid; however, character string constants must be surrounded by single quotes. In
most cases, character strings and constants are case sensitive. Thus, a and A are interpreted
differently.

Examples
diameter

13.25

shell_thickness

'A TEXT STRING'

projection_1

radius [2]

25
Only in Pipe Support and Equipment Modeling can you declare local variable types. The variable
types default to either CHARACTER or REAL depending on the context. To override this default,
you can use a local variable type declaration statement anywhere before the variable(s) is (are)
actually referenced. Variable types INT2, R8, and LOCATION are recognized by the compiler.

Example
In the following example, variables a, B, and C are declared as type short integers. They hold
values ranging from -32767 to 32767.
Int2 a
Int2 B, C

Example
In the example below, variable d is declared as a type REAL, capable of holding decimal fractional
values. This is the usual default type for numeric variables. However, explicit typing to this
category may be necessary to declare local arrays.
R8 d
As a recommendation, all declaration statements should be placed at the very beginning of the
symbol code and not interspersed among statements to be executed during symbol placement.
This improves program readability.
Also in Pipe Support and Equipment Modeling, referencing a variable using subscripts is
extremely useful when coding repetitive statements such as the body of a loop. Prior to use,
variables must appear in a type declaration in which its subscript or index range is also specified.

Example
In the example below, D is an array of 5 short integer variables stored contiguously. The individual
elements are referenced as D[1], D[2], D[3], D[4], and D[5]. You can also use a variable or an
arithmetic expression for indexing, such as D[i] where i is a value between 1 and 5, or D [i+1]

Plant Design System (PDS) Equipment Eden Interface

27

Eden Language Structure


where i is a value between 0 and 4. INT2-typed variables are particularly useful in DO loops and
array indexing where integral numbers are necessary and roundoffs must be avoided. They are
also stored much more efficiently than REAL variables.
Int2 D[5], EF[6]

Example
Below, LENGTHS is an array of 10 REAL variables. They are referenced as LENGTHS [1] ...
LENGTHS [10].
R8 LENGTHS [10]

Example
In the following example, PT is declared as a buffer with four locations.
Location PT [12]
where
PT [1], PT [4], PT [7] PT [10] are x-coordinates
PT [2], PT [5], PT [8] PT [11] are y-coordinates
PT [3], PT [6], PT [9] PT [12] are z-coordinates
These variables provide alternate locations for the point values that you do not want to store in
POINT_1 ... POINT_24... POINT [125]. You will also find them useful in accessing individual
components of a location. (Refer to the REPLACEMENT STATEMENT section.)
Location PT [12]
An array-formatted variable may also be referenced without the index. In this case, the first
element of the array is accessed. For example, PT and PT [1] are functionally the same in the
above example.
Currently, only single expression subscripts (that is, single dimensioned arrays) are possible.

Global Variables Common to Piping, Equipment, and Pipe


Support Modeling
Global variables are system-defined names allowing you to refer to them at any subroutine level.
More specifically, you can use them for passing values between subroutine levels or for
communicating input values to the symbol. The following list shows the global variables common
to all Eden applications. Refer to the application-specific section for detailed information
concerning specific global variables.
Global variables are system-defined. You cannot declare global or subscripted global
variables.

28

Input_n

(Input_1 through Input_20) An array with up to 20 variables used to


define the input parameters for table lookups. (Input_11 through
Input_20 are specifically designed for user function arguments in
equipment and pipe support modeling.)

Output_n

(Output_1 through Output_20) An array with up to 20 variables


where the results of the table lookup are stored. (Output_11 through
Output_20 are specifically designed for user function return
arguments in equipment and pipe support modeling.)

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


Dimension_n

(Dimension_1 through Dimension_100 for equipment and pipe


supports, Dimension_1 through Dimension_20 for piping) General
purpose variables used for communicating input to the symbol
logic. You can also use these variables for passing values between
subroutines or simply for local storage. (Dimension_20 is for angle;
Dimension_1 through Dimension_19 is for linear piping.)

Pr_Rating_n

Variable containing the current item pressure rating value.

Nom_Pipe_D_n

Variable containing the current item nominal pipe diameter. This


variable contains the nominal diameter in coded units. A special
primitive is provided to help you convert from coded units to
subunits.

Gen_Type_n

Variable containing the current item end preparation generic type


(BLT, MAL, FEM). This is a read-only variable.

Term_Type_n

Variable containing the current item end preparation termination


type (21, 22, and 23 will fall into Term_Type_1=20). This is a
read-only variable.

Standard_Type

Variable containing the current item standard type value. This is a


read-only variable and is a function of TABLE_SUFFIX.

Global Variables Common to Equipment and Pipe Support


Modeling
The following list contains global variables common to Equipment and Pipe Support Modeling. For
more information on global variables, refer to the System-defined Subroutines section and the
Eden User Interface section.
Point_n
Point [n]

(Point_1 - Point_24) Names representing points that have been


defined or saved for later use in a symbol definition. The n in [n]
can be between 0 and 125.

Act_Lib

Variable that contains an identifier for the active library of


dimension tables. This is a read-only variable.

Cstring_n

(Cstring_1 through Cstring_40) Names representing global


character variables. Each name can contain a maximum of 50
characters.

Last_Inp_Type
Last_Inp_Num

Refer to the Display_Tutorial primitive in the Eden Primitives


section.

NPD_Unit_Type

Contains the nominal piping diameter system of units defined for


the model file. You can test this variable against the keywords
ENGLISH and METRIC. This is a read-only variable.

Plant Design System (PDS) Equipment Eden Interface

29

Eden Language Structure

Global Variables (EQP Specific)


The following list contains global variables specific to Equipment Modeling. For more information
on global variables, refer to the System-defined Subroutines section and the Eden User Interface
section.
PP_Location_n

(PP_Location_1 - PP_Location_10) Names representing the


point locations that have been defined as place points in the
course of a symbol definition.

End_Prep

Variable containing the current nozzle end preparation value.

Noz_Length1

Variable containing the current nozzle length value. This variable


applies to type 2 and 3 nozzles only. For type 3, the length is
from the end of the nozzle connected to the vessel to the
centerline of the bend.

Noz_Length2

Variable containing the current second nozzle length value. This


variable applies to type 3 nozzles only and measures the length
from the face of the nozzle to the centerline of the bend.

Noz_Radius

Variable containing the current nozzle bend radius. Applies to


type 3 nozzles only.

Table_Suffix

Variable containing the current nozzle table suffix value.

PP_Primary_n

(PP_Primary_1 through PP_Primary_10) Names representing


orientation of primary axes for place points defined during
symbol placement.

PP_Secondary_n

(PP_Secondary_1 through PP_Secondary_10) Names


representing orientation of secondary axes for place points
defined during symbol placement.

PP_Normal_n

(PP_Normal_1 through PP_Normal_10) Names representing


orientation of normal axes for place points defined during symbol
placement.

Subscripted Global Variables


In Equipment and Pipe Support Modeling, a global variable can contain an index value as part of
the variable name even though the index value is not a variable. This is known as subscripted
global variables. For example, Dimension_10 and Point_3 are global variables whose index
values are 10 and 3, respectively.
You can reference the same location using subscripted global variables, which contain an index
either as a variable or as an expression. For example, Dimension [10] and Point [3] are
subscripted global variables whose index values are 10 and 3, respectively. They are equivalent
to Dimension_10 and Point_3. Subscripted global variables are useful when using loops. Below is
a list comparing the two methods of accessing global variables with indexes:

30

Subscripted Global Variable (variable


index)

Global Variable with non-variable index

cstring [1] ... cstring [40]

cstring_1 ... cstring_40

dimension [1] ... dimension [100]

dimension_1 ...dimension_100

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


dp [1] ... dp [30]

dp1 ... dp30

inputs [1] ... inputs [20]

input_1 ... input_20

outputs [1] ... outputs [20]

output_1 ... output_20

pp [1] ... pp [10]

pp1 ... pp10

point [0] ... point [125]


(point [0] ... point [24]

point_0 ... point_24)

pp_primary [1] ... pp_primary [10]

pp_primary_1 ...pp_primary_10

pp_secondary [1] ... pp_secondary [10]

pp_secondary_1 ...pp_secondary_10

pp_normal [1] ... pp_normal [10]

pp_normal_1 ... pp_normal_10

pp_location [1] ... pp_location [10]


pp_location_1 ...pp_location_10
A global variable referenced without a subscript causes the first element to be accessed. Thus,
Point and Point [0], Dimension and Dimension_1 are functionally equivalent.

Common Keywords
Eden uses keywords for labeling specific values or groups of values. All keywords except TRUE
and FALSE can appear as arguments in system-defined primitives (or subroutines). Keywords
can be upper or lower case. For consistency, this reference guide displays keywords in upper
case.
TRUE

Logical true. Used in logical expressions.

FALSE

Logical false. Used in logical expressions.

MALE
FEMALE
BOLTED

Keywords for generic end preparation.

PRIMARY
SECONDARY
NORMAL

Keywords used to identify or refer to individual refresh tee axes.

ENGLISH
METRIC

Names used to define the units of a constant used in the symbol


definition.

ACTIVE_POINT
POINT_0

Name representing the location of the active point in the local


coordinate system defined by the symbol. These names can be
used interchangeably.

EAST
WEST
NORTH
SOUTH
UP
DOWN

Keywords used to define directions in the local coordinate


system defined by the symbol definition.

PP1 - PP10

Names representing symbol place point locations and


orientations. A maximum of 10 place points can be defined for 1
symbol.

Plant Design System (PDS) Equipment Eden Interface

31

Eden Language Structure


DP1 - DP30

Names representing equipment datum point locations and


orientations.

SYMBOL_PROCESSO Module type of all equipment modeling Eden definitions. It is


R
used in the first statement of a symbol definition.
ENG_COMM_LIB
EQP_TABLES

Names representing the different libraries that can be made


active in a symbol definition.

RETURN
STOP

Terminates module execution normally. If it encounters either a


RETURN or STOP in a user function, the system returns control
to the calling module.

END

Must be the last line in the symbol source code. If execution


reaches the END statement, an implicit STOP is executed.
There are other keywords primarily used in specific subroutine calls. These keywords can be
found in the subsections that describe their associated primitives. Keywords APPLICATION_CMD
and USER_KEYIN are described under the DISPLAY_TUTORIAL primitive. Keywords such as
PT_BORE and COG_TYPE are explained under the GET_POINT and PLACE_COG primitives,
respectively.

TYPE Statement
TYPE statements allow you to assign up to 150 labels or types to a symbol. The syntax for the
TYPE statement is:
#TYPE = Type 1, Type 2, Type 3, ... , Type n
where
Type 1 ... Type n

Labels representing types under which the


symbol will be classified.
Using each type, you can later inquire on the symbol. (Refer to the PDS Equipment Modeling
(PD_EQP) Reference Guide for information on Parametric Help.)
A type label can be up to 28 characters long. The compiler automatically left justifies each type
and converts it to upper case. You can enter any number of complete type labels that fit in a line.
Multiple TYPE statements are allowed. A TYPE statement can appear anywhere in the source
code; however, the # character must appear in column 1.

Example
The following TYPE statement appears in the code for a multi-diameter vertical vessel supported
on skirt.
#TYPE = tower, vertical vessel, drum, reactor

DESCRIPTION Statement
The DESCRIPTION statement assigns a descriptive phrase of up to 40 characters to the symbol.
This description appears next to the symbol name when you inquire on the symbol library from the
PDS Equipment Task. (See the PDS Equipment Modeling (PD_EQP) Reference Guide for
information on Parametric Help.)
The syntax for the DESCRIPTION statement is:
#DESC = This is a description

32

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


A DESCRIPTION statement can appear anywhere in the symbol code. The description string is
placed left justified by the compiler. When more than one DESCRIPTION statement appears, only
the last statement is used. The # character must appear in column one.

Comments
When you place an exclamation point (!) anywhere in an Equipment Modeling source line, the
remainder of that line is treated as a comment.

Example
Call define_placepoint (PP1, POINT_1)

! POINT_1 is used to
! define place point 1

Operators
Operators are used in conjunction with variables to form expressions. As in FORTRAN, operators
can be any one of three types:
1. Arithmetic
2. Relational
3. Logical

Arithmetic Operators
Arithmetic operators are used to form arithmetic expressions. These operators follow the
mathematical conventions. Valid arithmetic operators include:
+

addition

subtraction

multiplication

division

**

exponentiation

//

concatenation using '_'

||
concatenation without using '_'
The first five operators (+, -, *, /, **) can only be used with numeric local and global variables. The
concatenation operators (// , || ) can be used with both numeric and string variables.
The concatenation operator // is used primarily to form table names. It joins two variables together
with an underbar (_) character. The result is a text string.

Example
'ABC' // 'DEF'
produces
'ABC_DEF'
When using the concatenation operation, real numbers are converted to integers (that is,
truncated), then converted to character strings and finally joined together with the underbar
character. The concatenation operation is generally used to form messages and character field
outputs.

Plant Design System (PDS) Equipment Eden Interface

33

Eden Language Structure

Relational Operators
Relational operators are used to form relational expressions that test the value of an Eden
expression or establish conditions under which a group of Eden statements can be executed.
Valid relational operators include:
.EQ.

equal to

.NE.

not equal to

.GE.

greater than or equal to

.GT.

greater than

.LE.

less than or equal to

.LT.

less than

Periods must appear before and after the expression.


Relational operators can be used on both numeric and character string variables. However,
mixing the two types of operands for a given operation produces computing errors.
In character relational expressions, less than means precedes in the ASCII collating sequence,
and greater than means follows in the ASCII collating sequence.
'ABCD' .LT. 'ACCD'
If two strings in a relational expression are not the same length, the shorter one is padded on the
right with spaces until the lengths are equal.
'PQRSTU' .EQ. 'PQR '
'PQRSTU' .EQ. 'PQR '

Logical Operators
Logical operators are used to combine relational expressions into more complex logical
expressions. Valid logical operators include:
.OR.

logical or

.AND.

logical and
Periods must appear before and after the expression.

Expressions
Expressions are variables, constants, and operators combined to make statements. The format of
most Eden expressions is the same as in FORTRAN. Valid expressions include:

34

Replacement

simple arithmetic replacement

Call

executes primitives or subroutines

Do while

execute loop

Indexed Do

execute loop

If - then - else

conditional execution

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


For every IF statement, there must be an ENDIF statement to end the expression. You can
nest up to five If-then-else expressions within an Eden module.
For the Replacement, Do while, and If-then-else expressions, you can use parentheses to alter
the precedence of calculation.

Replacement Statements
Replacement statements are used to set variables or perform calculations. The following list
illustrates the various Replacement statements:
thickness = 25.
vessel_od = DIMENSION_1
test = test + 1
tutor_name = 'EXCH1'
table_name = 'BLT' // GEN_TYPE // PR_RATING // '5'
dim_a = (dim_b + dim_c) * 2. + dim_d
In Equipment and Pipe Support Modeling, all three components of a point (or location variable)
can be replaced by another point value with one assignment statement.

Example
In the following example, PT is declared as a buffer of three points. The second statement saves
pt [4], pt [5], pt [6] into global location Point_5. In the third statement, the location value stored in
point [2] is saved in a PT buffer, the x-coordinate being assigned to pt [7], y to pt [8], and so forth.
Likewise, in the last statement, the POINT_3 components are replaced by those of Point_4 in one
aggregate operation.
Location pt [9]
.
.
point [5] = pt [4]
.
.
pt [7] = point_2
.
.
point_3 = point [4]

Call Statement
Call statements are used to execute system primitives. The syntax for the Call statement is:
call "primitive" or "subroutine" (argument 1, argument 2, ...)

Example
Call Place_Cylinder_With_Capped_Ends (diameter, length)
Call Define_Placepoint (PP1)

Plant Design System (PDS) Equipment Eden Interface

35

Eden Language Structure

Do While Statement
The Do While statement is used to form indefinite loops. The condition of a Do While statement
must equal a logical value (either true or false). The body of the Do While statement will be
repeatedly executed as long as the logical expression remains true.

Example
The following Do While loop places four cylinders end to end. The pretested loop condition fails on
the fifth try (if i equals 4), and control transfers to the message display routine.
i = 0
do while (i .LT. 4)
i = i + 1
Call Draw_Cylinder_With_Capped_Ends (diam, leng)
enddo
Call Display_Message ('Out of loop now')

Indexed Do Statement
The Indexed Do statement allows you to form loops that execute a specified number of times. This
number is determined by an initial, a terminal, and an incremental parameter of a control variable.
The syntax for the Indexed Do statement is:
do V = v1, v2, v3
.
.
.
enddo
where
V

is a control variable (non-string type)

v1
v2
v3

are constants or variables that evaluate to the initial, terminal, and incremental
parameters respectively. v3 is optional. If v3 is omitted, the system assumes
that the incremental parameter is one.
V3 cannot be negative.

Example
In this example, I is set to 1. The body of the loop is then executed. I increments by 2 each time the
cycle is complete, and the value 3 is checked against the terminator 20. The iteration continues as
long as I is less than or equal to 20. When the iteration is greater than 20, the loop ends.
do I = 1, 20, 2
.
.
.
enddo

36

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

If - then - else Statement


If - then - else statements are used when a group of statements is to be conditionally executed.
The Eden syntax is the same as FORTRAN syntax.
if (condition) then
.
.
.
else
.
.
.
endif

Example
if (DIMENSION_1 .gt. 24.) then
thk = thk + .125
else
thk = thk + .250
endif
An If statement of the form if (condition) is not valid. In Eden, all If statements must be of the
form If (condition) then. The else statement is optional.

Functions
Eden provides several functions for performing common mathematical operations. These
functions can be used within replacement statements.
The following functions must contain the parentheses.
DSQRT () square root
DABS () absolute value
DSINR () sine of an angle in radians
DCOSR () cosine of an angle in radians
DTANR () tangent of angle in radians
DSIND () sine of an angle in degrees
DCOSD () cosine of an angle in degrees
DTAND () tangent of an angle in degrees
DASINR () arcsine returned in radians
DACOSR () arccosine returned in radians
DATANR () arctangent returned in radians
DASIND () arcsine returned in degrees
DACOSD () arccosine returned in degrees
DATAND () arctangent returned in degrees

Example
The following list illustrates a few possible Eden functions:
length = hypot * DSIND (30.)

Plant Design System (PDS) Equipment Eden Interface

37

Eden Language Structure


side = DTANR (pi/2) + 32.
hypot = DSQRT (a**2 + b**2)
angle = DATAND (side1/side2)

Primitives
Primitives are system-defined routines that perform specific functions for symbol definition.
Convert NPD to Subunits (on page 40)
Define Active Orientation (on page 40)
Draw Cone (on page 41)
Draw Cylinder (on page 42)
Draw Eccentric Cone (on page 43)
Draw Projected Rectangle (on page 44)
Draw Projected Triangle (on page 45)
Draw Semi-Ellipsoid (on page 46)
Draw Sphere (on page 47)
Draw Torus (on page 47)
Abort (on page 48)
Convert Unit (on page 48)
Define Active Point (on page 49)
Define Datum Point (on page 49)
Define Library (on page 50)
Define Nozzle (on page 51)
Define Orientation By Points (on page 52)
Define Placepoint (on page 53)
Define Point (on page 54)
Display Message (on page 55)
Display Tutorial (on page 55)
Draw Arc (on page 57)
Draw Complex Surface (on page 58)
Draw Con Prism (on page 60)
Draw Curve (on page 61)
Draw Ecc Prism (on page 61)
Draw Ecc Transitional Element (on page 62)
Draw Ellipse (on page 63)
Draw Line (on page 64)
Draw Line String (on page 64)
Draw Projected Hexagon (see "Draw Proj Hexagon" on page 65)
Draw Projected Octagon (see "Draw Proj Octagon" on page 66)
Draw Projected Shape (see "Draw Proj Shape" on page 67)
Draw Rectangular Torus (on page 68)
Draw Revolved Shape (on page 69)
Draw Shape (on page 70)

38

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


Draw Transitional Element (on page 71)
Get Arc Points (on page 71)
Get Arc Size (on page 72)
Get Date (on page 73)
Get Equipment Category (see "Get EQP Category" on page 73)
Get Line Size (on page 74)
Get Point (on page 74)
Move Along Arc (on page 76)
Move Along Axis (on page 77)
Move Along Line (on page 77)
Move By Distance (on page 78)
Move Data (on page 79)
Move To Placepoint (on page 79)
Place COG (on page 80)
Position Cursor (on page 81)
Put Field (on page 81)
Read Table (on page 82)
Retrieve Nozzle Parameters (on page 83)
Rotate Orientation (on page 84)
Start Complex Shape (on page 84)
Stop Complex Shape (on page 85)
Store Orientation (on page 86)
Store Nozzle Parameters (on page 86)
User Function (on page 87)
User Function FLAT_OVAL_PRISM (on page 88)
User Function FLAT_OVAL_TOR (on page 89)
User Function FLAT_OVAL_SEG_TOR1 (on page 90)
User Function FLAT_OVAL_SEG_TOR2 (on page 91)
User Function ROUND_SEG_TOR1 (on page 92)
User Function ROUND_SEG_TOR2 (on page 93)
User Function RECT_SEG_TOR (on page 94)
User Function RECT_FLAT_OVAL (on page 95)
User Function ROUND_RECT (on page 96)

Plant Design System (PDS) Equipment Eden Interface

39

Eden Language Structure

Convert NPD to Subunits


The Convert NPD to Subunits primitive converts the coded input value and returns its Real*8
equivalent. This primitive is often used for converting the nominal piping diameter that is stored in
the database.
Metric files base the diameter in millimeters. Imperial files store the nominal piping
diameter as NPD 1/32 + 5000. Thus,
1 inch NPD is 5000 + 32 * 1 = 5032
20 inch NPD is 5000 + 32 * 20 = 5640
For Eden symbols in Piping that use imperial and metric files, hard-coding the dimensions is not
recommended. A dimension entered as 5 inches and placed in an Imperial file is interpreted as 5
inches. However, the same value placed in a Metric file is interpreted as 5 millimeters. Instead of
hard coding, load the dimensions in a table to allow the piping software to convert the dimensions
to the correct values.
This primitive does not perform unit conversions. If American standard pipe sizes are being used
in a Metric file, this primitive will return the NPD in inches.

Syntax
Call Convert_NPD_To_Subunits (coded_input, npd)

Options
coded_input

The nominal pipe diameter in internal or coded units. This variable must
be the keyword Nom_Pipe_D_n.

npd

The nominal piping diameter in subunits.

Examples
In this example, the Real*8 equivalence of the coded NPD in Nom_Pipe_D_1 is returned in
Pipe_Dia_1.
Call Convert_NPD_To_Subunits (Nom_Pipe_D_1, pipe_dia_1)
All NPDs used internally in the software are in encoded form. Most table lookups based on
NPDs require the input to be in encoded form. However, if a nozzle size is needed in a calculation,
it must be converted from internal units to subunits.

Define Active Orientation


The Define Active Orientation primitive allows you to define the active orientation by specifying
the directions of the primary and secondary axes. The orientation is defined in the local coordinate
system by the symbol. This definition has no bearing on the design file coordinate system.
In Piping, this primitive defines the current flow centerline and a direction that is normal to the flow
centerline in terms of the connect point orientation (defined by the symbol's connect point
geometry) in order to place graphic shapes.

40

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


Specific keywords are available for specifying either the primary axis or the secondary axis of the
connect point's orientation.

Syntax
Call Define_Active_Orientation (primary, secondary)

Options
primary

Variable that defines the flow centerline or primary direction.

secondary

Variable that defines the line perpendicular to the flow centerline or


secondary direction.
Valid keywords for the primary and secondary variables include:
EAST

PP_PRIMARY_n

WEST

PP_SECONDARY_n

NORTH

PP_NORMAL_n

SOUTH

PRIMARY

UP

SECONDARY

DOWN
NORMAL
For the Equipment Modeling keywords, you must define n using the Define Placepoint primitive
before using any of the PP keywords.
If the initial active orientation for a symbol definition has the primary pointing east and the
secondary pointing north, the normal axis of the active orientation would be up. (Normal axis can
be found using the right-hand rule.)

Example
In the following example, the primary orientation is set to point west, and the secondary orientation
is set to point down:
Call Define_Active_Orientation (WEST,DOWN)

Draw Cone
The Draw Cone primitive places a cone where the first end is at the current active point and the
second end is at a location computed by the system given the input length along the primary axis.
You must define the diameters of each end of the cone with separate variables.

Syntax
Call Draw_Cone (length, diameter_1, diameter_2)

Plant Design System (PDS) Equipment Eden Interface

41

Eden Language Structure


Options
length

The length of the cone (A), which can be positive or negative.

diameter_1

The diameter of the cone (B) at the active point.

diameter_2

The diameter of the cone (C) at the end opposite the active point.

Examples
SYMBOL_PROCESSOR 'CCONE'
tutnam = 'CCONE'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of cone
B = DIMENSION_2 ! diameter at active pt
C = DIMENSION_3 ! diameter at opposite end
Call Define_Placepoint (PP1, Point_0)
Call Draw_Cone (A, B, C)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Draw Cylinder
The Draw Cylinder primitive places a cylinder where the first end is at the current active point and
the second end is at a location computed by the system along the primary axis. You must specify
the diameter and the length of the cylinder. The active point will be moved to the opposite end.

Syntax
Call Draw_Cylinder (length, diameter)

Options
length

The length (A) of the cylinder.

diameter

The diameter (B) of the cylinder.

Examples
SYMBOL_PROCESSOR 'CYLIND'
tutnam = 'CYLIND'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length
B = DIMENSION_2 ! diameter
Call Define_Placepoint (PP1, Point_0)
Call Draw_Cylinder (A, B)
Call Define_Active_Orientation (WEST, NORTH)

42

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


Call Define_Placepoint (PP2, POINT_0)
stop
end
If cyl_len is positive, a cylinder of the specified length is drawn. If cyl_len is zero, nothing
happens. If cyl_len is negative, the active point is moved the specified negative distance, but the
cylinder is not drawn.

Draw Eccentric Cone


The Draw Eccentric Cone primitive allows you to place an eccentric truncated cone. The first end
is at the current active point. The second end is at a location the system computes by moving from
the current active point along the current flow centerline by the length of the cone and along the
secondary axis by the negative of the eccentric offset. You must specify the eccentric offset and
the diameters of both ends of the eccentric cone.

Syntax
Call Draw_Eccentric_Cone (length, eccentric_offset, diameter_1,
diameter_2)

Options
length

Cone length (A).

eccentric_offset

Eccentric cone offset. This is the center-to-center distance


between cone endpoints as measured positive going against the
secondary.

diameter_1

Diameter (B) at active point.

diameter_2

Diameter (C) at the opposite end.

Examples
SYMBOL_PROCESSOR 'ECONE'
tutnam = 'ECONE'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length
B = DIMENSION_2 ! diameter at active pt
C = DIMENSION_3 ! diameter at opposite end
offset = (C - B) * 0.5 ! offset
Call Define_Placepoint (PP1, Point_0)
Call Draw_Eccentric_Cone (A, offset, B, C)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)

Plant Design System (PDS) Equipment Eden Interface

43

Eden Language Structure


stop
end

Draw Projected Rectangle


The Draw Projected Rectangle primitive allows you to place a component with a rectangular
cross section. The current active point must be moved to the center of the rectangle, and the
primary axis must point in the direction of the projection. The secondary axis orients the side of
length1.

You must specify the projected height, projected width, and projected length dimensions.

Syntax
Call Draw_Proj_Rectangle (length1, length2, projection)

Options
length1

Length of the rectangle side (C) parallel to the secondary axis of


the active orientation.

length2

Length of the rectangle side (B) parallel to the normal axis of the
active orientation.

projection

Length of the projection (A).

Restrictions

The active point must be located at the center of geometric shape of the rectangle.
The refresh tee must point inward (the direction of projection).

Examples
SYMBOL_PROCESSOR 'RECTNG'
tutnam = 'RECTNG'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of projection
B = DIMENSION_2 ! length of side parallel to normal
C = DIMENSION_3 ! length of side parallel to secondary
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Proj_Rectangle (C, B, A)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

44

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Projected Triangle


The Draw Projected Triangle primitive allows you to place a component that has an isosceles
triangular cross-section. The current active point must be moved to the center of the
cross-section. The primary axis points in the direction of the projection, and the secondary axis
points to the base of the triangle. You must specify the side length, base length, and projected
length dimensions.

Syntax
Call Draw_Proj_Triangle (project_side_length, project_base_length,
project_length)

Options
project_side_length

Length of the side (A) of the triangle.

project_base_length

Length of the base (B) of the triangle.

project_length

Length of the projection (C).

Restrictions

The active point must be located at the center of geometric shape of the triangle.
The refresh tee must point inward.
Make sure that dimension A is greater than 1/2 of dimension B, otherwise, errors will result.

Examples
SYMBOL_PROCESSOR 'TRIANG'
tutnam = 'TRIANG'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length a side
B = DIMENSION_2 ! length of base
C = DIMENSION_3 ! length of projection
angle = DIMENSION_4
if (B .GT. 0) then
DIMENSION_4 = 0
endif
if (angle .GT. 0 .AND. B .EQ. 0) then
angle = angle * 0.5
B = 2.0 * (A * DSIND(angle))
endif
Call Define_Placepoint (PP1, Point_0)

Plant Design System (PDS) Equipment Eden Interface

45

Eden Language Structure


Call Draw_Proj_Triangle (A, B, C)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Draw Semi-Ellipsoid
The Draw Semi-Ellipsoid primitive allows you to place a semi-ellipsoid, where the center is at the
current active point. You must specify the diameter of the major axis and the radius of the minor
axis.
The system does not update to a new active orientation after placement of the
semi-ellipsoid.

Syntax
Call Draw_Semi_Ellipsoid (major_axis_diameter, minor_axis_radius)

Options
major_axis_diameter

Variable defining the major axis diameter (A).

minor_axis_radius

Variable defining the minor axis radius (B).

Examples
SYMBOL_PROCESSOR 'SELLIP'
tutnam = 'SELLIP'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! major axis diameter
B = DIMENSION_2 ! minor axis radius
Call Define_Placepoint (PP1, Point_0)
Call Draw_Semi_Ellipsoid (A, B)
stop
end

46

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Sphere
The Draw Sphere primitive allows you to place a sphere where the center of the sphere is at the
current active point. You must specify the radius, and the radius must be greater than or equal to
() 1/64 inches.
The refresh tee and orientation will not change after placement.

Syntax
Call Draw_Sphere (radius)

Options
radius

Variable (A) defining the sphere radius.

Examples
A = F_to_C_Dim_1*0.5 ! defining sphere radius
Call Draw_Sphere (A)

Draw Torus
The Draw Torus primitive allows you to place a torus from the current flow centerline to the
current direction of the secondary axis using the bend radius, bend angle, and diameter you
specify. This call changes the active orientation.

The torus diameter must be greater than or equal to () 1/32 inches, and the bend radius diameter
must be greater than or equal to () 1/32 inches and greater than (>) 1/2 the torus diameter.

Plant Design System (PDS) Equipment Eden Interface

47

Eden Language Structure


Syntax
Call Draw_Torus (radius, angle, diameter)

Options
radius

The bend radius of the torus (B) as measured from the origin of the
torus to its centerline.

angle

The bend angle of the torus (C).

diameter

The diameter of the torus (A).

Examples
SYMBOL_PROCESSOR 'CTORUS'
tutnam = 'CTORUS'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! torus diameter
B = DIMENSION_2 ! torus bend radius
if (DIMENSION_3 .eq. 0) then
DIMENSION_3 = 90
endif
C = DIMENSION_3 ! bend angle
Call Define_Placepoint (PP1, Point_0)
Call Draw_Torus (B, C, A)
Call Rotate_Orientation (-180., SECONDARY)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Abort
The Abort primitive allows you to terminate symbol execution without having to place graphics. It
is similar to the QUIT option available on symbol tutorials. When the system encounters an Abort
call, it displays a message indicating that the symbol execution has aborted.

Syntax
Call Abort (0)

Convert Unit
The Convert Unit primitive is used to convert distance in a given system of units to the design file
system of units. Both lengths are expressed in subunits.

Syntax
Call Convert_Unit (length1, unit type, outlength)

Options

48

length1

Is the input length in subunits.

unit type

Is the input as ENGLISH (for inches) or METRIC (for mm) to indicate the
units in which length1 is expressed.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


outlength

Is the output after converting length1 to design file system of units.

Example
In the following example, a length of 10 inches is input. length2 receives the value 10 if the unit
type is set to English or 254 if the unit type is set to Metric.
Call Convert_Unit (10, ENGLISH, length2)

Define Active Point


The Define Active Point primitive functions similarly to the Define Active Orientation primitive,
but also defines the active point in the symbol's local coordinate system.

Syntax
Call Define_Active_Point (point)

Options
point

Is a keyword specifying a previously defined point. Valid values for point


include:
local point variables
global point variables
PP_LOCATION_q (q = 1 - 10)

Restrictions

The initial position of the active point must be located at the symbol's local coordinate system
origin.
Before using POINT_n, you must define it by calling Define Point.
Before using PP_LOCATION_q, you must define it by calling Define Placepoint.

Example
Call Define_Active_Point (POINT_3)
Call Define_Active_Point (PP_LOCATION_1)

Define Datum Point


The Define Datum Point primitive allows you to define and place up to 30 datum points per
symbol. The orientation of the datum point is controlled by the active orientation at the time of the
call.

Syntax
Call Define_Datum_Point (dp, point)

Options
dp

Is a keyword specifying the datum point number. Valid values include:


1...30

Plant Design System (PDS) Equipment Eden Interface

49

Eden Language Structure


point

Is a keyword specifying the datum point location. Valid values include:


ACTIVE_POINT
local point variable
global point variable
PP_LOCATION [1] ... PP_LOCATION [10]

Example
In the following example, the call defines dp [1]. Its location is given by point_2.
Call Define_Datum_Point (dp [1], point_2 )
In the Add and Modify & Copy commands, this call will not replace or add to existing
datum points for the equipment. In the Modify mode, it will replace existing datum points only if
they are still associated with the symbol being modified. (Refer to the PDS Equipment Modeling
(PD_EQP) Reference Guide for more information.) In either case, if nonparametric datum points
already exist for the piece of equipment, Define Datum Point calls will have no effect.

Define Library
The Define Library primitive allows you to activate an alternate physical data library.

Syntax
Call Define_Library (library_no)

Options
library_no

Is a keyword, variable, or expression whose numeric value specifies which


library is to be opened next. Valid values and their symbolic keywords include:
1 - ENG_COMM_LIB

The piping physical data library.

3 - EQP_TABLES

The equipment physical data library.

ACT_LIB

Keyword that allows you to see which commodity


library is currently open. ACT_LIB is a read-only
variable and can only be set by the system following
a successful Define_Library call. When a symbol is
first called up, the system automatically opens the
correct commodity library depending on the nozzle
diameter system of units for the file and then sets
ACT_LIB to 1 (ENG_COMM_LIB). Therefore, at the
beginning of symbol execution, you can always
expect the default piping physical data library to be
open. Subsequently, with the Define_Library
primitive, you can change the active library.

Example
In the following example, the active library number (1 or 3) is saved, and the English commodity
library is temporarily opened. When the library is no longer needed, the previously active library is
restored.
save_library = ACT_LIB
Call Define_Library (ENG_COMM_LIB)
.

50

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


.
.
Call Define_Library (save_library)
-ORsave_library = ACT_LIB
Call Define_Library (1)
.
.
.
Call Define_Library (save_library)

Define Nozzle
The Define Nozzle primitive places a nozzle at the current active point using the current active
orientation. Before calling this primitive, you must call Retrieve Nozzle Parameters and set the
necessary global variable assignments, such as Noz_Length1, Noz_Length2, or Noz_Radius.

Syntax
Call Define_Nozzle (noz_type, noz_num, noz_end)

Options
Noz_type

A character variable or constant defining the nozzle type. Valid values


include:
1

NOZ1

for type 1 nozzles. Consists of a basic flange.

No user input is required. The nozzle length is set by the


flange thickness table.
2

NOZ2

for type 2 nozzles. Consists of a flange as well as a neck.

The length is user-defined.


A = Noz_Length1
3

NOZ3

for type 3 nozzles. Commonly referred to as a goose


neck nozzle.

Plant Design System (PDS) Equipment Eden Interface

51

Eden Language Structure

Two lengths and the bend radius are user-defined.


A = Noz_Length1
B = Noz_Length2
C = Noz_Radius
Noz_num

A nozzle number that uniquely identifies the nozzle within the parametric
symbol. The nozzle number must NOT be used for more than one nozzle
within a parametric symbol definition. Currently, this number can take on a
value of 1 to 20, inclusively. Therefore, a single parametric can not have
more than 20 nozzles.

Noz_end

A variable or constant with a value of 1 or 2 that defines the end of the


nozzle placed at the active point. A value of 1 specifies the end connected
to the equipment item. A value of 2 specifies the end connected to
piping.The primary axis of the active orientation is used to orient both type
1 and type 2 nozzles. The primary and secondary axes are used to orient
type 3 nozzles.

Example
SYMBOL_PROCESSOR 'NOZ1'
tutnam = 'NOZ1'
Call Display_Tutorial (tutnam)
nozend = DIMENSION_100
nozsum = 20
Call Retreive_Nozzle_Parameters (nozsum)
Call Define_Nozzle ('NOZ1', noznum, nozend)
stop
end
You must call Retrieve Nozzle Parameters before Define Nozzle.

Define Orientation By Points


The Define Orientation By Points primitive allows you to redefine the active orientation using
three known points.

Syntax
Call Define_Orientation_By_Points (PT1, PT2, PT3)

Options
pt1

52

The active primary direction is computed using pt1 as the start point.
Global or local point.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


pt2

The active primary direction is computed using pt2 as the end point. Global
or local point.

The active secondary direction is computed using pt3 as the end point. The
start point is the intersection between the primary vector from pt1 and its
perpendicular from pt3. Global or local point.
In case one or more of these points are coincident, the active orientation is unchanged.
pt3

Example
In the following example, the call orients the active primary along the line from POINT_1 to
POINT_2, and the active secondary towards POINT_3 along a perpendicular of the primary:
Call Define_Orientation_By_Points (point [1], point [2], point [3])

Define Placepoint
The Define Placepoint primitive allows you to define the symbol placepoint. Every symbol must
have at least one place point.

Syntax
Call Define_Placepoint (pp, point)

Options
pp

A keyword defining the placepoint number. Valid values for pp include:


PP1 - PP10
Up to 10 placepoints can be defined for a symbol.

point

Keyword defining the place point location. Valid values for point include:
ACTIVE_POINT
local point variables
global point variables
pp_location_1 - pp_location_10

Example
In this example, place point number 1 is defined.
Call Define_Placepoint (PP1, POINT_0)
At symbol placement time, the symbol place point is aligned with the current design file active
point. The place point's primary axis is aligned with the design file active orientation primary axis.
Therefore, the symbol's local coordinate system is transformed to that defined by the refresh tee.

Plant Design System (PDS) Equipment Eden Interface

53

Eden Language Structure

Define Point
The Define Point primitive allows you to save a point or to calculate a new point based on a
reference point and a delta x, y, and z.

Syntax
Call Define_Point (point, ref_point, delta_x, delta_y, delta_z, flag)

Options
point

A keyword specifying the saved or calculated point storage location.


Local or global point variables are valid values.

ref_point

A keyword specifying the point to be saved or the point from which


the new point is to be calculated. Valid values for ref_point include:
local point variable
global point variable
pp_location_1 - pp_location_10

delta_x

The delta in the x or east direction of the symbol coordinate system


from the reference point.

delta_y

The delta in the y or north direction of the symbol coordinate system


from the reference point.

delta_z

The delta in the z or up direction of the symbol coordinate system


from the reference point.

flag

[optional] If supplied, the deltas are interpreted as offsets along the


active primary, secondary, and normal respectively.

Examples

54

In this example, the current active point is saved in POINT_1. You can make POINT_1 the
active point again simply by calling Define Active Point.
Call Define_Point (POINT_1, ACTIVE_POINT, 0, 0, 0)

In this example, a new point is calculated from POINT_1. The result is saved in POINT_2.
delx = 24.
dely = 24.
delz = 24.
Call define_point (POINT_2, POINT_1, delx, dely, delz)

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Display Message
The Display Message primitive allows you to display a message in a tutorial field or MicroStation
'ER' field.

Syntax
Call Display_Message (message, fldno)

Options
message

A variable or expression. If necessary, the message can be converted to


displayable characters for output. You can specify a message up to 50
characters in length; however, only the first 40 characters will be displayed.

fldno

A field number on the active tutorial. Possible values are 0 - 255. If 0, the
message is displayed in the MicroStation ER field.
[optional] This argument defaults to 0 if omitted.

Tutorial fields defined (via TDF) to contain data for symbol generation should not receive
input through this call.

Example
dia = -10.0
.
.
.
Call Display_Message ('Cone dia is negative: ' || dia, 0 )
The actual message displayed in the 'ER' field will read: Cone dia is negative: -10.0

Display Tutorial
The Display Tutorial primitive allows you to activate a tutorial and specify an optional tutorial
definition file name.

Syntax
Call Display_Tutorial (tutnam, tdfnam)

Options
tutnam

Name of the form (1 - 6 characters) to be activated.

tdfnam

[optional] The tutorial file name (1 - 6 characters). If omitted, the TDF name
defaults to the tutorial name itself. This argument allows you to activate the
same tutorial with different TDF names and hence different global variables
for each activation. The same TDF name can be used with different
tutorials.

Example
This call activates a tutorial named TEST.
Call Display_Tutorial ('TEST')

Plant Design System (PDS) Equipment Eden Interface

55

Eden Language Structure


There is a limit of 10 forms that can be activated. It is also possible to activate the same
form several times per symbol execution. However, if a TDF name is used with several forms in
the modify mode, only the first such form will display existing data.

Interacting with Tutorials


Terminated fields allow the symbol code some control over operator interaction when a tutorial is
active. Refer to the Creating the Tutorial Definition Table section for creating these fields. When
you select a terminated application command or key-in field, the control returns to the symbol
code, which can test specific global variables identifying the field number and its type. The global
variable LAST_INP_TYPE has the type of the most recent terminated field selected. It can be
tested against the following keywords for field types:
APPLICATION_CMD

application command field

USER_KEYIN

user key-in field

The global variable LAST_INP_NUM contains the number of the last terminated field selected.

Example
Three possible operator actions can result in control returning to the symbol code for the example
below. The first test is against a terminated application field selection. If positive, the data in
DIMENSION [LAST_INP_NUM] is accessed and output to field 90.
The second test is for the selection of a terminated key-in field. The contents of CSTRING
[LAST_INP_NUM] is output to field 100. The receiving variable for the keyed-in text is stored as
per TDF.
The symbol waits for further operator input by calling Display Tutorial. The tutorial does not
redisplay since it is already active.
If both tests fail, you must select ACCEPT (the control variable will be set to TRUE), forcing exit
from the loop.
ACCEPTED = FALSE
do while (.not. ACCEPTED)
Call Display_Tutorial ('TEST')
if (LAST_INP_TYPE .eq. APPLICATION_CMD) then ! application cmd
! ... field
Call Put_Field (dimension [LAST_INP_NUM], 90)
else
if (LAST_INP_TYPE .eq. USER_KEYIN) then
Call Put_Field (cstring [LAST_INP_NUM],100)
else
ACCEPTED = TRUE ! get out of loop
endif
endif
enddo

56

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Arc
The Draw Arc primitive allows you to place an arc. An arc may be considered a continuous
segment of an ellipse whose axes are known.

Syntax
Call Draw_Arc (semimajor, semiminor, start_angle, sweep_angle)

Options
semimajor

Supplies the length of the semimajor axis and is oriented by the


local primary.

semiminor

Supplies the length of the semiminor axis and is oriented by the


local secondary.

start_angle

Specifies the start point of the arc segment. The value range is
-360.0 to 360.0. Larger or smaller values are reduced to this range,
remaindering by 360.0. Positive angles are measured by rotating
the primary into the secondary counterclockwise in a right-handed
system.

sweep_angle

Specifies the span of the arc segment. The value range is -360.0 to
360.0. Larger or smaller values are reduced to this range,
remaindering by 360.0. Rotational sense is counterclockwise,
right-handed, from start_angle.
The parent ellipse is completely known given the active primary,
secondary and the axis lengths. The two angles merely fix the arcs
angular position and not the distance of any of its points from the
foci.

Example
This call places an elliptical arc with major and minor axes of 40 and 20 units respectively. The
primary axis is rotated from a 90 degree position through a right angle to produce the arc.
Call Draw_Arc (20, 10, 90, 90)
If you are placing a non-circular arc with start or sweep angles that are NOT a multiple of 90
degrees, MicroStation computes these angles differently. To convert your angle to the input
argument, use the following formula:
tan(microstation_angle) = (semimajor/semiminor) tan(your_angle)

Plant Design System (PDS) Equipment Eden Interface

57

Eden Language Structure

Draw Complex Surface


The Draw Complex Surface primitive allows you to build projected and revolved shapes one
element at a time. Familiarity with the structure of 3D MicroStation shapes is required to use this
primitive effectively.
There is a limitation on using multiple Draw Line commands for getting a complex shape
inside Draw Complex Surface to create new support symbols. You must use the line strings or
projected shape to create complex shapes.

Syntax
Call Draw_Complex_Surface (argument_1, argument_2)
The call can be made in three modes:
1. Start surface
2. Change class or symbology of elements being placed
3. End surface
Each argument has a different interpretation for each mode.

Start Surface
Used to start the surface.

Syntax
Call Draw_Complex_Surface (no_of_ele, surface_type)

Options
no_of_ele

The number of elements per face.

surface_type

The MicroStation surface type to build. Typical surface types


include:
0 - surface of projection
8 - surface of revolution

Change Class/Symbology
Used to change the class/symbology of elements being placed within the surface. A negative
symbol must be placed in front of the first argument.

Syntax
Call Draw_Complex_Surface (_element_class, symbology)

Options
element_class

The class of elements to be placed. Typical classes include:


primary elements (class = 0, the default)
rule elements (class = 4)

symbology

The symbology of elements to be placed.


This is an INTEGER (I*4 or 4 bytes) word. The upper word (2 bytes)
is set to:

58

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


0 - allows defaults to apply
1 - apply line code only
2 - apply line weight only
4 - apply color only
Sum the above values to send in combinations. For example, (3)
code and weight to apply is the result of adding (1) apply line code
only and (2) apply line weight only. Using this process, you can enter
numbers 0-7 (default to all of the above).
The lower word supplies the symbology (line code, line weight, color)
as per MicroStation format.

Complete Surface
Used to complete the surface.

Syntax
Call Draw_Complex_Surface (-99, 0)

Example
This example shows the creation of a flat-oval projected shape. The opening Draw Complex
Surface specifies that each face is composed of 4 elements and that this is a surface of
projection.

The code for placing a flat-oval face is shown (2 arcs and 2 lines). The second call to Draw
Complex Surface specifies that rule lines (class=4) will be placed. The minus sign before the
class argument is needed by the system to identify ongoing calls. The final call terminates surface
construction.
Call Draw_Complex_Surface (4, 0) ! start projected;
Call Draw_Arc (radius, radius, -90, 180)
Call Draw_Line (point_1, point_2)
Call Draw_Arc (radius, radius, 90, 180)
Call Draw_Line (point_3, point_4)
Call Draw_Complex_Surface (4, 0) ! surface 2
Call Draw_Arc (radius, radius, -90, 180)
Call Draw_Line (point_5, point_6)
Call Draw_Arc (radius, radius, 90, 180)

Plant Design System (PDS) Equipment Eden Interface

59

Eden Language Structure


Call
Call
Call
Call
Call
Call
Call

Draw_Line (point_7, point_8)


Draw_Complex_Surface (-4, 0) ! start
Draw_Line (point_1, point_5) ! place
Draw_Line (point_2, point_6) ! place
Draw_Line (point_3, point_7) ! place
Draw_Line (point_4, point_8) ! place
Draw_Complex_Surface (-99, 0) ! wrap

rule lines
a rule line
a rule line
a rule line
a rule line
it up

Draw Con Prism


The Draw Con Prism primitive places a concentric prism by a point in the center of either
rectangular end. The active orientation primary axis is used to orient the direction of projection.
The secondary axis orients a side of each end.

Syntax
Call Draw_Con_Prism (length_sec, length_norm, length_proj, length2_sec,
length2_norm)

Options
length_sec

The length of rectangular base along secondary.

length_norm

The length of rectangular base along normal.

length_proj

The length of projection.

length2_sec

The length of rectangular top along secondary.

length2_nor

The length of rectangular top along normal.

Example
SYMBOL_PROCESSOR 'RPRISM'
tutnam = 'RPRISM'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of A
B = DIMENSION_2 ! length of B
C = DIMENSION_3 ! length of C
D = DIMENSION_4 ! length of D
proj = DIMENSION_5 ! length of E
Call Define_Placepoint (PP1,POINT_0)
Call Draw_Con_Prism (A, B, proj, C, D)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

60

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Curve
The Draw Curve primitive allows you to place a curve string.

Syntax
Call Draw_Curve (no_vertex, point_buffer)

Options
no_vertex

The number of vertices from 1 - 90.

point_buffer

The location of the 1st vertex. The other vertices are


sequentially stored in the buffer. Use global or local point
buffers.

Example
In this example, the call places a stream curve of 20 points in POINT [24] .. POINT [43].
Call Draw_Curve (20, point_24)
This primitive is not supported by the equipment task but is available in the HVAC task.

Draw Ecc Prism


The Draw Ecc Prism primitive places an eccentric prism by a point in the center of either
rectangular end. The active orientation primary axis orients the direction of projection. The
secondary axis orients a side of each end as well as the offset direction.

Syntax
Call Draw_Ecc_Prism (length_sec, length_norm, length_proj,
length2_sec, length2_norm, offset)

Options
length_sec

The length of rectangular base along secondary.

length_norm

The length of rectangular base along normal.

length_proj

The length of projection.

length2_sec

The length of rectangular top along secondary.

Plant Design System (PDS) Equipment Eden Interface

61

Eden Language Structure


length2_norm

The length of rectangular top along normal.

offset

The center-to-center distance between base end and top end


measured (positive) against the secondary.

Example
SYMBOL_PROCESSOR 'EPRISM'
tutnam = 'EPRISM'
Call Display_tutorial (tutnam)
A = DIMENSION_1 ! length of A
B = DIMENSION_2 ! length of B
C = DIMENSION_4 ! length of C
D = DIMENSION_5 ! length of D
E = DIMENSION_3 ! length of E
offset = (A - C) / 2.0 ! offset
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Ecc_Prism (A, B, E, C, D, offset)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Draw Ecc Transitional Element


The Draw Ecc Transitional Element primitive allows you to place an eccentric transitional
element by a point in the center of either the rectangular or circular face. The active orientation
primary axis orients the direction of projection. The secondary axis orients a side of the
rectangular base and the direction of offset.

Syntax
Call Draw_Ecc_Transitional_Element (length_sec, length_norm, length_proj,
length_radius, offset)

Options

62

length_sec

The length of rectangular base along secondary.

length_norm

The length of rectangular base along normal.

length_proj

The length of projection.

length_radius

The radius of circular face.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


offset

The center-to-center distance between the rectangular end and the


circular end as measured positive going against the active secondary.

Example
SYMBOL_PROCESSOR 'ETRANS'
tutnam = 'ETRANS'
Call Display_tutorial (tutnam)
A = DIMENSION_1 ! length of A
B = DIMENSION_2 ! length of B
C = DIMENSION_3 ! length of C
D = DIMENSION_4 / 2.0 ! length of D
offset = (A - D) / 2.0 ! offset
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Ecc_Transitional_Element (A, B, C, D, offset)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Draw Ellipse
The Draw Ellipse primitive allows you to place an ellipse. The major and minor axes are oriented
by the local primary and secondary axes respectively.

Syntax
Call Draw_Ellipse (semimajor_len, semiminor_len)

Options
semimajor_len

Half the length of the major axis.

semiminor_len

Half the length of the minor axis.

Example
This call places an ellipse whose major and minor axes are 40 and 20 units long. The major axis
points DOWN.
Call Define_Active_Orientation ( DOWN, WEST )
Call Draw_Ellipse (20.0, 10.0)

Plant Design System (PDS) Equipment Eden Interface

63

Eden Language Structure

Draw Line
The Draw Line primitive allows you to place a line.

Syntax
Call Draw_Line (start_pt, end_pt)

Options
start_pt

The location of first vertex. Use global or local point.

end_pt

The location of second vertex. Use global or local point.

Example
In this example, the call places a line from POINT_10 to POINT_20.
Call Draw_Line (point_10, point 20)

Draw Line String


The Draw Line String primitive allows you to place a line string.

Syntax
Call Draw_Line_String (no_vertex, point_buffer)

Options
no_vertex

Supplies the number of vertices from 1 - 90.

point_buffer

The location of the first vertex. The other vertices are sequentially
stored in the buffer. Use global or local point buffers.

Example
In this example, the call places a line string of 20 vertices, which are found in POINT[24] ... POINT
[43].
Call Draw_Line_String (20, point [24] )

64

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Proj Hexagon


The Draw Proj Hexagon primitive allows you to place a projected hexagon by a point in the
center of a face. The active orientation primary axis orients the direction of projection. The
secondary axis orients a flat of the hexagonal solid.

Syntax
Call Draw_Proj_Hexagon (side_length, proj)

Options
side_length

Side B is the side length.

proj

Side A is the length of the projection.

Example
SYMBOL_PROCESSOR 'HEXAGON'
tutnam = 'HEXAGON'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of A
D_in = DIMENSION_2 !
D_out = DIMENSION_3 !
D_side = DIMENSION_4 !
if (D_side .GT. 0) then
DIMENSION_2 = 0
DIMENSION_3 = 0
endif
if (D_side .LE. 0) then
if (D_in .GT. 0) then
DIMENSION_3 = 0
D_side = D_in * DTAND(30.0)
endif
endif
if (D_side .LE. 0) then
if (D_out .GT. 0) then
D_side = D_out / 2
DIMENSION_2 = 0
endif
endif
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Proj_Hexagon (D_side, A)

Plant Design System (PDS) Equipment Eden Interface

65

Eden Language Structure


Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end

Draw Proj Octagon


The Draw Proj Octagon primitive places a projected octagon by a point in the center of a face.
The active orientation primary axis orients the direction of the projection. The secondary axis
orients a flat side of the octagonal solid.

Syntax
Call Draw_Proj_Octagon (side_length, proj)

Options
side_length

Side B is the side length.

proj

Side A is the length of the projection.

Example
SYMBOL_PROCESSOR 'OCTGON'
tutnam = 'OCTGON'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of A
D_in = DIMENSION_2 !
D_out = DIMENSION_3 !
D_side = DIMENSION_4 !
if (D_side .GT. 0) then
DIMENSION_2 = 0
DIMENSION_3 = 0
endif
if (D_side .LE. 0) then
if (D_in .GT. 0) then
DIMENSION_3 = 0
D_side = D_in * DTAND(22.5)
endif
endif
if (D_side .LE. 0) then

66

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


if (D_out .GT. 0) then
D_side = D_out * DSIND (22.5)
DIMENSION_2 = 0
endif
endif
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Proj_Octagon (D_side, A)
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
stop
end
Call Draw_Proj_Octagon (12, 12)

Draw Proj Shape


The Draw Proj Shape primitive allows you to place an arbitrary (planar) shape and project it by a
given distance. The active primary orients the direction of projection.

Syntax
Call Draw_Proj_Shape (no_pnt, proj_len, pnt_buffer)

Options
no_pnt

The number of vertices from 1 - 24.

proj_len

The length (A) of the projection.

pnt_buffer

[optional] If supplied, points to the location of the first vertex. If


omitted, the vertices are assumed to be in the global POINT array
with vertex 1 in point_1, vertex 2 in point_2, and so forth. Local or
global point arrays.

Examples

The length of the shape to be placed is 10.0 units. The 5 vertices are in POINT [101] ... POINT
[105].
Call Draw_Proj_Shape ( 5, 10.0, point [101])

The projected shape's vertices are found in POINT_1 ... POINT_5. After placement, the active
point is updated from the face by which it was placed to the opposite face.
Call Draw_Proj_Shape ( 5, 10.0 )

Plant Design System (PDS) Equipment Eden Interface

67

Eden Language Structure

Draw Rectangular Torus


The Draw Rectangular Torus primitive places a rectangular torus by a point in the center of
either rectangular end. The active orientation primary axis orients the direction of projection. The
secondary axis points toward the origin of the torus.

Syntax
Call Draw_Rectangular_Torus (bend_radius, sweep_angle, length_sec,
length_norm)

Options
bend_radius

The length from torus origin to center of either end.

sweep_angle

The angle formed between two radii joining the center of each end to
the origin.

length_sec

The length of rectangular end along secondary.

length_norm

The length of rectangular end along normal.

Example
SYMBOL_PROCESSOR 'RTORUS'
tutnam = 'RTORUS'
Call Display_Tutorial (tutnam)
A = DIMENSION_1 ! length of A
B = DIMENSION_2 ! length of B
C = DIMENSION_3 ! length of C
D = DIMENSION_4 ! Sweep angle of D
Call Define_Placepoint (PP1, POINT_0)
Call Draw_Rectangular_Torus (C, D, A, B)
Call Rotate_Orientation (-180.,SECONDARY)
Call Define_Placepoint (PP2, POINT_0)
stop
end

68

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Revolved Shape


The Draw Revolved Shape primitive allows you to create a MicroStation surface of revolution by
rotating an arc, line string, or shape. The axis of rotation is the primary axis passing through the
symbol active point. Rotation is counter-clockwise.

Syntax
Call Draw_Revolved_Shape (generator_type, total_stroke_angle, no_of_steps
point_buffer, argument_5, argument_6)

Options
generator_type

A keyword specifying the element type being revolved.


Keywords include:
EL_LINESTR

for line string

EL_SHAPE

for planar shape

EL_ARC

for arc

total_stroke_angle

Specifies the overall angle of revolution in degrees from -360 to


+360.

no_of_steps

Specifies the number of sections to create for the revolved


shape. For example, if you specify a value of 2, there will be one
intermediate instance of the generator element which will split
the revolved shape into two sections. Must be at least 1.

point_buffer

An array of points used to define the rotating element.


If you are rotating a shape or line string, this array supplies the
vertices of the element. If you are rotating an arc, this array must
contain three points to define the arc. The first point is the arc
origin. The second point defines the length and direction of the
primary axis as measured from the arc origin. The third point
defines the arc secondary, also relative to the arc origin.

argument_5

For line string or shape: the number of points in point_buffer.


For arc: start angle of the arc (angle made between primary axis
and the start of the arc segment).

argument_6

For line string or shape: a flag to indicate how edge lines should
be placed.
Specify a 1 if edge lines are to appear from all vertices. Specify a
0 if edge lines are placed from the two end vertices only.
For arcs: the sweep angle of the arc segment. (For arcs, only two
edge lines are placed, one from each end point of the arc).

Example
In this example, a 2:1 semi-elliptical head is placed. The straight section is 24 inches, and the
vessel diameter is 120 inches. Only two instances of the arc will appear --- one at 0 degrees, and
another at 180 degrees (intermediate).

Plant Design System (PDS) Equipment Eden Interface

69

Eden Language Structure


straight_flange = 24
dia = 120
dish_depth = dia/4
Call Draw_Cylinder (straight_flange, dia)
point_1 = point_0 ! save arc center
Call Move_Along_Axis (dia/2, SECONDARY)
point_2 = point_0 ! point for arc primary
point_0 = point_1 ! for next move_along
Call Move_Along_Axis (dish_depth, PRIMARY)
point_3 = point_0 ! define arc secondary
total_sweep = 360
arc_sweep = 90 ! quadrant arc rotating
Call Draw_Revolved_Shape (EL_ARC, total_sweep, 2, POINT_1, 0, arc_sweep)
If you are rotating an arc, refer to the Draw Arc section for proper specifications of start and
sweep angles.

Draw Shape
The Draw Shape primitive is a 2D call allowing you to place a planar closed shape.

Syntax
Call Draw_Shape (no_vertex, point_buffer)

Options
no_vertex

Supplies the number of vertices from 1 - 90.

point_buffer

The location of the first vertex. The other vertices are found in
succeeding locations. The system adds the last vertex to coincide
with the first vertex and close the shape. Use global or local point
buffers.

Example
In this example, the call places a shape of 20 vertices in POINT [24] ... POINT [43].
Call Draw_Shape (20, point [24])

70

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Draw Transitional Element


The Draw Transitional Element primitive allows you to place a right transitional element with a
point in the center of either the rectangular or circular face. The active orientation primary axis
orients the projection direction. The secondary axis orients a side of the rectangular base.

Syntax
Call Draw_Transitional_Element (length_sec, length_norm, length_proj,
length_radius)

Options
length_sec

The length of rectangular base along secondary.

length_norm

The length of rectangular base along normal.

length_proj

The length of projection.

length_radius

The radius of circular face.

Example
In this example, a transitional element with a base measuring 24 x 16 and a height of 30 subunits
is placed along the active primary axis. The circular top is drawn with a radius of 6 subunits.
After placement, the active point is updated from the face by which the shape was placed to the
opposite end.
Call Draw_Transitional_Element (24, 16, 30, 6)

Get Arc Points


The Get Arc Points primitive allows you to access the data for the arc last identified in a Get
Point call. The system ignores the secondary length of the arc, assuming it to be identical to the
primary. This call is specifically geared to facilitate hand-railing placement.

Syntax
Call Get_Arc_Points (arc_definition)

Options
arc_definition

An output buffer of 4 points (global or local point buffer). The 4 points


returned are (in order): center, one end point, an intermediate point,
and the other end point of the arc. They allow the system to
reconstruct the circular arc on arc-related calls where this definition
must be input. The call will work properly as long as the identified arc
is circular. The points are converted to the symbol (local) coordinate
system before return.

Plant Design System (PDS) Equipment Eden Interface

71

Eden Language Structure

Get Arc Size


The Get Arc Size primitive returns the circumferential distance between two points on an arc.

Syntax
Call Get_Arc_Size (arc_definition, from_pt, to_pt, length)

Options
arc_definition

An input buffer of four points identifying a circular arc in local


coordinates. The subroutine uses this argument to find the angular
position or sweep of the arc segment about the center (first point). The
center of the arc is then used with the FROM_PT argument to find trace
radius.

from_pt

An input identifying the starting point of measurement. It is also used to


compute the radius of the circular arc. Global or local point.

to_pt

An input identifying the end point of measurement. This point only


establishes an ANGULAR position on the arc determined from the first
two arguments. Thus, it may or may not be on the arc itself. Global or
local point.

length

The output variable containing the peripheral separation between


FROM_PT and TO_PT.

The result is accurate as long as both FROM_PT and TO_PT are within the sweep angle of
the arc in ARC_DEFINITION. However, if a point is off the curve, the system will route the
connection so as to include the arc's end nearer the off-point.

Example
In this example, the Get Point call forces a snap only -- to an arc. On return, the arc data is
obtained with the second call. The length of the arc is then computed by sending the third call (the
start point (point [3]), the end point (point [5]), and the arc itself).
int2 ret_pt_type, ret_ele_type
.
.
Call Get_Point (PT_SNAP, point [1], ret_pt_type, ret_ele_type, EL_ARC)
Call Get_Arc_Points (point [2])
Call Get_Arc_Size (point [2], point [3], point [5], length)

72

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Get Date
The Get Date primitive allows you to retrieve the current system date into a character variable.

Syntax
Call Get_Date (date_string)

Options
date_string

The character variable receiving system date in the form: dd-mmm-yyyy

Example
Call Get_Date (cstring_1)
After this call, cstring_1 appears as: "22-JAN-1989"

Get EQP Category


The Get EQP Category primitive allows you to obtain a valid label for a given category number.

Syntax
Call Get_EQP_Category (catno, category, ret_code)

Options
catno

(input) A number between 1-20.

category

(output) The category label for the given subcategory number.

ret_code

(output)

0 - if catno is valid
1 - if catno is invalid
Within this primitive, you can select from a displayed list of valid EQUIPMENT subcategories.

Example
In this example, the code fragment obtains all available (20) category labels.
do i = 1, 20
Call Get_EQP_Category (i, cstring [i], irc)
if (irc .ne. 0) then
cstring [i] = ' ' ! blank out sub-category name
end if
end do

Plant Design System (PDS) Equipment Eden Interface

73

Eden Language Structure

Get Line Size


The Get Line Size primitive returns the straight line distance between two points.

Syntax
Call Get_Line_Size (from_pt, to_pt, size)

Options
from_pt

The start point of measurement. Use global or local point.

to_pt

The endpoint of measurement. Use global or local point.

size

The output variable containing the distance. This argument is always


positive.

Example
In the following example, the code fragment computes the distance between point_1 and point_2
through the previous Get Point calls:
.
.
Call Get_Point (pt_snap, point [1])
Call Get_Point (pt_snap, point [2])
Call Get_Line_Size (point [1], point [2], distance)
.
.

Get Point
The Get Point primitive allows you to get a point from the operator in addition to an identified
element.

Syntax
Call Get_Point (pnt_types, ret_pnt, ret_pnt_type, ret_ele_type, ele_types)

Options
pnt_types

74

An INT2 variable mask dictating the types of input you can select. You
can combine the following keywords to yield the INT2 result:
PT_RESET

Return by selecting RESET (no point returned).

PT_BORE

Boresight location point.

PT_SNAP

Snap point.

PT_PREC

Key-in precision point.

PT_EQPID

Allows you to key-in the equipment name. The system


returns its first datum point location, if it exists.
Otherwise, it returns the place point of the first item
placed for that equipment in the design file.

PT_NOZID

Allows you to key in a NOZZLE ID. The system returns


the location of its first connect point.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


PT_3DB

A 2-view data button.

PT_ALL

Contains the result obtained by adding all the above


point types. Any point type can be removed from this
mask by subtraction.
When forming the mask, remember to use a keyword
only once whether adding or subtracting.

ret_pnt

A global or local point variable containing (on return) the


operator-selected point. The design file coordinate system (global) point
is transformed to the local coordinate system by using the point and
axes of alignment between the two systems. Therefore, the orientation
and location of the symbol placepoint must be established prior to this
call. Also, the alignment parameters (placepoint location, orientation,
global active point, global active orientation) must not be changed
between Get Point calls. This can result in returned points not
maintaining proper relativity. Use global or local point buffer.

ret_pnt_type

An INT2 output variable that contains the type of the returned point. This
variable can be tested against the above keywords. It is optional only if
subsequent arguments are omitted.

ret_ele_type

An INT2 output variable that contains the coded TYPE of the


MicroStation element identified by a SNAP (see the PDS Equipment
Modeling (PD_EQP) Reference Guide). It is optional only if subsequent
arguments are omitted. It can be tested against these keywords to
identify the type code:

ele_types

EL_LINE

line element

EL_LINESTR

line string

EL_SHAPE

shape

EL_ELLIPSE

ellipse

EL_ARC

arc

EL_PTSTR

point string

EL_CONE

cone

An INT2 mask obtained by combining (adding) a number of element


type codes just listed. It dictates the types the operator can possibly
identify. This variable is optional. If left off, all element types are
allowed.
EL_ALL contains the combination of all the above type codes. One or
more types can be removed from the mask by subtraction.
When forming the mask, remember to use a keyword only once whether
adding or subtracting.

Example
The following code segment enables the symbol to obtain an arc or a line from the operator using
snap or precision key-in:
int2 retpttype, reteletype
.

Plant Design System (PDS) Equipment Eden Interface

75

Eden Language Structure


.
Call Display_Message ('Identify arc or line')
Call Get_Point (pt_snap+pt_prec, point [101], retpttype,
reteletype, el_arc+el_line)
if (retpttype .eq. pt_snap) then ! is it a snap point?
if (reteletype .eq. EL_ARC) then ! an arc was snapped to
.
.
else ! it must be EL_LINE
.
.
endif
else ! it must be precision
.
.
endif

Move Along Arc


The Move Along Arc primitive returns a destination point (after traversing a specified distance
along a given arc) from a given point.

Syntax
Call Move_Along_Arc (arc_definition, from_pt, to_pt, travel dist, out_pt)

Options
arc_definition

An input buffer of four points identifying a circular arc in local


coordinates. The subroutine uses it to find the angular position or
sweep of the arc segment about the center (first point). The center of
the arc and the from_pt are used to find the trace radius.

from_pt

An input to identify the measuring start point. It is also used to


compute the radius of the circular arc. Global or local point.

to_pt

An input to identify the measuring end point. This point only


establishes an angular position on the arc determined from the first
two arguments. Therefore, it may or may not be on the arc itself.
Global or local point.

travel_dist

An input to specify the peripheral traversal distance from from_pt to


to_pt.

out_pt

An output location containing the destination point. The direction of


travel if either from_pt or to_pt is off. The curve is given by the
connecting segment from from_pt to to_pt through the arcs end
nearer the off-point.

Example
In the following example, the Get Point call forces the operator to snap only -- to an arc. On return,
the arc definition is obtained in point_2 ... point_5. The length of the arc is then computed by
sending the third call the center (point [2]), start (point [3]), the end (point [5]), and the arc itself.
Finally, the middle point (point [10]) on the arc is calculated by moving along the arc from start
(point [3]) toward the end (point [5]). The distance traveled is one-half the arc's size.

76

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


int2 ret_pt_type, ret_ele_type
.
.
Call Get_Point (pt_snap, point [1], ret_pt_type, ret_ele_type, el_arc)
Call Get_Arc_Point (point [2])
Call Get_Arc_Size (point [2], point [3], point [5], length)
Call Move_Along_Arc (point [2 ], point [3], point [5], length/2, point [10])
! find the middle

Move Along Axis


The Move Along Axis primitive is similar to the Move By Distance primitive except that Move
Along Axis allows you to move the active point a specified distance along any specified axis of
the active orientation.

Syntax
Call Move_Along_Axis (distance, axis)

Options
distance

Variable or constant that defines the distance by which the active point
should be moved.

axis

Keyword defining the axis along which the active point should be moved.
Valid values for axis include:
PRIMARY

NORTH

SECONDARY

SOUTH

NORMAL

UP

EAST

DOWN

WEST

Example
In this example, the active point is moved 24 subunits in the east direction.
Call Define_Active_Orientation (NORTH, EAST)
Call Move_Along_Axis (24., SECONDARY)

Move Along Line


The Move Along Line primitive returns a destination point given the direction of travel, a starting
point, and a distance of travel.

Syntax
Call Move_Along_Line (from_line_end, to_line_end, from_pt, distance,
to_pt)

Options
from_line_end

The starting input point for computing the direction of travel. Global or
local point.

Plant Design System (PDS) Equipment Eden Interface

77

Eden Language Structure


to_line_end

The ending input point for computing direction of travel. Global or local
point.

FROM_LINE_END and TO_LINE_END merely determine the direction and not the
actual path of travel.
from_pt

The input point from which the travel begins. Global or local point buffer.

distance

The input variable containing the distance of travel.

to_pt

The output location variable containing the destination point. Use global
or local point buffer.

Example
In the following example, the code fragment finds the midpoint of the line segment obtained with
two Get Point calls.
.
.
Call Get_Point (pt_snap, point [1])
Call Get_Point (pt_snap, point [2])
Call Get_Line_Size (point [1], point [2], distance)
distance = distance/2
Call Move_Along_Line (point_1, point [2], point [1], distance, point[3])
.
.

Move By Distance
The Move By Distance primitive allows you to move the active point along the primary axis of the
active orientation.

Syntax
Call Move_By_Distance (distance)

Options
distance

Variable or constant that dictates how far along the primary the active point
should be moved. Negative values can be used.

Examples

78

In the following example, the active point is moved 24 subunits in the up direction:
Call Define_Active_Orientation (UP, WEST)
Call Move_By_Distance (24.)

In this example, the active point is moved by the distance defined by the variable dimension_a.
Call Move_By_Distance (dimension_a)

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Move Data
The Move Data primitive writes contents of a variable or expression into another variable.

Syntax
Call Move_Data (source_item, destination_item)

Options
source_item

A variable or expression from which data will be moved without


conversion.

destination_item

Variable into which data will be moved. Length of data moved is


length of the shorter item. If destination_item is a character
variable, each source_item byte must be ASCII (32 or more)
before it is transferred. Otherwise, characters up to but excluding
the first non-ASCII byte make up the destination_item.
This routine is mainly useful for the Read Table primitive where INPUT/OUTPUT contains
CHARACTER fields. The following code segment shows how to access such data:
input_1 = 20
Call Move_Data ('col3_key', INPUT_2) ! INPUT_2 is ASCII field
Call Read_Table ('TABLE_SO_AND_SO', INPUT, OUTPUT ! Read table
Call Move_Data (OUTPUT_4, CSTRING_1) ! output_4 from table is
! ... ASCII. Move it into
! ... global ASCII
! ... variable CSTRING_1

Move To Placepoint
The Move To Placepoint primitive allows you to restore both the active point and orientation to
that of a previously defined place point.

Syntax
Call Move_To_Placepoint (pp)

Options
pp

A keyword specifying the previously defined place point. Valid values include:
PP1 - PP10

Example
In this example, place point 2 is defined with an orientation of primary pointing east and secondary
pointing north. The call Move To Placepoint sets the active point at the location of placepoint 2
and restores the active orientation to east and north.
Call Define_Active_Orientation (EAST, NORTH)
Call Define_Placepoint (PP2, POINT_0)
.
.
.
Call Move_To_Placepoint (PP2)

Plant Design System (PDS) Equipment Eden Interface

79

Eden Language Structure

Place COG
The Place COG primitive allows you to place the center of gravity (COG) for a piece of equipment.
There can be at most two centers of gravity per piece of equipment, each designated by a different
keyword. The call is ignored if no datum points are being placed for the piece of equipment since
the location of the COG is relative to the first datum point. Define Datum Point for dp1 must be
executed before or after this call. Graphics are not created for COGs. Only numeric offsets are
stored with the datum point to indicate the location.

Syntax
Call Place_Cog (cog_type, offset_x, offset_y, offset_z)

Options
cog_type

Keyword specifying the type of center of gravity you want to place. If a cog
type already exists, it is replaced with the new definition. The following
keywords are accepted:
DRY
OPERATING_1
OPERATING_2
LIFTING

offset_x

Distance specifying the easting of the COG in the local coordinate system
of the first datum point.

offset_y

Distance specifying the northing of the COG in the local coordinate system
of the first datum point.

offset_z

Distance specifying the elevation of the COG in the local coordinate


system of the first datum point.

Example
In the following example, the code locates the dry cog for the equipment with easting, northing,
and elevation at 10.0, 20.0, and 30.0 units from pnt[1] in the coordinate system of datum point 1:
location pnt[6]
pnt [1] = 1
pnt [2] = 2
pnt [3] = 3
Call Define_Active_Orientation (WEST, NORTH)
Call Define_Datum_Point (dp [1], pnt [1])
Call Place_Cog (DRY, 10.0, 20.0, 30.0)
Since the location and orientation of the first datum point is known, we see that in symbol local
coordinates, the COG is at:

80

10.0 - 1 = 9.0

WESTING

20.0 + 2 = 22.0

NORTHING

30.0 - 3 =27.0

DOWN

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

Position Cursor
The Position Cursor primitive allows you to position the cursor at an input field on the active
symbol tutorial.

Syntax
Call Position_Cursor (fieldno)

Options
fieldno

A key-in field number on the active tutorial.

Put Field
The Put Field primitive allows you to display a value in a tutorial field. It works similarly to default
expressions. After the value is evaluated, it must correspond to the numeric/character data type
defined for the field.

Syntax
Call Put_Field (value, fldno, ret_code)

Options
value

A variable or expression that evaluates to the value to be input to the field.


Character fields must receive character data, and numeric fields must
receive numeric data. No data conversion between the two types is
performed, and such type mismatch causes errors.

fldno

A field number on the active tutorial. Possible values are 1 - 200 (since
only these fields are defined via TDF). Default computations are also
performed if necessary as a result of fldno being defined.

ret_code

[optional] A numeric variable to receive completion status of the call. If


successful, a 0 is returned. Expect negative values if the call completes
unsuccessfully. Such abnormal return may be possible due to:
Nonexistent field numbers.
Incompatible type conversion.
No tutorial being active.
Errors in computing defaults will be acknowledged only through system
messages in the ER field.
By omitting it, you can ensure that the symbol execution is aborted if the
call fails to successfully complete. In the case of computing defaults, the
call successfully returns.

Example
In the following example, the call puts out 10 in field #2 of the active tutorial. If DIMENSION_2
corresponds to field #2, it also receives a value of 10.0.
Call Put_Field (10, 2)

Plant Design System (PDS) Equipment Eden Interface

81

Eden Language Structure

Read Table
The Read Table primitive allows you to read values from a table for use in your symbol definition.
This process is called a table lookup.
Refer to Reference Data Manager (PD_DATA) Reference Guide for information on the valid
naming formats for tables and the valid units that can be used in tables.

Syntax
Call Read_Table (table_name, INPUT, OUTPUT, return_code)

Options
table_name

Name of the table to be read. This argument can be a string variable


or constant.

INPUT

The global variable name INPUT. Table input parameters must be


defined prior to calling Read Table. The number and type of values
needed in INPUT_1...INPUT_10 array depends on the number and
type of input columns defined for the table. An INPUT_X parameter
may be a number or a character string up to eight characters.
Assigning numerical data to INPUT elements is not a problem.
Character data, however, must be treated differently since INPUT is a
REAL array. Characters cannot be assigned to its variables. You
must use the Move Data primitive. Refer to the Move_Data primitive
for sample usage.

OUTPUT

Global variable name OUTPUT. The table values read are stored in
OUTPUT. You must know the table structure in order to know where
each output from the table is stored. An OUTPUT_X field can be
numeric or alphanumeric (up to eight characters) depending on the
table structure. Refer to the Move Data primitive for accessing
character data once it is retrieved in an OUTPUT_X variable.

return_code

[optional] The output argument allowing symbol execution to continue


if the call fails to read a table. If supplied, the values returned include:
0 - table read successfully
3 - table not in table library / library not attached
6 - invalid inputs for table look-up.

Examples

82

In this example, a table is read obtaining a flange diameter and thickness. The table name is
derived from character constants, the flange generic end prep, and the flange pressure rating.
The table input is the flange nominal pipe size. The flange diameter is taken from global
variable OUTPUT_1, while the flange thickness is taken from global variable OUTPUT_2.
INPUT_1 = Nom_Pipe_D
table = 'BLT' // GEN_TYPE // PR_RATING // '5'
Call Read_Table (table, INPUT, OUTPUT)
flange_diam = OUTPUT_1
flange_thk = OUTPUT_2

In this example, a table is read obtaining the outside diameter of a pipe given the nominal pipe
diameter.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


INPUT_1 = Nom_Pipe_D
Call Read_Table ('MAL_300_5', INPUT, OUTPUT)
pipe_od = OUTPUT_3

Retrieve Nozzle Parameters


The Retrieve Nozzle Parameters primitive allows you to make all parameters for a specified
nozzle the active parameters.

Syntax
Call Retrieve_Nozzle_Parameters (noznum)

Options
noznum

The number that identifies the nozzle whose parameters are to be


made active.
After a call to Retrieve Nozzle Parameters, the following global variables are defined with values
for the nozzle identified by noznum:
END_PREP - the nozzle's end preparation
PR_RATING - the nozzle's pressure rating
NOM_PIPE_D - the nozzle's nominal pipe size
NOZ_LENGTH1 - the nozzle's length (for type 2 and 3 only)
NOZ_LENGTH2 - the nozzle's 2nd length (for type 3 only)
NOZ_RADIUS - the nozzle's bend radius (for type 3 only)
GEN_TYPE - the nozzle's generic end prep
TERM_TYPE - the nozzle's termination type
TABLE_SUFFIX - the current nozzle table suffix
STD_TYPE - the current nozzle standard type
The method by which you can set these variables for each nozzle is discussed in the User
Interface section. Once set, they can be activated in the symbol by calling Retrieve Nozzle
Parameters.

Examples

In this example, the nozzle parameters for nozzle number 3 are activated. Nozzle number 3 is
then placed.
Call Retrieve_Nozzle_Parameters (3)
Call Define_Nozzle ('NOZ2', 3, 1)

In this example, any value you put in the global variable NOZ_LENGTH1 is overridden by the
symbol. In this case, the nozzle projection or length is set to the vessel diameter plus 10
subunits.
Call Retrieve_Nozzle_Parameters (5)
NOZ_LENGTH1 = vessel_dia + 10.
Call Define_Nozzle ('NOZ2', 5, 1)
Only NOZ_LENGTH1, NOZ_LENGTH2, NOZ_RADIUS, and TABLE_SUFFIX can be
calculated as in this example. All other nozzle parameters must be specified by input fields on
a tutorial. NOZ_LENGTH1, NOZ_LENGTH2, NOZ_RADIUS, and TABLE_SUFFIX must be
set after the call to Retrieve_Nozzle_Parameters.
If one of these values is set before the call, it will be lost when the call is made.

Plant Design System (PDS) Equipment Eden Interface

83

Eden Language Structure

Rotate Orientation
The Rotate Orientation primitive allows you to rotate the active local orientation relative to itself.
The coordinate system is rotated about the designated axial direction through the specified angle
according to the right-hand rule. When you call this primitive, you change the local symbol
orientation without affecting the design file coordinate system.

Syntax
Call Rotate_Orientation (angle, axis)

Options
angle

Variable or constant that dictates the amount of rotation.

axis

Keyword that defines the local axial direction about which to rotate.
PRIMARY

NORTH

SECONDARY

SOUTH

NORMAL

UP

EAST

DOWN

WEST

Example
After the last statement is executed, the new primary is oriented down.
Call Define_Active_Orientation (EAST, NORTH)
.
.
.
.
Call Rotate_Orientation (90, SECONDARY)

Start Complex Shape


The Start Complex Shape primitive informs the system that linear elements (line, linestring, arc)
to be placed subsequently are to be accumulated by the system and grouped as a complex shape.
The elements must maintain a continuous flowline when they are sequentially traced through their
vertices or end points. (This is a requirement for MicroStation complex shape elements.) The 0
only supplies a nonempty argument list.

Syntax
Call Start_Complex_Shape (0)

Example
call START_COMPLEX_SHAPE (0)
Call Move_To_Placepoint (PP1)
Call Define_Active_Orientation (NORTH,EAST)
call draw_line (point [1], point [2])
call rotate_orientation (end_angle, normal)
call draw_line (point [2], point [3])

84

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure


Call Move_To_Placepoint (PP1)
Call Define_Active_Orientation (NORTH,EAST)
call draw_line (point [3], point [4])
call rotate_orientation (start_angle, normal)
call draw_arc (inner_dia, inner_dia, 0.0, angle_sweep)!
call STOP_COMPLEX_SHAPE (0)

Call Stop_Complex_Shape must be called to notify the system that the last element in the
complex shape has been defined.
One complex shape can remain in effect for each BEGIN call category, and the system keeps
track of all such complex shapes. A default Stop Complex Shape is executed by the system
following the element placed last inside a BEGIN category. Any number of complex shapes
can be created in a category with pairwise start/stop calls.

Stop Complex Shape


The Stop Complex Shape primitive informs the system that the complex shape under progress is
complete.
One complex shape can remain in effect for each BEGIN call category, and the system
keeps track of all such complex shapes. A default Stop Complex Shape is executed by the
system following the element placed last inside a BEGIN category. Any number of complex
shapes can be created in a category with pairwise start/stop calls.

Syntax
Call Stop_Complex_Shape (0)

Example
call START_COMPLEX_SHAPE (0)
Call Move_To_Placepoint (PP1)
Call Define_Active_Orientation (NORTH,EAST)
call draw_line (point [1], point [2])
call rotate_orientation (end_angle, normal)
call draw_line (point [2], point [3])
Call Move_To_Placepoint (PP1)
Call Define_Active_Orientation (NORTH,EAST)
call draw_line (point [3], point [4])
call rotate_orientation (start_angle, normal)
call draw_arc (inner_dia, inner_dia, 0.0, angle_sweep)!
call STOP_COMPLEX_SHAPE (0)

Plant Design System (PDS) Equipment Eden Interface

85

Eden Language Structure

Store Orientation
The Store Orientation primitive allows you to store and recall orientations.

Syntax
Call Store_Orientation (save_retrieve_flag, orientation_no)

Options
save_retrieve_flag

The value indicating whether active orientation is:


being stored (=2)
recalled (=1)

orientation_no

The orientation location number. Valid values include:


1- 10

local orientation location (known to the current


symbol or user function only).

11- 20

global orientation location (known to all main


symbol and user function calls).

Example
In this example, the call saves the active orientation into local orientation buffer 8. Later, the active
orientation can be restored to its original value:
Call Store_Orientation (2, 8)
.
.
.
Call Store_Orientation (1, 8)

Store Nozzle Parameters


The Store Nozzle Parameters primitive allows you to make the active nozzle parameters the
parameters for a specified nozzle. Before using this primitive, call the Define_Nozzle primitive to
allow you to make modifications at a later time.

Syntax
Call Store_Nozzle_Parameters (NOZNUM)

Options
noznum

The number that identifies the nozzle whose parameters are to be initialized
from the active parameters.

Example
In the following example, the code allows you to modify the NOZ_LENGTH1 of nozzle number 3.
(Refer to the Retrieve_Nozzle_Parameters primitive for more information on nozzle global
variables affected by this primitive.)
Call Retrieve_Nozzle_Parameters (3)
NOZ_LENGTH1=NOZ_LENGTH/2.0
Call Store_Nozzle_Parameters (3)

86

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

User Function
The User Function primitive allows you to call another Eden module compiled as a user function.
The User Function module is similar to a SYMBOL_PROCESSOR module, except the first
statement reads: User_Function_Definition 'MODULE-NAME' where 'module-name' is a
character string (1 to 20 characters) identifying the module being compiled.
The User_Function call causes the system to retrieve and execute the module from the Eden
library. Please note the following conventions:
1. The set of local variables in the calling module is completely separate from that in the called
module. Variables named the same between two modules do not share data or conflict with
one another.
2. Data sharing can be done through the global variables as they are used in common.
3. Calls can be nested to any depth with a user function calling itself or other user functions.

Syntax
Call User_Function (module-name, argument1, argument2,....argument9)

Options
module_name

The name of user function to execute.

argument1 .. argument9

The numeric values to pass to the called user function. These


are optional arguments and can be omitted from the right end.
Values are passed via global variables INPUT_11 through
INPUT_19. These are loaded from the optional arguments.
Unused variables are zeroed out. INPUT_20 contains the
number of optional arguments supplied.
OUTPUT_11 through OUTPUT_20 are zeroed out when a
user function is called. They can also be used to pass results.

The modules are delivered with the Eden Interface allowing you to build certain common
shapes not directly supported by any Eden primitive. These functions make use of the Draw
Complex Surface primitive to create solid shapes by placing arcs and line strings individually.
You can call these user functions much like any other Eden primitive by including arguments in the
User_Function statement. You can obtain the source file name for a particular user function by
adding the extension .UF to the function name.

Plant Design System (PDS) Equipment Eden Interface

87

Eden Language Structure

User Function FLAT_OVAL_PRISM


The FLAT_OVAL_PRISM user function allows you to place a flat oval prism with faces parallel but
offset from each other along both the secondary and normal axes.

It is placed by a point in the middle of the first face. The active primary axis orients the direction of
projection and the normal of both faces. The active secondary axis orients the flat sides of the
faces.

Syntax
Call User_Function ('FLAT_OVAL_PRISM', projlen, length1, depth1, length2,
depth2, offset1, offset2, update_flg)

Options

88

projlen

Length of projection.

length1

Flat segment length of first face.

depth1

Depth of first face.

length2

Flat side length of second face.

depth2

Depth of second face.

offset1

Offset of second face from the first face along the secondary axis.

offset2

Offset of second face from the first face along the normal axis.

update_flg

0:

Dont update active point and orientation upon exit (default).

1:

Update active point and orientation to the opposite face upon


exit.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

User Function FLAT_OVAL_TOR


The user function FLAT_OVAL_TOR allows you to place a flat oval torus.

It is placed by a point in the middle of the starting face. The active primary axis is the normal of the
starting face. The active secondary axis points to the center of rotation, and the active normal axis
is the axis of rotation.

Syntax
Call User_Function ('FLAT_OVAL_TOR', bend_radius, sweep_angle, length,
depth, face_angle, update_flg)

Options
bend_radius

Distance from center of starting face to the center of rotation.

sweep_angle

Revolved angle.

length

Flat segment length of face.

depth

Depth of face.

face_angle

Angle between the flat side of the starting face and the
secondary axis. (For a torus rotated about an axis parallel to the
flat sides, this is 90 degrees. For a torus rotated about an axis
parallel to the curved sides, this is 0 degrees.)

update_flg

0:

Dont update active point and orientation upon exit


(default).

1:

Update active point and orientation to the opposite face


upon exit.

Plant Design System (PDS) Equipment Eden Interface

89

Eden Language Structure

User Function FLAT_OVAL_SEG_TOR1


The FLAT_OVAL_SEG_TOR1 user function allows you to place a segmented flat oval torus.

It is placed by a point in the middle of the starting face. The active primary axis orients the direction
of projection of the first segment and is normal to the first face of the first segment. The active
secondary axis points to the center of rotation. Rotation occurs around the flat sides using the
active normal as the axis of rotation.

Syntax
Call User_Function ('FLAT_OVAL_SEG_TOR1', bend_radius, seg_angle,
num_seg, length, depth, update_flg)

Options

90

bend_radius

Length from center of rotation to middle of starting face (>0).

seg_angle

Angle between segments (between 0 and 180 degrees as


measured between two cross-sections).

num_seg

Number of segments (between 2 and 30 inclusive).

length

Flat segment length of face.

depth

Depth of face (half of this depth must be well within the


bend_radius).

update_flg

0:

Dont update active point or orientation upon exit


(default).

1:

Update active point and orientation to the last face


upon exit.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

User Function FLAT_OVAL_SEG_TOR2


The FLAT_OVAL_SEG_TOR2 user function allows you to place a segmented flat oval torus.

It is placed by a point in the middle of the starting face. The active primary axis orients the direction
of projection of the first segment and is normal to the first face of the first segment. The active
secondary points to the center of rotation. Rotation occurs around the curved sides using the
active normal as the axis of rotation.

Syntax
Call User_Function ('FLAT_OVAL_SEG_TOR2', bend_radius, seg_angle,
num_seg, length, depth, update_flg)

Options
bend_radius

Length from center of rotation to middle of starting face (>0).

seg_angle

Angle between segments (between 0 and 180 degrees as


measured between two cross-sections).

num_seg

Number of segments (between 2 and 30 inclusive).

length

Flat segment length of face.

depth

Depth of face (half of this depth must be well within the


bend_radius).

update_flg

0:

Dont update active point or orientation upon exit


(default).

1:

Update active point and orientation to the last face upon


exit.

Plant Design System (PDS) Equipment Eden Interface

91

Eden Language Structure

User Function ROUND_SEG_TOR1


The user function ROUND_SEG_TOR1 allows you to place a segmented round torus.

It is placed by a point in the middle of the starting face. The active primary axis orients the direction
of projection of the first segment and is normal to the first face of the first segment. The active
secondary points towards the center of rotation, and the active normal defines the axis of rotation.
Cylinders are used to represent the segments.

Syntax
Call User_Function ('ROUND_SEG_TOR1', bend_radius, seg_angle, num_seg,
radius, update_flg)

Options
bend_radius

Length from center of rotation to middle of starting face (>0).

seg_angle

Angle between segments (between 0 and 180 degrees as


measured between two cross-sections).

num_seg

Number of segments (between 2 and 30 inclusive).

length

Flat segment length of face.

depth

Depth of face (half of this depth must be well within the


bend_radius).

update_flg

0:

Dont update active point or orientation upon exit


(default).

1:

Update active point and orientation to the last face


upon exit.

HLINE in certain views may not work cleanly around the junction of segments placed with
this user function. User function ROUND_SEG_TOR2, however, works correctly with HLINE even
though it is more expensive in terms of design file space.

92

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

User Function ROUND_SEG_TOR2


The user function ROUND_SEG_TOR2 allows you to place a segmented round torus.

It is placed by a point in the middle of the starting face. The active primary axis orients the direction
of projection of the first segment and is normal to the first face of the first segment. The active
secondary points towards the center of rotation, and the active normal defines the axis of rotation.
Projected shapes are used to represent the segments.

Syntax
Call User_Function ('ROUND_SEG_TOR2', bend_radius, seg_angle, num_seg,
radius, update_flg)

Options
bend_radius

Length between center of rotation and center of starting face


(>0).

seg_angle

Angle between segments (between 0 and 180 degrees as


measured between two cross-sections).

num_seg

Number of segments (at least 2).

radius

Cross-sectional radius of any segment (this value must be well


within the bend_radius).

update_flg

0:

Dont update active point or orientation upon exit (default).

1:

Update active point and orientation to the last face upon


exit.

Plant Design System (PDS) Equipment Eden Interface

93

Eden Language Structure

User Function RECT_SEG_TOR


The user function RECT_SEG_TOR allows you to place a segmented rectangular torus.

It is placed by a point in the middle of the starting face. The active primary axis orients the direction
of projection of the first segment, and the normal of the first face of the first segment. The active
secondary axis points to the center of rotation. The active normal defines the axis of rotation.

Syntax
Call User_Function ('RECT_SEG_TOR', bend_radius, seg_angle, num_seg,
length1, length2, update_flg)

Options

94

bend_radius

Distance between center of rotation and center of first face (>0).

seg_angle

Angle between segments (between 0 and 180 as measured between


cross-sections).

num_seg

Number of segments (at least 2; at most 30).

length1

Length of face along the secondary axis.

length2

Length of face along the normal axis.

update_flg

0:

Dont update active point and orientation upon exit (default).

1:

Update active point and orientation to the last face upon exit.

Plant Design System (PDS) Equipment Eden Interface

Eden Language Structure

User Function RECT_FLAT_OVAL


The user function RECT_FLAT_OVAL allows you to place a rectangular to flat oval transitional
element with faces parallel but offset from each other along both the secondary and normal axes.

It is placed by a point in the middle of the rectangular face. The active primary axis orients the
direction of projection and the normal of each face. The active secondary orients the flat sides of
the flat oval shape.

Syntax
Call User_Function ('RECT_FLAT_OVAL', projlen, length1, depth1, length2,
depth2, offset1, offset2, update_flg)

Options
projlen

Length of projection.

length1

Length of rectangular face along the secondary axis.

depth1

Depth of rectangular face along the normal axis.

length2

Flat segment length of flat oval face along the secondary axis.

depth2

Depth of flat oval face along the normal axis.

offset1

Offset of flat oval face from rectangular face along the secondary axis.

offset2

Offset of flat oval face from rectangular face along the normal axis.

update_flg

0:

Dont update active point or orientation upon exit (default).

1:

Update active point and orientation to the flat oval face upon exit.

Plant Design System (PDS) Equipment Eden Interface

95

Eden Language Structure

User Function ROUND_RECT


The user function ROUND_RECT allows you to place a round to rectangular transitional element
with faces parallel but offset from each other along both the active secondary and normal axes.

It is placed by a point in the middle of the round face. The active primary axis orients the direction
of projection and the normal of each face. The active secondary axis orients a flat side of the
rectangular face.

Syntax
Call User_Function ('ROUND_RECT', projlen, radius, width, depth, offset1,
offset2, update_flg)

Options

96

projlen

Length of projection.

radius

Radius of round face.

width

Width of rectangular face along the secondary axis.

depth

Depth of rectangular face along the normal axis.

offset1

Offset of rectangular face from round face along the secondary axis.

offset2

Offset of rectangular face from round face along the normal axis.

update_flg

0:

Dont update active point and orientation upon exit (default).

1:

Update active point and orientation to the rectangular face upon exit.

Plant Design System (PDS) Equipment Eden Interface

SECTION 3

Creating a New Equipment Component


Setup for Equipment
Before a new equipment component can be defined through Eden, the following items must be
performed:
1. Log in to the server where the PDS project resides.
2. Create a directory for the equipment symbol definition files, for example:
c:\projects\custom\eqpsym
3. Create a directory for the tutorial definition files (TDF), for example:
c:\projects\custom\tdf
4. Create a directory for the graphic libraries, for example:
c:\projects\custom\libs
5. Copy the standard delivered equipment libraries into the created library directory, for
example:
copy c:\win32app\ingr\pdeqp\*.l* c:\projects\proj1\libs\.
6. Access the Reference Database Defaults form, and define the node name and path to the
directories previously defined.
Start the PD_Shell main form.
Select the project and select the Reference Data Manager option.
Select the Default Project Control Data option.
Key in the path and node name for the created directories.
Equipment Eden Path:

c:\projects\custom\eqpsym\

Equipment Eden node:

<server name>

TDF Table Path:

c:\projects\custom\tdf\

TDF Table node:

<server name>

7. Access the Database Library File Manager form, and define the node name and directory path
for the graphic data and table libraries. When testing new libraries in a live project, it is
recommended to enter them as Not Approved.
From the main PDS form, select the Equipment Modeling option.
Select the Database Library File Manager option.
Make sure that the node name and directory paths for all libraries are pointing to the right
location. Also make sure that the library specifications are correct. For a U.S. standards
project, the following specifications could be used:
Graphic Commodity Lib

zi_eqpms.lib

Tutorial Definition Lib

zi_tutlib.lib

The network address and directory paths for the previous two should be the ones
specified in the sections above.

Plant Design System (PDS) Equipment Eden Interface

97

Creating a New Equipment Component


Piping Physical Data Lib

us_pcdim.l

Piping Standard Note Lib

std_note.l

Piping Job Spec Table

us_pjstb.l

The network address and directory paths for the previous three can be the locations
defined for the project through the Reference Data Manager option.
Cell Lib

c:\win32app\ingr\pdeqp\dat\equip.cel

Forms Dir.

c:\win32app\ingr\pdeqp\<blank>

The network address for the previous two should be a server to which all workstations
running PDS can mount.

To revise an entry, follow these steps:


1.
2.
3.
4.
5.

Identify the library to be checked.


Place the cursor at the beginning of the key-in field of the entry to correct.
Delete to the right of the cursor.
Key in the correct value and press the return key.
Accept the form when all the data for that single library is correct.

Default Project Control Data


This form allows you to define the default location for common reference files used by the project
(such as neutral files, report files, and library files). You can change these file locations during the
operation of the applicable managers.
This form is accessed through reference data manager, not PD_EQP.

98

Plant Design System (PDS) Equipment Eden Interface

Creating a New Equipment Component


Operating Sequence
1. Select the field to be defined, and key in the location of the source files and the associated
node name.
Piping Eden Path / Node
The default location for the Eden source files.
Eden Table Path / Node

The default location of the Dimension Table and Spec


Table source files.

Piping Spec Path / Node

The default location for the neutral files to be used to


load the Specification/Material Reference Database.

Assembly Path / Node

The default location for the Piping Assembly


Language source files.

Standard Note Library

The default location for the Standard Note (code list)


source files.

Equipment Eden Path /


Node

The default location for the Equipment Eden source


files.

TDF Table Path / Node

The default location for the Equipment table definition


files.

Model Builder Path / Node

The default location for the model builder language


source files.

2. Select the Confirm () button to accept any changes to the Project Control Data.

Extracting Sample Modules


When defining a new component, the first step is to have a sketch of the graphic symbol that will
be used to represent that component. Since the equipment modeling software has various items
from basic shapes to complex components available for placement, the Eden modules for existing
equipment can be extracted and used as models to define new components.
To extract the Eden modules for existing equipment, the item's symbol processor name has to be
known. To retrieve the symbol processor name (also referred to as the component's Eden
number), follow these steps:
1. Turn to Appendix E, Parametrics of this document.
2. Find the equipment parametric that would require the least number of modifications to make it
appear as the graphics that will represent the new item.
3. The Eden number appears listed between parenthesis next to the equipment parametric title
(for example, through Ladder A (A021)).
Once the Eden number is known, you can extract the symbol processor for the existing item.
To extract the Eden module for the symbol processor, follow these steps:
4. Select the Equipment Modeling option from the main PDS form.
5. Select the Graphic Library Manager option.
6. Select the Eden Data Management option.
7. Select the Extract option.
8. Identify the symbol processor from the form, and select Confirm ().
The system places the extracted modules in the symbols directory, eqpsym (or equivalent),
previously created during setup.
To create a new component's Tutorial Definition File (TDF), turn to the example in this document's
first chapter or extract a sample TDF by following these steps:

Plant Design System (PDS) Equipment Eden Interface

99

Creating a New Equipment Component


1.
2.
3.
4.

Select the Equipment Modeling option from the main PDS form.
Select the Graphic Library Manager option.
Select the Tutorial Definition Data Management option.
Select the Extract option.

5. Identify the TDF from the form, and select Confirm ().
The system places the extracted tables in the tdf directory created during setup.

Editing Modules
After the Eden modules and TDF tables for existing components have been extracted, they can be
used as models or modified as needed to make them generate a new component.
It is recommended that the TDF and the form be created concurrently so that the symbol
processor can be written to match the TDF and the form. Refer to the end of this chapter for
information about form creation. To write user input into the database tables of equipment, the
TDF table should include an entry for each attribute. Refer to the Equipment Eden Basics chapter
to review the details about the TDF file.

Compiling New Modules


To compile newly created Eden modules they should be loaded to the existing graphic commodity
library. New modules are compiled as they are loaded. If everything is correct in the code and
compilation is completed, the new modules are incorporated into the graphic commodity library.

Follow these steps to load and compile new Eden modules:


1.
2.
3.
4.
5.

Select the Equipment Modeling option from the main PDS form.
Select the Graphic Library Manager option.
Select the Eden Data Management option.
Select the Add/Replace option.
Identify the symbol processor's file name from the form. (For the system to be able to display
new modules, their file name should have the .eqp extension.)
6. Select the Add/Replace Selected Files option.
The system compiles and loads the new Eden module.
7. If compilation errors occur, take note of the error messages, fix the symbol processor's file,
and then repeat the preceding steps.

To load a new component's Tutorial Definition File (TDF), follow these steps:
1.
2.
3.
4.
5.

Select the Equipment Modeling option from the main PDS form.
Select the Graphic Library Manager option.
Select the Tutorial Definition Data Management option.
Select the Add/Replace option.
Identify the TDF from the form. (For the system to be able to display new TDF files, their file
name should have the .tdf extension.)
6. Select the Add/Replace Selected Files option.
The system loads the new TDF.

100

Plant Design System (PDS) Equipment Eden Interface

Creating a New Equipment Component

Revising Modules
After the Eden modules of a new component have been defined, place the new component in the
equipment modeling environment to verify that it places correctly. Should the component not
place correctly, follow these steps to revise the incorrect Eden module:
1. Select the Equipment Modeling option from the main PDS form.
2. Select the Graphic Library Manager option.
3. Select the Eden Data Management option
4. Select the Revise option.
5. Identify the symbol processor's file name from the form.
6. Select the Revise Selected File option.
The system brings the file up on the screen.
7. Proceed to make the needed changes. Then save the file, and exit the editor.
8. Use the Add/Replace option to reload and compile the file just edited.
9. Return to the equipment modeling environment, and test placing the new component.

To revise a new component's Tutorial Definition File (TDF), follow these steps:
1.
2.
3.
4.

Select the Equipment Modeling option from the main PDS form.
Select the Graphic Library Manager option.
Select the Tutorial Definition Data Management option.
Select the Revise option.

5. Identify the TDF from the form, and select Confirm ().
The system displays the file.
6. Make the needed changes. Then save the file, and exit the editor.
7. Return to the equipment modeling environment, and test placing the new component.

Basic Use of Forms


The DBACCESS product is used to create the forms needed to interact with the operator. When a
new equipment item is defined through Eden some form customization may be required to make
the new item accessible to the users.
The fastest way to generate a new form or add a new option within an existing form is to copy and
edit a standard delivered form. The following general procedure can serve as a guideline when
creating a form that is to be linked to a new equipment item. Refer to the DBACCESS
documentation for detailed information on using this product.
1. Create a working directory for modifying forms. This should be done on a workstation that has
PDS loaded, or that has access to the server where PDS products are loaded
For example, c:\name\forms
2. Copy a form used to place an existing component to the new forms directory. (Notice that the
name of the form is the same as the component's Eden number plus the .fb extension.)
copy c:\win32app\ingr\pdeqp\forms\A001 forms\.
3. From the forms directory, access the DBACCESS interface.

Plant Design System (PDS) Equipment Eden Interface

101

Creating a New Equipment Component


If you are familiar with the procedures used in piping and equipment modeling for identifying,
accepting, and rejecting a selection using the mouse, you will find it easy to follow the prompts
provided for each of the DBACCESS commands.

Input Fields
Input fields can be used to collect several types of input:
Dimensional input
Angular input
Integer input
Nozzle dimensions
Nozzle database attributes
Equipment database attributes
Character data input.
The system assigns a unique field number to each input field. The tutorial definition table relays to
the Equipment Modeling product what input type corresponds to a particular field number.

System-Defined Field Numbers


Field numbers 201 through 256 are reserved for system use. At present, nine of these reserved
numbers have been defined:

102

201

Collects the place point by which a parametric is to be placed. If a


field numbered 201 is placed on a tutorial, you can key in the place
point number.

202 203 204

Collect and display the current active point. If fields with these
numbers are placed on the tutorial, when the tutorial is activated, the
active point (x, y, and z respectively) is displayed. You can also key in
a new value for the active point into these fields. When a new active
point is established by any other means, this display is automatically
updated.

205 206 207

Collect the delta (x, y, and z respectively) from the current active
point.

208

Defines the angle from site north to equipment 0 degrees.


For vertical equipment, the angle between site north and
equipment 0 degrees is measured with respect to the secondary
axis of the orientation tee. The primary axis of the orientation tee
always points up.
For horizontal equipment, the angle between site north and
equipment 0 degrees is measured with respect to the primary
axis of the orientation tee. The secondary axis of the orientation
tee always points up.

209

Defines the slope in terms of subunits per master unit of travel. The
orientation tee is sloped from the horizontal with regard to sign. (An
input of :6 in an English file would be interpreted as 6 inches per foot
of travel and displayed in the tutorial as 6 in/ft.)

Plant Design System (PDS) Equipment Eden Interface

Creating a New Equipment Component


System-defined fields must be present in the tutorial definition table when they are present in a
tutorial. You need only input the field number for these entries. All other columns in the table can
be left blank or null. For example:

Example
201, , , , , '', ''
or
201,0,0,0,0,'',''

Application Commands
Equipment tutorials can contain application commands as well as input fields. The two most
important application commands that appear on every tutorial are ACCEPT and EXIT.
ACCEPT

Allows you to accept the data you keyed into the tutorial.

EXIT
Allows you to exit a tutorial with or without saving any modifications.
There are two types of application commands: user-defined and system-defined. System-defined
application command numbers are predefined. User-defined application command numbers are
calculated.

User-Defined Application Commands


User-defined application command numbers are used only for moving the keyboard cursor to a
specific input field. This is accomplished by using an application command number of 3000 plus
the number of the input field. For example, the application command number needed to move the
cursor to field 5 on the form would be 3005.
A user-defined application command is usually placed physically on top of the input field to which
it applies. Thus, if you want to move the cursor to a specific input field, you need only select that
field with a <D>, and the cursor will move to that particular field. You can also select the field from
the sketch on the form. There is no restriction on using a given application command number in
more than one place on the form. It is possible to have one command on top of the input field and
another located in some other area on the form.

System-Defined Application Commands


The system-defined application command numbers are outlined as follows:
Command
number

Description

4001

EXIT from tutorial

4002

ACCEPT tutorial inputs

4011

Place by place point 1

4012

Place by place point 2

4013

Place by place point 3

4014

Place by place point 4

4015

Place by place point 5

Plant Design System (PDS) Equipment Eden Interface

103

Creating a New Equipment Component


Command
number

Description

4016

Place by place point 6

4017

Place by place point 7

4018

Place by place point 8

4019

Place by place point 9

4020

Place by place point 10

4021

Orient active axis EAST

4022

Orient active axis NORTH

4023

Orient active axis UP

4024

Orient active axis WEST

4025

Orient active axis SOUTH

4026

Orient active axis DOWN

4031

Change axis of rotation

4032

Swap orientation

4033

Invert axis

COMMAND numbers 4021 through 4033 duplicate functions that are already on the
Equipment Modeling command menu. They are provided here strictly for convenience. The
commands on the menu are still active when a form is active.
4051 to 4999

Application commands in this range have been set aside for terminated
application command fields. If you select such a box with the data button,
control returns to the symbol, which then decides how to handle the input.
The information needed for the symbol as to the type and number of last
input is saved by the system in global variables before return takes place.
Refer to the DISPLAY_TUTORIAL primitive for more information.

Additional Features of the Form Interface


While a symbol placement form is active you can adjust the active point by:
Snapping to an existing graphic.
Selecting a Precision Point command.
Boresite locating a key point.
or you can adjust the active orientation by:
Boresite locating a key point.
Pressing <R> to rotate the active axis by 90 degrees.
Selecting a Refresh Manipulation command.
All MicroStation 32 and PDS commands that manipulate views can be selected. However, before
continuing with form selections after view manipulations, you must first press <R> to exit the view

104

Plant Design System (PDS) Equipment Eden Interface

Creating a New Equipment Component


command. Refer to the PDS Equipment Modeling (PD_EQP) Reference Guide for more
information on placing equipment.

Plant Design System (PDS) Equipment Eden Interface

105

SECTION 4

Defining Symbols
The previous sections explained the tools that you need to completely define an equipment
symbol. This section outlines the basic steps you need to follow using these tools to prepare a
complete symbol definition. The definition of a simple horizontal drum will be developed to
illustrate the concepts.

Basic Steps:
1. Determine what the component will look like and what primitive graphics elements you want to
use to create it. For example, you want to define a drum that is composed of a cylinder, 2
semi-elliptical heads, and 2 projected rectangles to represent the saddle type supports.
2. Determine what dimensional inputs should be required for placing a symbol based on
availability. A symbol cannot be efficiently placed if, in order to provide inputs for a symbol,
you perform hand calculations based on numbers from drawings.
For the horizontal drum, you need the drum diameter, the tan-tan length of the drum, the
support locations relative to a tangent line, and the support projection and thickness. Assume
that the drum heads are 2:1 semi-elliptical and that the support width is .866 of the drum
diameter.
3. Determine where place points are needed for the symbol and reasonable orientations for
them. Again, consider the documents the symbol user is working from. Place points should be
located on the equipment in places that can be located on a drawing that orients the
equipment on the plot.
On the drum, one reasonable place point location is at one of the tangent lines on the
centerline. The place point orientation should be pointing inside the drum so that when the
symbol is placed, the refresh tee primary will indicate the direction the symbol will be placed.
In addition, the place point secondary axis should be oriented in the down direction so that the
refresh tee secondary can be used to orient the supports.
Another reasonable place point location on the drum is at the bottom center of one of the
supports. At this place point, the primary points into the support, and the secondary orients the
direction that the drum will be placed by pointing it at the other support.
4. Assign global variables to the input. This step allows design of the tutorial for the symbol.
Variables should be assigned as follows:
DIMENSION_1 - drum tan-tan length
DIMENSION_2 - drum diameter
DIMENSION_3 - tangent line to center of first support
DIMENSION_4 - center of first support to center of second support
DIMENSION 5 - support projection from drum centerline
DIMENSION 6 - thickness of support saddle
5. Develop the symbol code.
For the drum, the following code is needed:
SYMBOL_PROCESSOR HDRUM
tutnam = HDRUM
call DISPLAY_TUTORIAL (tutnam)

Plant Design System (PDS) Equipment Eden Interface

107

Defining Symbols
tantan= DIMENSION_1
diameter = DIMENSION_2
support_1 = DIMENSION_3
support_2 = DIMENSION_4
supp_proj = DIMENSION_5
supp_thk = DIMENSION_6
dish_depth = diameter /4
supp_wdth = diameter * .866
call DEFINE_ACTIVE_ORIENTATION (WEST, DOWN)
call DRAW_SEMI_ELLIPSOID (diameter, dish_depth)
call DEFINE_ACTIVE_ORIENTATION (EAST, DOWN)
call DEFINE_PLACEPOINT (PP1, ACTIVE_POINT)
call DRAW_CYLINDER (tantan, diameter)
call DRAW_SEMI_ELLIPSOID (diameter, dish_depth)
call MOVE_TO_PLACEPOINT (PP1)
call MOVE_BY_DISTANCE (support_1)
call DEFINE_ACTIVE_ORIENTATION (DOWN, SOUTH)
call DEFINE_POINT (POINT_1, ACTIVE_POINT, 0., 0., 0.)
call DRAW_PROJ_RECTANGLE (supp_wdth, supp_thk, supp_proj)
call DEFINE_ACTIVE_ORIENTATION (UP, EAST)
call DEFINE_PLACEPOINT (PP2)
call DEFINE_ACTIVE_POINT (POINT_1)
call DEFINE_ACTIVE_ORIENTATION (EAST, DOWN)
call MOVE_BY_DISTANCE (support_2)
call DEFINE_ACTIVE_ORIENTATION (DOWN, SOUTH)
call DRAW_PROJ_RECTANGLE (supp_wdth, supp_thk, supp_proj)
STOP
END
Explanation:
In the above example, the SYMBOL_PROCESSOR statement and the STOP and END
statements of the symbol definition are required.
The drum's orientation along the east-west axis of the symbol coordinate system is arbitrary. It
can just as easily be oriented along the north-south axis.
Building the drum is similar to building the same piece of equipment using primitives in
graphics. First, locate the active point. Then set the active orientation. Finally, place the
primitive. Movement of the refresh tee after placement of the primitive is analogous to
movement of the active point after placement of graphics in the Eden definition.
6. Compile the symbol.
7. Create the form.
8. Create the tutorial definition table.
For the drum, the following table might be used:

108

1,

1,

1,

2,

' ',

'LENGTH'

2,

1,

2,

2,

' ',

'DIAMETER'

3,

1,

3,

2,

' ',

'SUPP_1'

4,

1,

4,

2,

F1/5,

'SUPP_2'

5,

1,

5,

2,

F1-F3,

'SUPP_PRJ'

6,

1,

6,

2,

F2/2+10,

'SUPP_THK'

Plant Design System (PDS) Equipment Eden Interface

Defining Symbols
7,

8,

1,

2,

6,

'EQPNAME'

9. Insert the tutorial definition table into the tutorial definition library.
10. Test and debug the symbol. Three tutorials, provided and serviced by the system, can be of
use during debugging.
DEBUG1
You can display this tutorial several times in a single symbol
allowing you to monitor variables DIMENSION_1 through
DIMENSION_100 while a symbol is executing. This tutorial will
also allow you to change values that are assigned to these
variables.
DEBUG2

Allows you to monitor and change all of the variables associated


with nozzles. You can also display this tutorial several times.

DEBUG3

Allows you to monitor the active point, active orientation, and all of
the point buffers.

11. To activate the debug tutorials, place the following call in your symbol definition:
Call DISPLAY_TUTORIAL ('DEBUGn')
where n = 1, 2, or 3.
12. If you want to debug the symbol interactively, call up the symbolic Eden Debugger when the
symbol executes.

Plant Design System (PDS) Equipment Eden Interface

109

Defining Symbols

110

Plant Design System (PDS) Equipment Eden Interface

SECTION 5

Eden Debugger
Debugging Eden symbols can be time-consuming depending on the length and complexity of the
symbol. Sometimes it is necessary to study symbol execution source line by source line to track
down a bug. This can involve examining the contents of critical variables undergoing modification.
One way of locating a bug is by inserting temporary tracer calls in the DISPLAY_MESSAGE
primitives. This allows you to display a variable and the location of the diagnostic. However, this
method of debugging is disruptive, time-consuming, and can introduce more bugs into your
symbol code.
The Eden Debugger is part of the current Equipment Modeling software and can assist you in
testing symbols efficiently and thoroughly. When using the Debugger, you can step through the
symbol as it executes, examine or modify variables directly, and choose the source line number to
execute next. All this can be done without modifying your original source code.

Invoking the Debugger


You can activate the Debugger in the Start, Add, Modify, or Modify & Copy commands at the
symbol name prompt or any time the symbol tutorial is active. To activate the Debugger, key in:
ON DEBUG
If you key in ON DEBUG at the symbol name prompt and after a symbol name is accepted, the
Debugger displays the source of the module and then prompts for the next input.
If you key in ON DEBUG when the tutorial is active, the Debugger takes control after you return from
the tutorial to the symbol. An arrow positioned by a source line indicates which line is to be
executed next.
When the symbol form is active, you must key in the command from the MicroStation key-in
field and not from a tutorial field.

Exiting the Debugger


You can use the key-in OF DEBUG (off debug) to stop the debugger. This must be keyed in in the
MicroStation Command Window.

Plant Design System (PDS) Equipment Eden Interface

111

Eden Debugger

Concurrent Display
Graphics resulting from symbol execution are not visible until you execute a Return/Stop/End
statement. During debugging, it is sometimes useful to relate each DRAW call to the resulting
graphics. For this reason, the concurrent display feature is provided. To display the graphics at the
time of the CALL to a DRAW or PLACE routine, turn ON both the DEBUG and DISP mode.
You can place the displayed graphics in the design file by keying in OF DISP just before the
symbol code returns and the Eden buffer processing begins.

Debugger Commands
The Debugger is not case sensitive except for the Call Tutorial command. Embedded blanks are
compressed out from any input line before the line is interpreted. The Debugger currently supports
the following functions:
Set Line Break (B)
Call Tutorial (C)
Deposit into Local Variable (DL)
Deposit into Global Variable (DG)
Examine Local Variables (EL)
Examine Global Variables (EG)
Examine Breaks (EB)
Examine Symbol Name (ES)
Move to Specific Source Line or Continue (Go)
Access On-line Help (H)
Step through Source Code (S)
Step into User Function (SI)
Switch the Prompt Terminal (P)
Switch Modes (ON and OF)
Examine Specific Source File Segments (Type)

Switch Modes (ON and OF)


Switch statements begin with ON or OF commands. The ON command allows you to turn on the
Debugger and the File Displayer mode of graphics placement.

Syntax
ON
ON
OF
OF

DEBUG
DISP
DEBUG
DISP

Options
DEBUG

Invokes the Debugger.

DISP

Allows only symbol execution graphics to be displayed (via FILE DISPLAYER)


and to not be actually placed in the design file.
The switch commands are accepted:
In the Start and Add command when the system prompts you for the primitive/parametric
name.

112

Plant Design System (PDS) Equipment Eden Interface

Eden Debugger

At the MicroStation key-in field when a symbol tutorial is active.


At a Debugger prompt.

Set Line Break (B)


The Set Line Break command allows you to interrupt processing at a specified line. You can set
up to 10 breaks per module. To examine the breaks set in the current module, key in E breaks or
E b.

Syntax
B lineno

Options
lineno

A valid line number in the executing module. When the execution reaches the
lineno, the debugger stops processing and prompts you for the next command.

Example
The following example allows the Debugger to break at line 5.
b 5
To cancel this break, key in b -5.

Call Tutorial (C)


You must exit these tutorials before the Debugger reprompts.

Syntax
C DEBUGx

Options
x

Examines/modifies global variables DIMENSION_1..DIMENSION_100.

Examines/modifies nozzle attributes.

Examines/modifies active_point, active_orientation, and POINT_1


...POINT_24.
The tutorial name must be in upper case.

Plant Design System (PDS) Equipment Eden Interface

113

Eden Debugger

Deposit Global (DG)


The Deposit Global command allows you to modify values of global DIMENSION variables.

Syntax
DG dimension_# = value

Options
dimension_#

A global variable 1 ... 100.

Example
In the following example, the system places a value of 10.0 into DIMENSION_5:
DG 5 = 10.0

Deposit Local (DL)


The Deposit Local command allows you to modify the values of local variables.
Only numeric type local variables can be modified.

Syntax
DL variable = value

Options
variable

The name of a local variable in the module.

Example
In the following example, the system places a value of 20.0 into RADIUS:
DL RADIUS = 20.0

Examine Local Variables (EL)


Syntax
EL var1:var2

Options
var1
var2

Alphanumeric character strings defining a valid lexical range of identifiers.


The Debugger responds by listing the values of variables whose names are
bracketed by var1 and var2.

Examples

114

In the following example, the command keyin displays all the local variables whose names
start with A through Z:
EL A:Z

To examine a single variable, you can drop the semicolon and var2. In the following example,
the system examines only the variable radius:

Plant Design System (PDS) Equipment Eden Interface

Eden Debugger
EL radius

The Debugger can display the entire array of 10 elements. In the following example, values is
declared as R8 values [10]:
EL values

In some cases, a local array may start from an element other than 1. The syntax establishes
var1 as the name of the local array and var2 as the subscript from which to examine the array.
In the following example, the Debugger allows you to examine lengths [4] ... lengths [10] of the
array declared as R8 lengths [10]:
EL lengths:4

Examine Global Variables (EG)


The Examine Global Variables command allows you to review the global variables DIMENSION,
POINT, CSTRING, PP, INPUT, and OUTPUT via the Debugger.

Syntax for DIMENSION


Eg dimension_#1:dimension_#2
-OREg dimension_#

Options
dimension_#
dimension_#1
dimension_#2

numbers from 1 through 100

Example
The following example displays the contents of DIMENSION_1 ... DIMENSION_5.
EG 1:5

Syntax for POINT


EG PT x

Options
x

Number from 1 through 125.

Example
In the following example, the system displays the value of POINT [120] in subunits. The system
also displays the coordinate system (6-point star) at POINT [x] location in design file coordinates.
EG pt 120

Syntax for CSTRING


EG CSTR x

Options
x

Number between 1 and 40.

The string length in CSTRING_X is indicated by the space between the two double quotes ("---").

Plant Design System (PDS) Equipment Eden Interface

115

Eden Debugger
Example
After executing the key-in CSTRING [2] = 'This is an example', you can examine cstring_2 by
keying in EG cstr 2. The system displays: CSTRING_2: "This is an example".
The lengths of strings stored in CSTRING variables are important for proper functioning of string
operations such .EQ., .LE., .GT. and so forth.

Syntax for PP
Eg PP x

Options
x
A number between 0 and 10.
The value for the particular placepoint is displayed in local coordinates while the refresh tee is
shown at the placepoint's location in design file coordinates. When x is 0 (Eg pp0), the symbol
active point and active orientation are displayed.

Syntax for INPUT and OUTPUT


EG input
EG output

Examine Symbol Name (ES)


The Examine Symbol Name command allows you to display the symbol name or its source file.
The system displays the full source file and module name.

Syntax
E Source
E s

Examine Source File Segments (TYPE)


The TYPE command allows you to examine various segments of the source file.

Syntax
T from_line# : to_line#

Options
from_line#

Source line number from which the viewed segment


starts.

to_line#

Line number ending the viewed segment.

Examples

116

The following example displays a window of source lines containing line#.


T line#

The following commands display a source file segment containing only the current line.
T
Type

Plant Design System (PDS) Equipment Eden Interface

Eden Debugger
Displays a source file segment scroll bar containing the current line.

Move to Specific Source Line or Continue (Go)


The Go command allows you to direct the DEBUGGER to a particular source line. The
DEBUGGER goes directly to line# and displays a window of source lines around line#. The
DEBUGGER prompts you for more input. This format of the Go command allows you to override
the normal control flow and execute the source statements selectively. The Go command also
allows the DEBUGGER to start executing from a current source line until it encounters a break.
Keying in Go and pressing a carriage return will break you out of the source code.

Syntax
G line#
or
Go line#

Options
line#

Valid executable source line number between 1 and 1500.

Step through Source Code (S)


This command allows you to execute a number of statements in the usual order before the
Debugger prompts you again.

Syntax
S #_of_lines

Options
#_of_lines

Number of lines you want to execute before being reprompted. If


#_of_lines is 1, the #_of_lines parameter can be omitted.

Step into User Function (SI)


The Step into User Function command allows you to step into a user function module. The
command is executed when the current-line arrow points to a "call USER_FUNCTION ('abcd')"
statement. The screen is refreshed with source lines from the newly activated module. All
commands are interpreted in the new context until a return/stop/end statement is executed. The
DEBUGGER then returns to the calling module as does the control.

Syntax
SI

Plant Design System (PDS) Equipment Eden Interface

117

Eden Debugger

Switch the Prompt Terminal (P)


The Debugger accepts input from the form.
The current Start, Add, Modify, or Modify & Copy commands can be canceled during a
Debugger prompt only when the prompt terminal is MicroStation.

Syntax
P

118

Plant Design System (PDS) Equipment Eden Interface

APPENDIX A

Appendix: Codelist (CL330)


Use 2-199 for bolted types 300-399 for male types and 400-599 for female types. Refer to
the Reference Data Manager (PD_DATA) Reference Guide for more information.
1

[Blank]

FE

[Flanged end]

Use 11-15 for ends without integral gaskets and 16-19 for ends with integral gaskets.

10

FFTP

Flat-face Flanged Termination tyPe (11-19)

11

FFFE

Flat-Face Flanged End

16

FFFEWG

Raised-Face Flanged End With integral Gasket

Use 21-25 for ends without integral gaskets and 26-29 for ends with integral gaskets.

20

RFTP

Raised-face Flanged Termination tyPe

21

RFFE

Raised-Face Flanged End

26

RFFEWG

Raised-Face Flanged End With integral Gasket

Use 31-35 for ends without integral gaskets and 36-39 for ends with integral gaskets.

30

RJFTP

RJT-face Flanged Termination tyPe (31-39)

31

RJFE

RJT-face Flanged End

Use 41-45 for ends without integral gaskets and 46-49 for ends with integral gaskets.

40

TMFTP

Tongue/Male-face Flanged Termination tyPe (41-49)

41

STFE

Small-tongue-face Flanged End

42

LTFE

Large-tongue-face Flanged End

43

SMFE

Small-Male-face Flanged End

44

LMFE

Large-Male-face Flanged End

Use 51-55 for ends without integral gaskets and 56-59 for ends with integral gaskets.

Plant Design System (PDS) Equipment Eden Interface

119

Appendix: Codelist (CL330)

50

GFFTP

Groove/Female-face Flanged Termination tyPe

51

SGFE

Small-Groove-face Flanged End

52

LGFE

Large-Groove-face flanged End

53

SFFE

Small-Female-face Flanged End

54

LFFE

Large-Female-face Flanged End

Use 61-65 for lap-flanged ends without integral gaskets and 66-69 for lap-flanged ends
with integral gaskets.

60

FFLFTP

Flat-Face Lap-flanged Termination tyPe

61

FFLFE

Flat-Face Lap-Flanged End

Use 71-75 for lap-flanged ends without integral gaskets and 76-79 for lap-flanged ends
with integral gaskets.

70

RFLFTP

Raised-Face Lap-Flanged Termination tyPe

71

PFLFE

Raised-Face Lap-Flanged End

Use 81-85 for lap-flanged ends without integral gaskets and 86-89 for lap-flanged ends
with integral gaskets.

80

RJFLFTP

RTJ-Face Lap-Flanged Termination tyPe

81

RJLFE

RTJ-Face Lap-Flanged end

Use 91-95 for lap-flanged ends without integral gaskets and 96-99 for lap-flanged ends
with integral gaskets.

90

TMFLFTP

Tongue/Male-Face Lap-Flanged Termination tyPe (91-99)

91

STLFE

Small-Tongue-Face Lap-Flanged End

92

LTLFE

Large-Tongue-Face Lap-Flanged End

93

SMLFE

Small-Male-Face Lap-Flanged End

94

LMLFE

Large-Male-Face Lap-Flanged End

Use 101-105 for lap-flanged ends without integral gaskets and 106-109 for lap-flanged
ends with integral gaskets.

120

Plant Design System (PDS) Equipment Eden Interface

Appendix: Codelist (CL330)

100

GFFLFTP

Groove/Female-Face Lap-Flanged Termination Type


(101-109)

101

SGLFE

Small-Groove-Face Lap-Flanged End

102

LGLFE

Large-Groove-Face Lap-Flanged End

103

SFLFE

Small-Female-Face Lap-Flanged End

104

LFLFE

Large-Female-Face Lap-Flanged End

Use 111-115 for ends without integral gaskets and 116-119 for ends with integral
gaskets.

110

FFTBTP

Flat-Face Thru-Bolted Termination tyPe (111-119)

111

FFTBE

Flat-Face Thru-Bolted End

116

FFTBEWG

Flat-Face Thru-Bolted End With integral gasket

Use 121-125 for ends without integral gaskets and 126-129 for ends with integral
gaskets.

120

RFTBTP

Raised-Face Thru-Bolted Termination tyPe (121-129)

121

RFTBE

Raised-Face Thru-Bolted End

126

RFTBEWG

Raised-Face Thru-Bolted End With integral Gasket

Use 131-135 for ends without integral gaskets and 136-139 for ends with integral
gaskets.

130

RJTBTP

RTJ-face Thru-Bolted Termination tyPe (131-139)

131

RJTBE

RTJ-face Thru-Bolted End

Use 141-145 for ends without integral gaskets and 146-149 for ends with integral
gaskets.

140

MRJTBTP

Male RTJ-face thru-Bolted Termination tyPe (141-149)

146

MRJTBEWG

Male RTJ-face thru-Bolted End With integral Gasket

Use 151-155 for ends without integral gaskets and 156-159 for ends with integral
gaskets.

Plant Design System (PDS) Equipment Eden Interface

121

Appendix: Codelist (CL330)


150

FFTBCSTP

Flat-Face Thru-Bolted-with-Cap-Screws Termination tyPe


(151-159)

151

FFTBCSE

Flat-Face Thru-Bolted-with-Cap-Screws End

156

FFTBCSEWG

Flat-Face Thru-Bolted-with-Cap-Screws End With integral


Gasket

Use 161-165 for ends without integral gaskets and 166-169 for ends with integral
gaskets.

160

RFTBCSTP

Raised-Face Thru-Bolted-with-Cap-Screws Termination tyPe


(161-169)

161

RFTBCSE

Raised-Face Thru-Bolted-with-Cap-Screws End

166

RFTBCSEWG

Raised-Face Thru-Bolted-with-Cap-Screws End With integral


Gasket

Use 171-175 for ends without integral gaskets and 176-179 for ends with integral
gaskets.
170

RJTBCSTP

RTJ-face Thru-Bolted-with-Cap-Screws Termination tyPe


(171-179)

171

RJTBCSE

RTJ-face Thru-Bolted-with-Cap-Screws Ends

Use 181-185 for ends without integral gaskets and 186-189 for ends with integral
gaskets.

122

180

FFFTBTP

Flat-Full-Face Thru-Bolted Termination tyPe (181-189)

181

FFFTBE

Flat-Full-Face Thru-Bolted End

186

FFFTBEWG

Flat-Full-Face Thru-Bolted End With integral Gasket

190

MJTP

Mechanical Joint Termination tyPe (190-199)

191

MJE

Mechanical Joint End

300

MTP

Male Termination tyPe

301

BE

Beveled End

311

TBE

Tapered and Beveled End

321

MFE

Male Flared End

331

MTE

Male Threaded End

341

MGE

Male Grooved End

Plant Design System (PDS) Equipment Eden Interface

Appendix: Codelist (CL330)


351

MQCE

Male Quick Connect Point

361

MFRE

Male FerRule End

371

MHE

Male Hose End

381

SPE

SPigot End

391

PE

Plain End (391-399)

393

3"FFPE

3" Field Fit Plain End

395

6"FFPE

6" Field Fit Plain End

400

STP

Socket Termination tyPe (401-409)

401

SE

Socket End

420

SWTP

SocketWelded Termination tyPe (421-429)

421

SWE

Socket End

440

FTTP

Female Threaded Termination tyPe (441-449)

441

FTE

Female Threaded End

460

FGTP

Female Grooved Termination tyPe (461-469)

461

FGE

Female Grooved End

480

FQCTP

Female Quick Connect Termination tyPe (481-489)

481

FQCE

Female Quick Connect End

500

FFRTP

Female FerRule Termination tyPe (501-509)

501

FFRE

Female FerRule End

520

FHTP

Female Hose Termination tyPe (521-529)

521

FHE

Female Hose End

540

BLTP

BeLl End Termination tyPe (541-549)

541

BLE

BeLl End

590

HTP

Hole end Termination tyPe (581-599)

591

HCE

Circular Hole End

Plant Design System (PDS) Equipment Eden Interface

123

Appendix: Codelist (CL330)


600

NTP

Null Termination tyPe (600-605)

601

NE

Null End

650

UDTP

User Defined Termination tyPe (651-659)

651

UD

User Defined end

When a UD preparation end is detected by the system in the piping materials class, it
prompts you to define the actual CP preparation. The value you input is used for initial component
placement as well as for subsequent re- creations of the piping system.

124

Plant Design System (PDS) Equipment Eden Interface

APPENDIX B

Appendix: Equipment Data Definition


The database containing the equipment data definition information is located in
c:\win32app\ingr\pdeqp\ddl\eqp.ddl.
Each piece of equipment in an equipment model is linked to a database record that contains
nongraphic information about that piece of equipment. You can supply the nongraphic information
before placing the item in the model or at placement time via input fields on the placement form.
Each database (or database partition) is composed of a set of database tables which represent
categories of data. A database table is a defined set of attributes that describe an item. An
attribute is a single type of information to be stored about an item. Each attribute has a name
which describes the piece of information to be stored. The actual information stored in the
database is referred to as the attribute value. This value is a fixed data type: numeric,
alphanumeric or code-listed.
Numeric data types can be either real (decimal) or integer. These attributes are used for
quantitative values such as pressure or temperature.
Alphanumeric data types (characters) are used for textual information such as equipment item
names or descriptions.
Code-listed data types are special integer values which help standardize and speed up data
entry. A code list is a set of acceptable values for a particular attribute which can be referred to
by an index number.
By using the code list, you can enter the code-listed value instead of keying in all the
characters each time a category is specified. A code listed attribute is an attribute whose
value is defined using one of the selections from a particular code-list set.
The name of an equipment item is the most important nongraphic piece of data in the database
concerning that equipment item. The equipment name is used by piping modelers to refer to a
piece of equipment while routing pipe. The name must be defined before an equipment item can
be placed in the model.
In addition to the database record for the equipment item, there is also a database record for each
nozzle on the equipment item. These records store essential data about the nozzles needed by
PD_Design.

See Also
Equipment Group Database Table (on page 126)
Equipment Nozzle Database Table (on page 126)

Plant Design System (PDS) Equipment Eden Interface

125

Appendix: Equipment Data Definition

Equipment Group Database Table


The list of attributes for the equipment database table is displayed below. This list contains the
attribute number, the attribute name, field description and, when necessary, the code-list number.
# equip_group
table number = 21, number of columns = 14
1 , equip_indx_no , integer
2 , equip_no , character(30)
3 , equip_descr_1 , character(40)
4 , equip_descr_2 , character(40)
5 , tutorial_no , character(6)
6 , equip_class , character(2)
7 , dry_weight , double
8 , oper_weight_1 , double
9 , oper_weight_2 , double
10 , insulation_thk , double
11 , construction_stat , short
, standard note 130
12 , equipment_division , short
, standard note 69
13 , approval_status , short
, standard note 35
14 , insulation_purpose , short , standard note 220
If any of the double values are left undefined, -32768 is assigned as a value.

Equipment Nozzle Database Table


The list of attributes for the nozzle database table is displayed below. This list contains the
attribute number, the attribute name, field description and, when necessary, the code-list number.
# equip_nozzle
table number = 22, number of columns = 25
1 , nozzle_indx_no , integer
2 , nozzle_no , character(10)
3 , equip_indx_no , integer
4 , nominal_piping_dia , short
5 , rating
, character(8)
6 , preparation
, short
, standard
7 , piping_mater_class , character(16)
8 , unit_no
, character(12)
9 , fluid_code , short , standard note 125
10 , unit_code
, character(3)
11 , line_sequence_no , character(16)
12 , heat_tracing_reqmt , short , standard note
13 , heat_tracing_media , short , standard note
14 , insulation_purpose , short , standard note
15 , insulation_thk , double
16 , table_suffix , short
, standard
17 , service , character(20)
18 , schedule_thickness , character(8)

126

note 330

200
210
220
note 576

Plant Design System (PDS) Equipment Eden Interface

Appendix: Equipment Data Definition


19
20
21
22
23
24
25

,
,
,
,
,
,
,

nor_therm_growth_X , double
nor_therm_growth_Y , double
nor_therm_growth_Z , double
alt_therm_growth_X , double
alt_therm_growth_Y , double
alt_therm_growth_Z , double
construction_stat , short , standard note 130
If any of the double values are left undefined, -32768 is assigned as a value.

Plant Design System (PDS) Equipment Eden Interface

127

Appendix: Equipment Data Definition

128

Plant Design System (PDS) Equipment Eden Interface

APPENDIX C

Appendix: EQP Eden Program Examples


In This Appendix
Example 1 (Use of loops) .............................................................. 129
Example 2 (Use of arrays and loops) ............................................ 130
Example 3 (Placing nozzles) ......................................................... 130
Example 4 (Use of character string variables) ............................... 131
Example 5 (Graphic selection commands) .................................... 131
Example 6 ...................................................................................... 132
Example 7 ...................................................................................... 132
Example 8 ...................................................................................... 133
Example 9 ...................................................................................... 133
Example 10 (Insulation Graphics) ................................................. 137

Example 1 (Use of loops)


This example demonstrates passing arguments to a User_Function using global variables and
also reading equipment tables with character inputs.
! =================================================================
!
! USER_FUNCTION_DEFINITION PMPTBL
!
! =================================================================
! SUBROUTINE TO RETRIEVE NEMA MOTOR DIMENSIONS FROM A TABLE BASED
! UPON NEMA MOTOR FRAME NUMBER. THE TABLE, NAMED NEMA_MOTOR_DATA,
! IS HELD IN THE "EQUIPMENT TABLES" LIBRARY.
!
! INPUTS- CSTRING [1] - NEMA MOTOR FRAME NUMBER
!
DIMENSION_89 - INPUT FIELD NUMBER TO REPOSITION CURSOR IF
!
ERROR
!
DIMENSION_90 - ERROR MESSAGE FIELD NUMBER
!
! OUTPUTS- DIMENSION_91 - RETURN CODE (0=GOOD, NOT 0=BAD)
!
DIMENSION_61 THRU DIMENSION_67 - TABLE OUTPUTS
!
! NOTE: THE NEMA MOTOR FRAME NUMBER IS A CHARACTER STRING,
!
FOR EXAMPLE: "140T". IT WOULD BE ASSIGNED TO INPUT_1 USING
!
THE MOVE_DATA CALL.
!
! =================================================================
!
msg_field = DIMENSION_90
input_field = DIMENSION_89
CALL MOVE_DATA (CSTRING_1, INPUTS [1])
if (INPUTS [1] .ne. ) then
!not blank. Good
sav_lib = ACT_LIB
call DEFINE_LIBRARY (EQP_TABLES) !open new lib

Plant Design System (PDS) Equipment Eden Interface

129

Appendix: EQP Eden Program Examples


!symbol quits if
!open error
call READ_TABLE (NEMA_MOTOR_DATA, INPUT, OUTPUT)
do i = 1, 6 !move table
!outputs
DIMENSION [60+i] = OUTPUTS [i] !into global vars
enddo
call DEFINE_LIBRARY (save_lib) !reopen commod lib
!so that
!nozzles will
!place.
else
call DISPLAY_MESSAGE (Invalid motor frame
number, msg_field)
call MOVE_CURSOR (input_field)
DIMENSION(91) = -2
endif
end

Example 2 (Use of arrays and loops)

Initializing variables
DIMENSION_1 = 10
DIMENSION_2 = 10
.
.
.
DIMENSION_10 = 10

Initializing variables using a Do loop


do i = 1, 10
DIMENSION[i] = 10
enddo

Example 3 (Placing nozzles)

Placing nozzles
location = DIMENSION_23
theta = DIMENSION_24
call DEFINE_ACTIVE_ORIENTATION (EAST, NORTH)
call MOVE_TO_PLACEPOINT (PP1)
call MOVE_ALONG_AXIS (PRIMARY, location)
call DEFINE_ACTIVE_ORIENTATION (UP, EAST)
call ROTATE_ORIENTATION (theta, NORMAL)
call RETRIEVE_NOZZLE_PARAMETERS (20)
call DEFINE_NOZZLE (NOZ2, 20, 1)

Placing nozzles using an array and Do loop


R8 theta(20)
LOCATION pnts(60)
.
.
.

130

Plant Design System (PDS) Equipment Eden Interface

Appendix: EQP Eden Program Examples


do i = 1, 20
pntnum = 3*i - 2
call DEFINE_ACTIVE_POINT (pnts(pntnum))
call DEFINE_ACTIVE_ORIENTATION (UP, EAST)
call ROTATE_ORIENTATION (theta(i), SECONDARY)
call RETRIEVE_NOZZLE_PARAMETERS (i)
if (NOM_PIPE_D .ne. 0) then
call DEFINE_NOZZLE (NOZ2, i, 1)
endif
enddo

Example 4 (Use of character string variables)


!
!
do while (.TRUE.)
call DISPLAY_TUTORIAL (INPUTS)
pump_type = CSTRING[1] !input field is data
type 9
if (pump_type .eq. SS .or. pump_type .eq. ss) then
call USER_FUNCTION (SIDESIDE)
stop
endif
if (pump_type .eq. TT .or. pump_type .eq. tt) then
call USER_FUNCTION (TOPTOP)
stop
endif
if (pump_type .eq. TE .or. pump_type .eq. te) then
call USER_FUNCTION (TOPEND)
end
call DISPLAY_MESSAGE (BAD PUMP TYPE: || pump_type, 2)
call DISPLAY_MESSAGE (VALID TYPES ARE SS, TT AND TE , 3)
enddo

Example 5 (Graphic selection commands)


notdone = TRUE
do while (notdone)
call DISPLAY_TUTORIAL (UPICK)
if (LAST_INP_TYPE .eq. APPLICATION_CMD) then
appnum = LAST_INP_NUM - 4050 ! 4051-4075 for
! fields
if (appnum .eq. 1) then
call USER_FUNCTION (AET)
stop
endif
if (appnum .eq. 2) then
call USER_FUNCTION (AES)
stop
endif
if (appnum .eq. 3) then
call USER_FUNCTION (AEU)
endif

Plant Design System (PDS) Equipment Eden Interface

131

Appendix: EQP Eden Program Examples


call DISPLAY_MESSAGE (OPTION HAS NOT BEEN IMPLEMENTED YET)
else
notdone = FALSE
endif
enddo

Example 6
This example illustrates how a terminated key-in is used. To get a user input, perform some
calculations using the input, and then display the results as default values in the tutorial.
notdone = TRUE
do while (notdone)
call DISPLAY_TUTORIAL (ATUT)
if (LAST_INP_TYPE .eq. USER_KEYIN) then ! input to terminated
! ... keyin field
field_no = LAST_INP_NUM
! fld attrib is 3 or 4
if (field_no .eq. 3) then
! keyin was to field 3
length = DIMENSION [23]
size = length /100.
angle = DASIND (size)
call PUT_FIELD (angle, 4, retcode)! show default in tut
endif
if (field_no .eq. 5) then
count = DIMENSION[45]
height = count * 10.
call PUT_FIELD (height, 6, retcode)!show default on tutor
endif
else
notdone = FALSE
endif
enddo

Example 7
This example shows the Eden logic for the case when a tutorial selection results in a value being
displayed in a tutorial field.
done = 0
do while (done .eq. 0)
call DISPLAY_TUTORIAL (GETME)
if (LAST_INP_TYPE .eq. APPLICATION_CMD) then
optnum = LAST_INP_NUM - 4050
if (optnum .eq. 1) then
call DISPLAY_MESSAGE (***, 190)
endif
if (optnum .eq. 2) then
call DISPLAY_MESSAGE (***, 191)
endif
if (optnum .eq. 3) then
call DISPLAY_MESSAGE (***, 192)
endif
else
done = 1

132

Plant Design System (PDS) Equipment Eden Interface

Appendix: EQP Eden Program Examples


endif
enddo

Example 8
This example shows how a tutorial selection can result in the display of a new tutorial. After the
ACCEPT box on the new tutorial is selected, the initiating tutorial is redisplayed. The symbol is:
el_finito = FALSE
do while (.not. el_finito)
call DISPLAY_TUTORIAL (TUTONO)
if (LAST_INP_TYPE .eq. APPLICATION_CMD) then
cmdno = LAST_INP_NUM - 4050
if (cmdno .eq. 1) then
call DISPLAY_TUTORIAL (TUTDOS)
endif
else
el_finito = TRUE
endif
enddo

Example 9
The tutorial below is used to collect input for a Simple Horizontal Vessel.

A010
1,
2,
3,
4,
5,
6,

1,
1,
1,
1,
1,
1,

1,
2,
3,
4,
5,
6,

,
,
,
,
,
,

4,
4,
2,
2,
2,
2,

,
,
,
,
,
,

Plant Design System (PDS) Equipment Eden Interface

LENGTH
DIAMETER
OFFSET
SUP_1_2
SUP_DIAM
SUP_HGHT

133

Appendix: EQP Eden Program Examples


7,
8,
9,
10,
11,
202,
203,
204,

1,
1,
1,
9,
7,
1,
1,
1,

7,
8,
9,
1,
1,
,
,
,

,
,
,
,
,
,
,
,

2,
2,
2,
3,
1,
1,
1,
1,

,
,
,
,
,
,
,
,

DSH_DPTH
SUP_WIDTH
THICKNESS
TANK_STD
EQPNAM


The following tutorial is used to define the vessel center-of-gravity for the Simple Horizontal
Vessel.

A011
1,
2,
3,

1,
1,
1,

10,
11,
12,

,
,
,

1,
1,
1,

,
,
,

OFFSET_PRI
OFFSET_SEC
OFFSET_NOR

The following code is the Symbol Processor for HTANK. It illustrates several useful Eden
features in creating the tutorials previously mentioned such as handling terminated fields,
declaring local point arrays for location data, and placing 2D complex shapes for generating
shadows. To familiarize yourself with the logic, you will find it useful to step through the source
code aided by the Debugger. The symbol (and the User Function) should be extracted from the
delivered text library, recompiled, and then inserted into the object library. The recompilation
process allows the Debugger to locate the source file on your system when the symbol HTANK is
called up.
SYMBOL_PROCESSOR HTANK
! Simple Horizontal Tank
int2
location

accepted, finished, i
shd_pnt[12]

accepted = 0
finished = 0
Do while ( finished .eq. 0 )
Do while ( accepted .eq. 0)
Call Display_Tutorial ( HTANK, A010 )
if ( LAST_INP_TYPE .eq. APPLICATION_CMD ) then

134

Plant Design System (PDS) Equipment Eden Interface

Appendix: EQP Eden Program Examples


if ( LAST_INP_NUM .le. 4075 .and. LAST_INP_NUM .ge. 4073 ) then
if ( LAST_INP_NUM .eq. 4075 ) then
cstring[1]= A
else
if ( LAST_INP_NUM .eq. 4074 ) then
cstring[l]= B
else
cstring[1]= C
endif
endif
Call User_Function ( STD_TANK ) ! Defines dimensions 1-8
else
if ( LAST_INP_NUM .eq. 4072 ) then
Call Display_Tutorial ( TNKCOG, A011)
endif
endif
else
if ( LAST_INP_TYPE .eq. USER_KEYIN ) then
if ( LAST_INP_NUM .eq. 1 ) then
dimension_3 = dimension_l / 5
dimension_4 = dimension_1 * 3 / 5
Call Put_Field ( dimension_3, 3 )
Call Put_Field ( dimension_4, 4 )
else
if ( LAST_INP_NUM .eq. 2 ) then
dimension_8 = dimension_2* .866
dimension_7 = dimension_2/4
INPUT_1 = dimension_1
sav_lib = ACT_LIB
Call Define_Library ( EQP_TABLES )
Call Read_Table ( THK_DIAM_READINGS, INPUT, OUTPUT )
dimension_5 = OUTPUT_1
dimension_6 = OUTPUT_2
Call Define_Library ( sav_lib )
do i = 5, 8
Call Put_Field ( dimension[i], i )
enddo
else
if ( LAST_INP_NUM .eq. 10 ) then
Call User_Function ( STD TANK)
endif
endif
endif
endif
endif
if ( LAST_INP_TYPE .ne. APPLICATION_CMD .and. LAST_INP_TYPE .ne. USER_KEYIN ) then
accepted = 1
endif
enddo
cylinder_length = dimension_1
cylinder_diameter = dimension_2
suppport_offset = dimension_3
supportl_support2 = dimension_4
support_width1 = dimension_5
base_center = dimension_6
dish_depth = dimension_7
support_width2 = dimension_8
insulation_thick = dimension_9
env_diameter = cylinder_diameter + 2.0*insulation_thick
env_length = cylinder_length + 2*dish_depth + 2.0*insulation_thick
finished = 1
if ( cylinder_length .lt. ( support_offset + supportl_support2 )) then
Call Display_Message ( Supports will be outside tank body, 90 )
finished = 0
endif
if ( dish_depth .lt. 0 ) then
Call Display_Message ( Dish depth is to small || dish_depth, 90 )
finished = 0
endif
if ( finished .eq. l ) then
Call Define_Active_Orientation ( EAST, UP )
Call Define_Placepoint ( PP1, POINT_0 )
Call Begin ( EQUIPMENT )
Call Draw_Cylinder_With_Capped_Ends ( cylinder_length, cylinder_diameter )
Call Define_Placepoint ( PP2, POINT_0 )
Call Draw_Semi_Ellipsoid ( cylinder_diameter, dish_depth )
Call Move_To_Placepoint ( PP1 )
Call Define_Active_Orientation ( WEST, DOWN )
Call Draw_Semi_Ellipsoid ( cylinder_diameter, dish_depth )
Call Move_to_Placepoint ( PP1 )
if ( env_length .ne. 0 .and. env_diameter .ne. 0 ) then
Call Begin ( ENVELOPE_SAFETY_HARD )
Call Move_Along_Axis ( ( dish_depth + insulation_thick ), WEST )

Plant Design System (PDS) Equipment Eden Interface

135

Appendix: EQP Eden Program Examples


Call Draw_Cylinder_With_Capped_Ends ( env_length, env_diameter )
Call Move_to_placepoint ( PP1 )
endif
Call
Call
Call
Call
Call
Call
do i =
Call
Call
Call
enddo

Begin ( EQUIPMENT
Move_Along_Axis (
Move_Along_Axis (
Define_Placepoint
Move_Along_Axis (
Define_Placepoint

)
base_center, DOWN )
support_offset, EAST )
( PP3, POINT_0 )
supportl_support2, East )
( PP4, POINT_0 )

3, 4
Move_To_Placepoint ( PP[i] )
Define_Active_Orientation ( UP, WEST )
Draw_Proj_Rectangle ( support_widthl, support_width2, base_center )

Call Move_To_Placepoint ( PP1)


Call Define_Datum_Point ( DP[1], POINT_0 )
Call Place_COG ( LIFTING, dimension[10], dimension[11], dimension[12] )
Call BEGIN ( SHADOW )
Call Start_Complex_Shape(0)
Call Move_To_Placepoint ( PP1 )
Call Move_Along_Axis ( base_center, DOWN )
Call Define_Active_Orientation ( SOUTH, WEST )
Call Draw_Arc ( cylinder_diameter/2, dish_depth, 0, 180 )
Call
Call
Call
Call
Call
Call
Call

Move_to_Placepoint ( PP1 )
Move_Along_Axis ( base_center, DOWN )
Define_Point ( shd_pnt[1], POINT_0, 0, -cylinder_diameter/2, 0 )
Define_Point ( shd_pnt[4], shd_pnt[1], 0, cylinder_diameter, 0 )
Define_Point ( shd_pnt[7], shd_pnt[4], cylinder_length, 0, 0 )
Define_Point ( shd_pnt[10], shd_pnt[7], 0, -cylinder_diameter, 0 )
Draw_Line ( shd_pnt[4], shd_pnt[7] )

Call
Call
Call
Call

Move_To_Placepoint ( PP2 )
Move_Along_Axis ( base_center, DOWN )
Define_Active_Orientation ( NORTH, EAST )
Draw_Arc ( cylinder_diameter/2, dish_depth, 0, 180 )

Call Draw_Line ( shd_pnt[l0], shd_pnt[1] )


Call Stop_Complex_Shape(0)
endif
enddo
END
The following code is the User Function routine for computing dimensions.
! The following code is the User Function routine for computing dimensions.
User_Function_Definition STD_TANK
!

Defines parameters dimension[l]-[9] and Tutorial Fields l-9


int2

if ( cstring[l] .ge. A .and. cstring[l] .le. C ) then


Call Put_Field ( cstring[l], 10 )
if ( cstring[1] .eq. A ) then
Call Convert_Unit ( 144.0, ENGLISH, dimension_1 )
Call Convert_Unit ( 60.0, ENGLISH, dimension_2 )
dimension_9 = 0
else
if ( cstring[1] .eq. B ) then
Call
Call
Call
else
if (

Convert_Unit ( 192.0, ENGLISH, dimension_1 )


Convert_Unit ( 120.0, ENGLISH, dimension_2 )
Convert_Unit ( 12.0, ENGLISH, dimension_9 )
cstring[1] .eq. C ) then

Call Convert_Unit ( 480.0, ENGLISH, dimension_1 )


Call Convert_Unit ( 180.0, ENGLISH, dimension_2 )
Call Convert_Unit ( 6.0, ENGLISH, dimension_9 )
endif
endif
endif
dimension_3 = dimension_1/5
dimension_4 = dimension_1*3/5
dimension_5 = dimension_1/8
dimension_6 = dimension_2/2 + dimension_2/4 + dimension_9
dimension_7 = dimension_2/4
dimension_8 = dimension_2*.866
do i = 1, 9
Call Put_Field ( dimension[i], i )

136

Plant Design System (PDS) Equipment Eden Interface

Appendix: EQP Eden Program Examples


enddo
else
Call Display_Message ( "||cstring[1]||" || is not a valid standard, 90 )
endif
END

Example 10 (Insulation Graphics)


You can now place soft insulation graphics using the Eden code for Parametrics. A new Begin
category (ENVELOPE_INSULATION) needs to be created for each Eden equipment symbol, so
that the following statement can be called to draw the insulation shape and place it on the same
Active Model Category as Insulation Envelope.
Call Begin (ENVELOPE_INSULATION)

Plant Design System (PDS) Equipment Eden Interface

137

Appendix: EQP Eden Program Examples

138

Plant Design System (PDS) Equipment Eden Interface

APPENDIX D

Appendix: Delivered Parametrics


The following pages display each parametric identified by its title and Eden code. For some
parametrics, special instructions or important information accompany the graphic.
The nozzle parametrics, N205 - N410, are included in this appendix, but Appendix:
Equipment Data Definition contains more information on nozzles.
The following parametrics are delivered with the PDS Equipment Modeling product.

Plant Design System (PDS) Equipment Eden Interface

139

Appendix: Delivered Parametrics


In This Appendix
Circular Platform (A001) ................................................................ 141
Miscellaneous Platform (A003) ...................................................... 143
Holes for Platforms (A015) ............................................................ 145
Holes for Miscellaneous Platforms (A016) .................................... 147
Thru Ladder A (A021) .................................................................... 149
Thru Ladder Details (A029) ........................................................... 150
Side Ladder A (A031) .................................................................... 152
Side Ladder Details (A039)............................................................ 153
Stairs A (A041) .............................................................................. 154
Handrail A (A051) .......................................................................... 156
Davit A (A061) ............................................................................... 157
Davit B (A063) ............................................................................... 159
Define (E200) ................................................................................. 160
Define Weights (E201) ................................................................... 161
Complex Vertical Cylindrical Equipment, Skirt (E205) .................. 163
Simple Vertical Cylindrical Equipment, Skirt (E210) ...................... 165
Simple Vertical Cylindrical Equipment, Legs (E215) ..................... 167
Spherical Equipment (E230) .......................................................... 169
Complex Horizontal Cylindrical Equipment (E240) ....................... 170
Simple Horizontal Cylindrical Equipment (E245) ........................... 172
Horizontal Shell and Tube Exchanger (E305) ............................... 174
Kettle Exchanger (E307) ................................................................ 176
Vertical Shell and Tube Exchanger (E310) ................................... 178
Exchanger Ends (E319) ................................................................. 180
Double Pipe Exchanger (E320) ..................................................... 181
Plate Exchanger (E325) ................................................................. 183
Air Cooler (E330) ........................................................................... 185
Induced Draft Air Cooler Bay (E332) ............................................. 186
Forced Draft Air Cooler Bay (E334) ............................................... 188
Horizontal Rotating Equipment and Driver (E405) ........................ 189
Vertical Rotating Equipment and Driver (E410)............................. 191
E1 Ends (E905) ............................................................................. 193
E2 Ends (E906) ............................................................................. 194
E3 Ends (E907) ............................................................................. 195
Complex Vertical Cylindrical Equipment (N205)............................ 196
Simple Vertical Cylindrical Equipment (N210) ............................... 197
Simple Vertical Cylindrical Equipment (N215) ............................... 197
Spherical Equipment (N230).......................................................... 198
Complex Horizontal Cylindrical Equipment (N240) ....................... 198
Simple Horizontal Cylindrical Equipment (N245)........................... 199
Horizontal Shell and Tube Exchanger (N305) ............................... 199
Kettle Exchanger (N307) ............................................................... 200
Vertical Shell and Tube Exchanger (N310) ................................... 200
Double Pipe Exchanger (N320) ..................................................... 201
Plate Exchanger (N325) ................................................................ 201
Air Cooler (N330) ........................................................................... 202
Horizontal Rotating Equipment and Driver (N405) ........................ 202
Vertical Rotating Equipment and Driver (N410) ............................ 203
Gear Cover (U850) ........................................................................ 203
Round Torus Miter (U860) ............................................................. 204
Rectangular Torus Miter (U861) .................................................... 206

140

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


Vertical Oval Torus Miter (U862) ................................................... 207
Flat Oval Torus Miter (U863) ......................................................... 208
Flat Oval Prism (U870) .................................................................. 209
Flat Oval Torus (U880) .................................................................. 210
Rectangular 90 Cone Torus with Offset (U881) ............................ 212
User Projected Shape (USRPRJ) .................................................. 213

Circular Platform (A001)

The sweep defines the platform location (left [L] or right [R]) in relation to the ladder as looking
from the top view.
For SEGMENT 1, the platform edge next to the ladder is parallel to the radial line located at
angle P1. All other edges are radial.
Select the Define Holes option to define the various shape penetrations on the platform
surface using the Handrail A (A015) (see "Holes for Platforms (A015)" on page 145) form.

A001 Notes Specific to Form A001, Circular Platform

SWEEP defines whether the platform is located to the right (R) or to the left (L) of the ladder,
as viewed from the top.
For segment 1, the platform edge next to the ladder is parallel to the radial line located at angle
P1. All other platforms edges are radial.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

ITEM

12

' '

;Equip group no

952

COMP

12

953

DET

12

954
955

4
5

P1
P2

11
11

2
1

1
2

0
0

1
3

;
;

Plant Design System (PDS) Equipment Eden Interface

T2210
Att No

Explanatory
Remarks

141

Appendix: Delivered Parametrics


Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

956
957

6
7

P3
SWEEP

9
1

1
9

3
4

0
0

3
3

;
;

959

OPT1

"A"

;Option

960

10

P15

13

15

11
12

11
12

P16
P17

13
11

1
2

16
17

0
0

3
3

;
;

13

13

OPT2

"A"

;Option

14

14

P25

13

25

15
16

15
16

P26
P27

13
11

1
2

26
27

0
0

3
3

;
;

17

17

OPT3

"A"

;Option

18

18

P35

13

35

19
20

19
20

P36
P37

13
11

1
2

36
37

0
0

3
3

;
;

21

21

OPT4

"A"

;Option

22

22

P45

13

45

23
24

23
24

P46
P47

13
11

1
2

46
47

0
0

3
3

;
;

25

25

OPT5

"A"

;Option

26

26

P55

13

55

27
28

27
28

P56
P57

13
11

1
2

56
57

0
0

3
3

;
;

29

29

OPT6

10

"A"

;Option

30

30

P65

13

65

31

31

P66

13

66

32

32

P67

11

67

33

33

OPT7

11

"A"

;Option

34
35

34
35

P75
P76

13
13

1
1

75
76

0
0

3
3

;
;

36

36

P77

11

77

37

37

OPT8

12

"A"

;Option

38
39

38
39

P85
P86

13
13

1
1

85
86

0
0

3
3

;
;

40

40

P87

11

87

SEGMENT 1

SEGMENT 2

SEGMENT 3

SEGMENT 4

SEGMENT 5

SEGMENT 6

SEGMENT 7

SEGMENT 8

SEGMENT 9

142

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

41

41

OPT9

"A"

;Option

42

42

P95

13

95

43
44

43
44

P96
P97

13
11

1
2

96
97

0
0

3
3

;
;

45

45

DATE

11

14

C38

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

Explanatory
Remarks

;Date
;Site EW coord of
PP
;Site NS coord of
PP
;Site elev of PP
;Ang site N equip
N

Following is a list of form elements and their associated files:


A001

A015

General place hole routine

a001.eqp

a015a016.uf

pl_holes.uf

a001_ck.uf

a015a016_ck.uf

trapez.uf

a015.tdf

a001.tdf

A015.fb

A001.fb

Miscellaneous Platform (A003)

To form a skewed corner as indicated by the dashed lines, enter the two parameters (P#) that
make up the right angle corner (solid lines) in P11 and P12, respectively.

Plant Design System (PDS) Equipment Eden Interface

143

Appendix: Delivered Parametrics

For example, for a Type E platform enter the values for P1 and P8 in P11 and P12 to create
the skewed corner.
Select the Define Holes option to define the various shape penetrations on the platform
surface using the Handrail A (A016) (see "Holes for Miscellaneous Platforms (A016)" on page
147) form.

A003 Notes Specific to Form A003, Misc Platforms

To allow access to the platform via a skewed ladder, enter in fields P11 and P12 the
parameters that define the skewed corner. For example, enter parameters "P1" and "P6" to
define a skewed corner for a type B platform.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

ITEM

12

' '

952
953

2
3

COMP
TYPE

12
1

9
9

2
3

0
0

1
1

;Equip-ment
group no.
;
;

956

P1

14

957
958

7
8

P2
P3

14
14

1
1

2
3

0
0

3
3

;
;

959

P4

14

960
11

10
11

P5
P6

14
14

1
1

5
6

0
0

3
3

;
;

12

12

P7

14

13

13

P8

14

14
15

14
15

P9
P10

11
9

2
1

9
10

0
0

3
3

;
;

16

16

P11

17

17

P12

;First leg of
skewed corner
;Second leg of
skewed corner

18

18

DATE

11

C38

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

Explanatory
Remarks

;Date
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A003

A016

General place hole routine

a003.eqp

a015a016.uf

pl_holes.uf

a003_ck.uf

a015a016_ck.uf

a003_type_e.uf

a016.tdf

a003.tdf

A016.fb

A003.fb

144

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Holes for Platforms (A015)

In the OPT field, key in C for circular hole or R for rectangular hole.

Option E, elliptical hole, is not implemented at this time.


All holes must appear either partially or completely within the platform.

A015 Notes Specific to Form A015, Holes for Circular Platforms

Enter "C" for circular, "E" for elliptical, or "R" for rectangular hole. Option "E" is not currently
available.
The user must ensure that the holes are partially or completely within the platform.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

OPT1

21

"C"

;Option

952
953

2
3

P18
P19

11
13

2
1

18
19

0
0

1
3

;
;

954
955

4
5

P20
P21

11
13

2
1

20
21

0
0

1
3

;
;

956

P22

13

22

957

OPT2

22

"C"

;Option

958

P28

11

28

959

P29

13

29

960

10

P30

11

30

11
12

11
12

P31
P32

13
13

1
1

31
32

0
0

3
3

;
;

HOLE 1

HOLE 2

Plant Design System (PDS) Equipment Eden Interface

145

Appendix: Delivered Parametrics


HOLE 3
13

13

OPT3

23

"C"

;Option

14
15

14
15

P38
P39

11
13

2
1

38
39

0
0

1
3

;
;

16

16

P40

11

40

17
18

17
18

P41
P42

13
13

1
1

41
42

0
0

3
3

;
;

19

19

OPT4

24

"C"

;Option

20

20

P48

11

48

21

21

P49

13

49

22

22

P50

11

50

23
24

23
24

P51
P52

13
13

1
1

51
52

0
0

3
3

;
;

25

25

OPT5

25

"C"

;Option

26

26

P58

11

58

27
28

27
28

P59
P60

13
11

1
2

59
60

0
0

3
1

;
;

29
30

29
30

P61
P62

13
13

1
1

61
62

0
0

3
3

;
;

31

31

OPT6

26

"C"

;Option

32

32

P68

11

68

33
34

33
34

P69
P70

13
11

1
2

69
70

0
0

3
1

;
;

35
36

35
36

P71
P72

13
13

1
1

71
72

0
0

3
3

;
;

37

37

ITEM

12

38

38

DATE

11

27

C38

;Equipment
group no
;Date

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

HOLE 4

HOLE 5

HOLE 6

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A015
a015a016.uf
a015a016_ck.uf
a015.tdf
A015.fb

146

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Holes for Miscellaneous Platforms (A016)

In the OPT field, key in C for circular hole or R for rectangular hole.

Option E, elliptical hole, is not implemented at this time.


All holes must appear either partially or completely within the platform.

A016 Notes Specific to Form A016, Holes for Misc Platforms

Enter "C" for circular, "E" for elliptical, or "R" for rectangular hole. Option "E" is not currently
available.
The user must ensure that the holes are partially or completely within the platform.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

OPT1

21

"C"

;Option

952
953

2
3

P18
P19

14
14

1
1

18
19

0
0

1
1

;
;

954
955

4
5

P20
P21

11
13

2
1

20
21

0
0

1
3

;
;

956

P22

13

22

957

OPT2

22

"C"

;Option

958

P28

14

28

959

P29

14

29

960

10

P30

11

30

11
12

11
12

P31
P32

13
13

1
1

31
32

0
0

3
3

;
;

HOLE 1

HOLE 2

Plant Design System (PDS) Equipment Eden Interface

147

Appendix: Delivered Parametrics


Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

13

13

OPT3

23

"C"

;Option

14
15

14
15

P38
P39

14
14

1
1

38
39

0
0

1
1

;
;

16
17

16
17

P40
P41

11
13

2
1

40
41

0
0

1
3

;
;

18

18

P42

13

42

19

19

OPT4

24

"C"

;Option

20
21

20
21

P48
P49

14
14

1
1

48
49

0
0

1
1

;
;

22
23

22
23

P50
P51

11
13

2
1

50
51

0
0

1
3

;
;

24

24

P52

13

52

25

25

OPT5

25

"C"

;Option

26
27

26
27

P58
P59

14
14

1
1

58
59

0
0

1
1

;
;

28
29

28
29

P60
P61

11
13

2
1

60
61

0
0

1
3

;
;

30

30

P62

13

62

31

31

OPT6

26

"C"

;Option

32
33

32
33

P68
P69

14
14

1
1

68
69

0
0

1
1

;
;

34
35

34
35

P70
P71

11
13

2
1

70
71

0
0

1
3

;
;

36

36

P72

13

72

37

37

ITEM

12

38

38

DATE

11

27

C38

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

HOLE 3

HOLE 4

HOLE 5

HOLE 6

;Equipment
group no
;Date
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A016
a015a016.uf
a015a016_ck.uf
a016.tdf
A016.fb

148

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Thru Ladder A (A021)

The OPTION field defines a cage (C), no cage (N), or hoop (H) ladder. If you enter H, only the
lower hoop is displayed.
An interference envelope representing a cage is generated regardless of whether or not you
specify a cage.
To define ladder and cage details, select the Define Details option using the Thru Ladder
Details (A029) form.

A021 Notes Specific to Form A021, Thru Ladder A

OPTION defines whether cage (C), no cage (N), or hoop (H) option applies. For H, only the
lower hoop is displayed.
Use the DEFINE DETAILS command to define ladder and cage details.
An interference envelope representing the cage is generated regardless of whether there is a
cage or not.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

ITEM

12

' '

952

COMP

12

;Equipment
group no
;

953
954

3
4

DET
OPTION

12
1

9
9

3
4

0
0

1
3

;
;Option

955
956

5
6

P1
P2

9
14

2
1

1
2

0
0

3
3

0.0

;
;

957

P3

14

958

P4

2.0

959

P5

11

960

10

P6

14

Plant Design System (PDS) Equipment Eden Interface

T2210
Att No

Explanatory
Remarks

149

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

11

11

DATE

11

C38

;Date

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A021
a021.eqp
a021_ck.uf
a021.tdf
A021.fb

Thru Ladder Details (A029)

When you select the Define Details option on the Thru Ladder A (A021) form, the Details
form appears. Select the ACCEPT option to accept the current modification and return to the
Thru Ladder A form. Select the EXIT option to ignore the current modifications and return to
the parametric main menu.

A029 Notes Specific to Form A029, Thru Ladder Dtls

150

The following values are hardcoded:


The rails as 3" X 3/8" bars.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

The rungs as 3/4" diameter cylinders.


The hoop bars as 3" X 1/4" bars.
The vertical bars as 1-1/4" X 1/4" bars.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

957

P20

12

20

'18.75'

958

P21

12

21

12.0

959
960

9
10

P22
P23

12
12

1
1

22
23

0
0

3
3

42.0
90.0

;
;

11
12

11
12

P24
P25

12
12

1
1

24
25

0
0

3
3

48.0
13.5

;
;

13
14

13
14

P26
P27

12
12

1
1

26
27

0
0

3
3

13.5
17.5

;
;

15

15

P28

28

40.0

16
17

16
17

P29
DATE

9
11

1
9

29
10

0
0

3
1

7.0
C38

Explanatory
Remarks

;
;Date

Following is a list of form elements and their associated files:


A029
a029.eqp
a029_ck.uf
a029.tdf
A029.fb

Plant Design System (PDS) Equipment Eden Interface

151

Appendix: Delivered Parametrics

Side Ladder A (A031)

The OPTION field defines a cage (C), no cage (N), or hoop (H) ladder. If you enter H, only the
lower hoop is displayed.
An interference envelope representing a cage is generated regardless of whether or not you
specify a cage.
To define ladder and cage details, select the Define Details option using the Side Ladder
Details (A039) form.

A031 Notes Specific to Form A031, Side Ladder A

152

Refer to paragraph A031 for comments.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label
951

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

ITEM

12

' '

952
953

2
3

COMP
DET

12
12

9
9

2
3

0
0

1
1

;Equipment
group no
;
;

954

OPTION

;Option

955
956

5
6

P1
P2

9
14

2
1

1
2

0
0

3
3

0.0

;
;

957
958

7
8

P3
P4

14
9

1
1

3
4

0
0

3
3


2.0

;
;

959
960

9
10

P5
P6

11
14

2
1

5
6

0
0

1
3

;
;

11

11

DATE

11

C38

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

Explanatory
Remarks

;Date
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Following is a list of form elements and their associated files:


A031
a031.eqp
a031_ck.uf
a031.tdf
A031.fb

Side Ladder Details (A039)

When you select the Define Details option on the Side Ladder A (A031) form, the Details
form appears. Select the ACCEPT option to accept the current modification and return to the
Side Ladder A form. Select the EXIT option to ignore the current modifications and return to
the parametric main menu.

A039 Notes Specific to Form A039, Side Ladder Dtls

The following values are hardcoded:


The rails as 3" X 3/8" bars.
The rungs as 3/4" diameter cylinders.
The hoop bars as 3" X 1/4" bars.
The vertical bars as 1-1/4" X 1/4" bars.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

957

P20

12

20

'18.75'

Plant Design System (PDS) Equipment Eden Interface

T2210
Att No

Explanatory
Remarks

153

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

958
959

8
9

P21
P22

12
1

1
3

21
22

0
0

3
3

12.0
6

;
;

960
11

10
11

P23
P24

9
12

1
1

23
24

0
0

3
3

2.0
90.0

;
;

12
13

12
13

P25
P26

12
12

1
1

25
26

0
0

3
3

48.0
13.5

;
;

14
15

14
15

P27
P28

12
12

1
1

27
28

0
0

3
3

13.5
17.5

;
;

16
17

16
17

P29
P30

9
9

2
1

29
30

0
0

3
3

40.0
7.0

;
;

18

18

DATE

11

10

C38

Explanatory
Remarks

;Date

Following is a list of form elements and their associated files:


A039
a039.uf
a039_ck.uf
a039.tdf
A039.fb

Stairs A (A041)

154

If you input a value for P10, the system places the top rail.
If you input a value for P11, the system places the middle rail.
If you input a value for P12 and P13, the corresponding posts and rails are hardcoded and
placed as 2-1/2 inch outside diameter cylinders.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


A041 Notes Specific to Form A041, Stairs A

Top rail is placed if P10 has a value other than blank.


Mid rail is placed if P11 has a value other than blank.
Posts are placed if P12 and P13 have a value other than blank. The posts and rails are
hardcoded as 2-1/2" OD cylinders.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

ITEM

12

' '

952

COMP

12

;Equipment
group no
;

953

DET

12

959
960

9
10

P1
P2

9
9

1
1

4
5

0
0

3
3

;
;

11

11

P3

13

12
13

12
13

P4
P5

13
3

1
3

7
8

0
0

3
3

;
;No of risers

14
15

14
15

P6
P7

9
9

1
1

9
10

0
0

3
3

;
;

16
17

16
17

P8
P9

12
10

1
1

11
12

0
0

3
3

30.0
-0.75

;
;

18
19

18
19

P10
P11

12
12

1
1

13
14

0
0

3
3

34.0
17.0

;
;

20
21

20
21

P12
P13

12
12

1
1

15
16

0
0

3
3

;
;

22

22

P14

12

17

8.0

23

23

P15

18

2.25

24

24

DATE

11

C38

; Stringer
depth
; Stringer
flange width
;Date

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

Explanatory
Remarks

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A041
a041.eqp
a041_ck.uf
a041.tdf
A041.fb

Plant Design System (PDS) Equipment Eden Interface

155

Appendix: Delivered Parametrics

Handrail A (A051)

The primary axis of the place point must point up and normal to the platform surface. The
secondary axis may point in any direction.
The top and middle rails are placed as 2-1/2 inch outside diameter cylinders at the center of
the trajectory as specified using the Select Points option.
Posts are placed as 2-1/2 inch outside diameter cylinders. A post is placed at the begin point
and another at the end point. Subsequent posts are then placed a specified distance (P3) from
each intermediate (D1) point. Additional posts are placed in equal spacing so that the
maximum distance between posts does not exceed P4.
Modification of the handrail definition after placement requires you to delete and
redefine the handrail.
To identify the handrail connect points, select the Select Point option. Then, place a data
point at the designated connect points.
For accurate connect points, verify that the Keypoint Snap Lock is OFF and the Project Snap
Lock is ON.

A051 Notes Specific to Form A051, Handrail A

156

The primary axis of the PP must point up and normal to the platform surface. The secondary
axis may point in any direction.
Use the SELECT POINTS command to identify points for placement of the handrail.
Top rails and mid rails are placed as 2-1/2 inch OD cylinders, at the center of the trajectory
described with the SELECT POINTS command.
Posts are placed as 2-1/2 inch OD cylinders. One post is placed at the beginning and end
points. A post is also placed a distance P3 from each intermediate <Di> point. Additional posts
are placed in equal spacing so that the maximum distance between posts does not exceed P4.
Modification of the handrail definition after placement requires that the handrail be deleted and
redefined.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Characteristics of the parameters that apply to this form are as follows:


Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

ITEM

12

' '

952

COMP

12

;Equipment
group no
;

953

DET

12

956
957

6
7

P1
P2

12
12

1
1

2
3

0
0

3
3

42.0
24.0

;
;

958
959

8
9

P3
P4

12
13

1
1

4
5

0
0

3
3

12.0
72.0

;
;

960

10

DATE

11

C38

202

202

18

203

203

18

204

204

EL

16

Explanatory
Remarks

;Date
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP

Following is a list of form elements and their associated files:


A051
a051.eqp
a051_ck.uf
a051.tdf
A051.fb

Davit A (A061)

Plant Design System (PDS) Equipment Eden Interface

157

Appendix: Delivered Parametrics


A061 Notes Specific to Form A061, Davit A

A blank in the OD2 field omits the brace.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

952

COMP

12

;Equipment
group no
;

953
954

3
4

DET
CAP

12
5

9
3

3
1

0
0

1
3

;
;Capacity

955

UNITCAP

956
957

6
7

OD1
OD2

12
12

1
1

2
3

0
0

3
3

;Unit of
capacity
;Member 1 OD
;Member 2 OD

958

P1

13

959

P2

13

960

10

P3

13

11

11

P4

13

12

12

DATE

11

C38

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;
-

;Date
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


A061
a061.eqp
a061_ck.uf
a061.tdf
A061.fb

158

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Davit B (A063)

A063 Notes Specific to Form A063, Davit B

A blank in the OD3 field omits the brace.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label
951

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T221
Att No

Explanatory
Remarks

ITEM

12

' '

952
953

2
3

COMP
DET

12
12

9
9

2
3

0
0

1
1

954
955

4
5

CAP
UNITCAP

5
4

3
9

1
4

0
0

3
1

956

OD1

12

;Capacity
;Unit of
capacity
;Member 1 OD

957
958

7
8

OD2
OD3

12
12

1
1

3
4

0
0

3
3

;Member 2 OD
;Member 3 OD

959
960

9
10

P1
P2

13
13

1
1

5
6

0
0

3
3

;
;

11
12

11
12

P3
DATE

13
11

1
9

7
5

0
0

3
1


C38

202

202

18

203

203

18

204
208

204
208

EL
ANG

16
11

1
2

0
0

0
0

1
1

;Equipment group
no
;
;

;
;Date

;Site EW coord of
PP
;Site NS coord of
PP
;Site elev of PP
;Ang site N equip
N

Following is a list of form elements and their associated files:


A063
a063.eqp

Plant Design System (PDS) Equipment Eden Interface

159

Appendix: Delivered Parametrics


a063_ck.uf
a063.tdf
A063.fb

Define (E200)

This form appears when you select the Define option while in one of the following forms.
E205

E307

E210

E310

E215

E320

E230

E325

E240

E330

E245

E405

E305
E410
Once you complete modifications, select the ACCEPT option to return to previous parametric
form. Selecting the EXIT option ignores the current modifications and returns you to the
parametric main menu.

E200 Notes Specific to Form E200, Define

This form is used to define the attributes in the equipment group entity.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

160

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

DESC1

37

' '

952

DESC2

37

953

INSTHK

954

DATE

11

11

C38

T2210
Att No

Explanatory
Remarks
;Description
1
;Description
2
;Insulation
thk

;Date

Following is a list of form elements and their associated files:


E200
e200.uf
e200.tdf
E200.fb

Define Weights (E201)

This form appears when you select the Define Weights option in a parametric form.
E205

E307

E210

E310

E215

E320

E230

E325

E240

E330

E245

E405

E305

E410

Plant Design System (PDS) Equipment Eden Interface

161

Appendix: Delivered Parametrics


Once you complete modifications, select the ACCEPT option to return to previous parametric
form. Selecting the EXIT option ignores the current modifications and returns you to the
parametric main menu.

E201 Notes Specific to Form E201, Define Weights

This form is used to define the weight attributes in the equipment group entity along with the
locations of the center of gravity (CG) for each type of weight. Weights considered are dry and
operating.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

DRYWT

;Empty weight

952

15

71

953

15

72

954

DRYOFFP
RIM
DRYOFFS
EC
DRYOFFN
ORM

15

73

;Offset along
PRIMARY
;Offset along
SECONDARY
;Offset along
NORMAL

DRY

OPERATING 1
955

OP1WT

956

74

15

75

958

OP1OFFP
RIM
OP1OFFS
EC
OP1OFFN
ORM

15

957

15

76

;Operating 1
weight
;Offset along
PRIMARY
;Offset along
SECONDARY
;Offset along
NORMAL

OPERATING 2

959

OP2WT

960

10

77

11

15

78

12

12

OP2OFFP
RIM
OP2OFFS
EC
OP2OFFN
ORM

15

11

15

79

13

13

DATE

11

12

C38

;Operating 2
weight
;Offset along
PRIMARY
;Offset along
SECONDARY
;Offset along
NORMAL
-

;Date

Following is a list of form elements and their associated files:


E201
e201.uf
e201.tdf
E201.fb

162

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Complex Vertical Cylindrical Equipment, Skirt (E205)

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1, E2, or E3. The appropriate End form (E905 (see
"E1 Ends (E905)" on page 193), E906 (see "E2 Ends (E906)" on page 194) or E907 (see "E3
Ends (E907)" on page 195)) appears. Negative values define an inverted end.
You must define a minimum of one shell section. Four shell sections is the maximum that can
be defined. For each section, you must specify both length and diameter.
Shell graphics (P1-E3) contain thickness. Support graphics (P13-DP) do not contain
thickness.
Skirt or ring supports can be located with respect to DP2, DP3, or DP4. P16 must have a
negative value to locate the support below the data point. If P13, P14, and P15 are not
defined, the support is not placed.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) form.
Select the Define Weights option to establish the empty and operational weights of the
parametric using the Define Weights (E201) (on page 161) form.
When in an input field, entering a value of zero eliminates that section of the parametric.

E205 Notes Specific to Form E205, Complex Vert Cyl Equip

A minimum of one and a maximum of four shell sections may be defined. For a section, both
its length and diameter must be specified.
Shell graphics have the thickness added. Support graphics do not have the thickness added.
For E1, E2, and E3, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD,
HEMI, NONE, TORC, or TORS. Use a negative sign to define an inverted end. If additional
details are required, the system will provide access to a secondary form. If revision of details is
desired, re-entry of the applicable end type is required.

Plant Design System (PDS) Equipment Eden Interface

163

Appendix: Delivered Parametrics

Either skirt or ring supports may be defined. If P13, P14, or P15 is not defined, the support will
be omitted. The support may be located with respect to PP2, PP3, or PP4. P16 must have a
negative value to locate the support below the PP.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No / Att
No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

953

E1

"2T01"

954

P2

14

955

P3

14

956
957

6
7

P4
P5

14
14

1
1

4
5

0
0

3
3

;
;

958
959

8
9

P6
P7

14
14

1
1

6
7

0
0

3
3

;
;

960
11

10
11

P8
P9

14
14

1
1

8
9

0
0

3
3

;
;

12

12

E2

"NONE"

13
14

13
14

P10
P11

14
14

1
1

10
11

0
0

3
3

;
;

15
16

15
16

P12
E3

14
5

1
9

12
3

0
0

3
3


"NONE"

;
;

17

17

P13

14

13

18
19

18
19

P14
P15

14
14

1
1

14
15

0
0

3
3

;
;

20

20

P16

15

16

21

21

PP

17

22
23

22
23

TUTNO
DATE

4
11

7
9

4
4

0
0

1
1

"E205"
C38

;Distance
from PP to btm
of
support
;PP for
support
;Form no
;Date

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

SHELL

SUPPORT

164

Following is a list of form elements and their associated files:


E205

End E1

End E2

End E3

General place
head routine

Define

Define
Weights

e205.eq
p

e905.uf

e906.uf

e907.uf

pl_head.uf

e200.uf

e201.uf

e205_ck. e905_ck. e906_ck. e907_ck. pl_dome.uf


uf
uf
uf
uf

e200.tdf

e201.tdf

e205.tdf

e905.tdf

e906.tdf

e907.tdf

pl_torisph.uf

E200.fb

E201.fb

E205.fb

E905.fb

E906.fb

E907.fb

pl_toricon.uf

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Simple Vertical Cylindrical Equipment, Skirt (E210)

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1 or E2. The appropriate End form (E905 (see "E1
Ends (E905)" on page 193) or E906 (see "E2 Ends (E906)" on page 194)) appears. Negative
values define an inverted end.
Shell graphics (P1-E2) contain thickness. Support graphics (P4-DP) do not contain thickness.
Skirt or ring supports can be located with respect to DP2, DP3, or DP7. P16 must have a
negative value to locate the support below the data point. If P4, P5, and P6 are not defined, the
support is not placed.
Select the Define option to establish user specific definitions and insulation thickness using
the E200 (see "Define (E200)" on page 160) Define (E200) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E210 Notes Specific to Form E210, Simple Vert Cyl Equip, Skirt

Shell graphics have the thickness added. Support graphics do not have the thickness added.
For E1 and E2, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS. Use a negative sign to define an inverted end. If additional details
are required, the system will provide access to a secondary form. If revision of details is
desired, re-entry of the applicable end type is required.
Either skirt or ring supports may be defined. If P4, P5, or P6 is not defined, the support will be
omitted. The support may be located with respect to PP2 or PP3. P7 must have a negative
value to locate the support below the PP.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

ITEM

12

' '

Plant Design System (PDS) Equipment Eden Interface

T2210
Att No

Explanatory
Remarks
;Equip group
no

165

Appendix: Delivered Parametrics


Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

952

P1

953
954

3
4

E1
P2

5
14

9
1

1
2

0
0

3
3

"2T01"

;
;

955
956

5
6

P3
E2

14
5

1
9

3
2

0
0

3
3


"2T01"

;
;

957

P4

14

958

P5

14

959
960

9
10

P6
P7

14
14

1
1

6
7

0
0

3
3

;
;Distance
from PP to btm
of
support

11

11

PP

;PP for
support

12
13

12
13

TUTNO
DATE

4
11

7
9

4
3

0
0

1
1

"E210"
C38

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

SHELL

SUPPORT

166

;Form no
;Date

Following is a list of form elements and their associated files:


E210

End E1

End E2

General place
head routine

Define

Define
Weights

e210.eqp

e905.uf

e906.uf

pl_head.uf

e200.uf

e201.uf

e210_ck.uf

e905_ck.uf

e906_ck.uf

pl_dome.uf

e200.tdf

e201.tdf

e210.tdf

e905.tdf

e906.tdf

pl_torisph.uf

E200.fb

E201.fb

E210.fb

E905.fb

E906.fb

pl_toricon.uf

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Simple Vertical Cylindrical Equipment, Legs (E215)

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1 or E2. The appropriate End form (E905 (see "E1
Ends (E905)" on page 193) or E906 (see "E2 Ends (E906)" on page 194)) appears. Negative
values define an inverted end.
Shell graphics (P1-E2) contain thickness. Support graphics (P4-DP) do not contain thickness.
Leg or lug supports can be located with respect to DP2 or DP3. P9 must have a negative value
to locate the support below the data point. If P5, P6, P7, and P8 are not defined, the support is
not placed. P5 specifies the number of supports (supports will be equally spaced).
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E215 Notes Specific to Form E215, Simple Vert Cyl Equip, Legs

Shell graphics have the thickness added. Support graphics do not have the thickness added.
For E1 and E2, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS. Use a negative sign to define an inverted end. If additional details
are required, the system will provide access to a secondary form. If revision of details is
desired, re-entry of the applicable end type is required.
Either leg or lug supports may be defined. Use P5 to specify number of supports; supports will
be equally spaced. If P5, P6, P7, or P8 is not defined, the support will be omitted. The support
may be located with respect to PP2 or PP3. P9 must have a negative value to locate the
support below the PP.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Plant Design System (PDS) Equipment Eden Interface

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

167

Appendix: Delivered Parametrics


Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

953

E1

"2T01"

954

P2

14

955
956

5
6

P3
E2

14
5

1
9

3
2

0
0

3
3


"2T01"

;
;

957

P4

11

958

P5

959
960

9
10

P6
P7

13
12

1
1

6
7

0
0

3
3

;
;

11
12

11
12

P8
P9

12
14

1
1

8
9

0
0

3
3

13

13

PP

10

;
;Distance
from PP to btm
of support
;PP for
support

14
15

14
15

TUTNO
DATE

4
11

7
9

4
3

0
0

1
1

"E215"
C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

208

208

ANG

11

SHELL

SUPPORTS

168

;Form no
;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


E215

End E1

End E2

General place
head routine

Define

Define
Weights

e215.eqp

e905.uf

e906.uf

pl_head.uf

e200.uf

e201.uf

e215_ck.uf

e905_ck.uf

e906_ck.uf pl_dome.uf

e200.tdf

e201.tdf

e215.tdf

e905.tdf

e906.tdf

pl_torisph.uf

E200.fb

E201.fb

E215.fb

E905.fb

E906.fb

pl_toricon.uf

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Spherical Equipment (E230)

Shell graphics (P1-P2) contain thickness. Support graphics (P3-P9) do not contain thickness.
P4 specifies the number of supports (supports will be equally spaced). If P4, P6, and P9 are
not defined, the supports will not be placed.
When defining cylindrical legs, leave P7 blank.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E230 Notes Specific to Form E230, Spherical Equip

Shell graphics have the thickness added. Support graphics do not have the thickness added.
Use P4 to specify number of supports; supports will be equally spaced. If P4, P6, or P9 is not
defined, the support will be omitted. For cylindrical legs, leave P7 blank.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

;Equip group
no

952

P1

953

P2

14

954

P3

11

955
956

5
6

P4
P5

2
14

3
1

4
5

0
0

3
3

;
;

SHELL

SUPPORTS

Plant Design System (PDS) Equipment Eden Interface

169

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

957
958

7
8

P6
P7

12
12

1
1

6
7

0
0

3
3

;
;

959
960

9
10

P8
P9

14
14

1
1

8
9

0
0

3
3

;
;

11

11

TUTNO

"E230"

12

12

DATE

11

C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

208

208

ANG

11

;Form no
-

;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


E230

Define

Define Weights

e230.eqp

e200.uf

e201.uf

e230_ck.uf

e200.tdf

e201.tdf

e230.tdf

E200.fb

E201.fb

E230.fb

Complex Horizontal Cylindrical Equipment (E240)

170

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1, E2, or E3. The appropriate End form (E905 (see
"E1 Ends (E905)" on page 193), E906 (see "E2 Ends (E906)" on page 194), or E907 (see "E3
Ends (E907)" on page 195) ) appears. Negative values define an inverted end.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Shell graphics (P1-P7) contain thickness. Support graphics (P8-SLPE) do not contain
thickness.
If P4, P5, and P6 are not defined, the boot is not placed.
If P9, P10, and P11 are not defined, the corresponding support(s) and stiffening ring(s) are not
placed.
If P12 is not defined, all supports and their stiffening rings are not placed.
If P8 and P13 are not defined, all supports are not placed.
If P14 is not defined, all stiffening rings are not placed.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E240 Notes Specific to Form E240, Complex Hor Cyl Equip

Shell and boot graphics have the thickness added. Support graphics do not have the thickness
added. If P4, P5, or P6 is not defined, the boot will be omitted.
For E1, E2, and E3, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD,
HEMI, NONE, TORC, or TORS. Use a negative sign to define an inverted end. If additional
details are required, the system will provide access to a secondary form. If revision of details is
desired, re-entry of the applicable end type is required.
If P9, P10, and/or P11 are not defined, the corresponding support(s) and stiffening ring(s) will
be omitted.
If P12 is not defined, all supports and their stiffening rings will be omitted.
If P8 or P13 is not defined, all supports will be omitted.
If P14 is not defined, all stiffening rings will be omitted.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

953
954

3
4

E1
P2

5
14

9
1

1
2

0
0

3
3

"2T01"

;
;

955
956

5
6

P3
E2

13
5

1
9

3
2

0
0

3
3


"2T01"

;
;

957
958

7
8

P4
P5

14
13

1
1

4
5

0
0

3
3

;
;

959
960

9
10

P6
E3

13
5

1
9

6
3

0
0

3
3


"NONE"

;
;

11

11

P7

11

12

12

P8

13

13
14

13
14

P9
P10

13
14

1
1

9
10

0
0

3
3

;
;

15

15

P11

14

11

SHELL

SUPPORTS

Plant Design System (PDS) Equipment Eden Interface

171

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

16
17

16
17

P12
P13

12
13

1
1

12
13

0
0

3
3

;
;

18
19

18
19

P14
ANCH

13
1

1
3

14
15

0
0

3
3

;
;Anchor end

20

20

TUTNO

"E240"

21

21

DATE

11

C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

208

208

ANG

11

209

209

SLOPE

13

;Form no
-

;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N
;Slope

Following is a list of form elements and their associated files:


E240

End E1

End E2

End E3

General place
head routine

Define

Define
Weights

e240.eqp

e905.uf

e906.uf

e907.uf

pl_head.uf

e200.uf

e201.uf

e240_ck.u e905_ck. e906_ck. e907_ck.uf pl_dome.uf


f
uf
uf

e200.tdf e201.tdf

e240_el.uf e905.tdf

e906.tdf

e907.tdf

pl_torisph.uf

E200.fb

e240.tdf

E906.fb

E907.fb

pl_toricon.uf

E905.fb

E201.fb

E240.fb

Simple Horizontal Cylindrical Equipment (E245)

172

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1 or E2. The appropriate End form (E905 (see "E1
Ends (E905)" on page 193) or E906 (see "E2 Ends (E906)" on page 194)) appears. Negative
values define an inverted end.
Shell graphics (P1-E2) contain thickness. Support graphics (P4-SLPE) do not contain
thickness.
If P5 and P6 are not defined, the corresponding support is not placed.
If P4, P7, and P8 are not defined, all supports are not placed.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E245 Notes Specific to Form E245, Simple Hor Cyl Equip

Shell graphics have the thickness added. Support graphics do not have the thickness added.
For E1 and E2, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS. Use a negative sign to define an inverted end. If additional details
are required, the system will provide access to a secondary form. If revision of details is
desired, re-entry of the applicable end type is required.
If P5 or P6 is not defined, the corresponding supports will be omitted.
If P4, P7, or P8 is not defined, all supports will be omitted.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label
951

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

ITEM

12

' '

;Equip group
no

952

P1

953

E1

"2T01"

954
955

4
5

P2
P3

14
13

1
1

2
3

0
0

3
3

;
;

956

E2

"2T01"

957

P4

13

958
959

8
9

P5
P6

13
14

1
1

5
6

0
0

3
3

;
;

960
11

10
11

P7
P8

12
13

1
1

7
8

0
0

3
3

;
;

12

12

ANCH

;Anchor end

13

13

TUTNO

"E245"

14

14

DATE

11

C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

SHELL

SUPPORTS

Plant Design System (PDS) Equipment Eden Interface

;Form no
-

;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP

173

Appendix: Delivered Parametrics

208

208

ANG

11

209

209

SLOPE

13

;Ang site N
equip N
;Slope

Following is a list of form elements and their associated files:


E245

End E1

End E2

General place head Define


routine

Define
Weights

e245.eqp

e905.uf

e906.uf

pl_head.uf

e200.uf

e201.uf

e245_ck.uf e905_ck.uf

e906_ck.uf

pl_dome.uf

e200.tdf

e201.tdf

e245.tdf

e905.tdf

e906.tdf

pl_torisph.uf

E200.fb

E201.fb

E245.fb

E905.fb

E906.fb

pl_toricon.uf

Horizontal Shell and Tube Exchanger (E305)

174

If P7 and P8 are not defined, the expansion joint is not placed.


P10 defines the bundle pulling area. The default is the value for P1.
If P11 and P12 are not defined, the corresponding bottom support is not placed.
If P15 and P19 are not defined, the corresponding bottom or top supports are not placed.
If P16 is not defined, all supports are not placed.
If P17 and P18 are not defined, the corresponding top support is not placed.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Select the Define Channel option to define the ends for the exchanger using the Exchanger
Ends (E319) (on page 180) form.

E305 Notes Specific to Form E305, Hor S&T Exchanger

Use the DEFINE CHANNEL command to define the exchanger ends.


If P7 or P8 is not defined, the expansion joint will be omitted.
Use P10 to define the bundle pulling area. It defaults to P1.
If P11 or P12 is not defined, the corresponding bottom support will be omitted.
If P15 or P19 is not defined, the corresponding bottom or top supports will be omitted.
If P16 is not defined, all supports will be omitted.
If P17 or P18 is not defined, the corresponding top support will be omitted.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

13

953

P2

13

954
955

4
5

P3
P4

9
13

1
1

3
4

0
0

3
3

;
;

956
957

6
7

P5
P6

9
9

1
1

5
6

0
0

3
3

;
;

958
959

8
9

P7
P8

13
12

1
1

7
8

0
0

3
3

;
;

960
11

10
11

P9
P10

13
13

1
1

9
10

0
0

3
3


F2

;
;

12

12

P11

13

11

13

13

P12

13

12

14
15

14
15

P13
P14

12
12

1
1

13
14

0
0

3
3

;
;

16
17

16
17

P15
P16

13
13

1
1

15
16

0
0

3
3

;
;

18

18

P17

13

17

19
20

19
20

P18
P19

13
13

1
1

18
19

0
0

3
3

;
;

21

21

ANCH

20

;Anchor
support

22

22

TUTNO

"E305"

23

23

DATE

11

C38

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

209

209

SLOPE

13

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N
;Slope

SHELL

SUPPORTS

;Form no
-

;Date

Following is a list of form elements and their associated files:

Plant Design System (PDS) Equipment Eden Interface

175

Appendix: Delivered Parametrics


E305

E319

General place
channel routine

Define

Define
Weights

e305.eqp

e319.uf

pl_channel.uf

e200.uf

e201.uf

e200.tdf

e201.tdf

E200.fb

E201.fb

e305_ck.uf
e305.tdf

e319.tdf

E305.fb

E319.fb

Kettle Exchanger (E307)

176

To define the ends of this form, key in 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI,
NONE, TORC, or TORS in the input fields E1 or E2. The appropriate End form (E905 (see "E1
Ends (E905)" on page 193) or E906 (see "E2 Ends (E906)" on page 194)) appears.
P9 defines the bundle pulling area.
If P10, P11, P12, and P13 are not defined, the corresponding support is not placed.
If P14 and P15 are not defined, all supports are not placed.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.
Select the Define Channel option to define the ends for the exchanger using the Exchanger
Ends (E319) (on page 180) form.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


E307 Notes Specific to Form E307, Kettle Exchanger

Use the DEFINE CHANNEL command to define the exchanger ends.


For E1, define the applicable of 2T01, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI, NONE,
TORC, or TORS. Use a negative sign to define an inverted end. If additional details are
required, the system will provide access to a secondary form. If revision of details is desired,
re-entry of the applicable end type is required.
Use P9 to define the bundle pulling area.
If P10, P11, P12, or P13 is not defined, the corresponding support will be omitted.
If P14 or P15 is not defined, all supports will be omitted.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

13

953

P2

13

954
955

4
5

P3
P4

13
13

1
1

3
4

0
0

3
3

;
;

956
957

6
7

P5
P6

13
9

1
1

5
6

0
0

3
3

;
;

958
959

8
9

P7
P8

13
9

1
1

7
8

0
0

3
3

;
;

960
11

10
11

P9
E1

13
5

1
9

9
1

0
0

3
3


"2T01"

;
;

12

12

P10

13

10

13

13

P11

13

11

14
15

14
15

P12
P13

12
12

1
1

12
13

0
0

3
3

;
;

16
17

16
17

P14
P15

13
13

1
1

14
15

0
0

3
3

;
;

18

18

ANCH

16

;Anchor
support

19
20
201
202

19
20
201
202

TUTNO
DATE
PP
X

4
11
1
18

7
9
1
1

4
4
0
0

0
0
0
0

1
1
1
1

"E307"
C38
1

203

203

18

204

204

EL

16

208

208

ANG

11

209

209

SLOPE

13

SHELL

SUPPORTS

;Form no
;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N
;Slope

Following is a list of form elements and their associated files:


E307

End E1

e307.eqp e905.uf

General place E319


head routine

pl_head.uf

General
place
channel
routine

Define

e319e307. pl_channel.uf e200.uf


uf

Plant Design System (PDS) Equipment Eden Interface

Define
Weights

e201.uf

177

Appendix: Delivered Parametrics


e307_ck. e905_ck pl_dome.uf
uf
.uf

e319e307
_ck.uf

e200.tdf

e201.tdf

e307.tdf

e905.tdf pl_torisph.uf

e319.tdf

E200.fb

E201.fb

E307.fb

E905.fb

E319.fb

pl_toricon.uf

Vertical Shell and Tube Exchanger (E310)

If P7 and P8 are not defined, the extension joint is not placed.


P10 defines the bundle pulling area. The default is the value for P1.
For a skirt or ring support, do not enter a value for P12. If P13 and P15 are not defined, the
support is not placed. P14 must have a negative value to locate the support below data point
one (DP)1.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E210) (see "Define Weights (E201)" on page 161) form.
Select the Define Channel option to define the ends for the exchanger using the Exchanger
Ends (E319) (on page 180) form.

E310 Notes Specific to Form E310, Vert S&T Exchanger

178

Use the DEFINE CHANNEL command to define the exchanger ends.


If P7 or P8 is not defined, the expansion joint will be omitted.
Use P10 to define the bundle pulling area. It defaults to P1.
Either skirt, ring, or lug supports may be defined, as follows:
To define a skirt or ring, do not define a value for P12.
If P13 or P15 is not defined, the support will be omitted.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

P14 must have a negative value to locate the support below PP1.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

;Equip group
no

952

P1

14

953

P2

13

954

P3

955

P4

13

956
957

6
7

P5
P6

9
9

1
1

5
6

0
0

3
3

;
;

958
959

8
9

P7
P8

13
12

1
1

7
8

0
0

3
3

;
;

960
11

10
11

P9
P10

13
14

1
1

9
10

0
0

3
3


F2

;
;

12

12

P11

11

11

13

13

P12

12

14

14

P13

13

13

15

15

P14

15

14

16

16

P15

13

15

17
18

17
18

P16
P17

13
12

1
1

16
17

0
0

3
3

;
;

19

19

TUTNO

"E310"

20

20

DATE

11

C38

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

SHELL

SUPPORTS

;Form no
-

;Date

Following is a list of form elements and their associated files:


E310

E319

General place
channel routine

Define

Define Weights

e310.eqp

e319.uf

pl_channel.uf

e200.uf

e201.uf

e200.tdf

e201.tdf

E200.fb

E201.fb

e310_ck.uf
e310.tdf

e319.tdf

E310.fb

E319.fb

Plant Design System (PDS) Equipment Eden Interface

179

Appendix: Delivered Parametrics

Exchanger Ends (E319)

To enter this form, you must select the Define Channel option in an Exchanger form (E305
(see "Horizontal Shell and Tube Exchanger (E305)" on page 174), E307 (see "Kettle
Exchanger (E307)" on page 176), or E310 (see "Vertical Shell and Tube Exchanger (E310)"
on page 178)).
To accept the current modifications and return to the exchanger form, select the ACCEPT
option. Select the EXIT option to ignore the current modifications and return to the parametric
main menu.
Enter the applicable code (found under each graphic) in the TYPE field.
P30 defines the front shell flange on the shell side of the exchanger.
P32 defines the channel inlet location.
P40 defines the rear shell flange on the shell side of the exchanger.
For exchanger ends B, M, S, T, U, and W2, the system hardcodes the end to a 2TO1 end.

E319 Notes Specific to Form E319, Exchanger Ends

In the TYPE field, define the code that applies.


P30 defines the front shell flange on the shell side of the exchanger.
P32 defines the location of the channel inlet.
P40 defines the rear shell flange on the shell side of the exchanger.
For exchanger ends B, M, S, T, U, and W2 the system hardcodes the end to a "+2T01" end.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

FETYPE

952

P30

13

30

T2210
Att No

Explanatory
Remarks

FRONT END

180

;Front end
type
;

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


953

P31

31

954
955

4
5

P32
P33

12
12

1
1

32
33

0
0

3
3

;
;

956
957

6
7

P34
P35

9
9

1
1

34
35

0
0

3
3

;
;

958

RETYPE

;Rear end type

959

P40

13

40

960
11

10
11

P41
P42

9
12

1
1

41
42

0
0

3
3

;
;

12
13

12
13

P43
P44

13
9

1
1

43
44

0
0

3
3

;
;

14

14

DATE

11

10

C38

REAR END

;Date

Following is a list of form elements and their associated files:


E319

General place channel routine

e319.uf

pl_channel.uf

e319_ck.uf
e319.tdf
E319.fb

Double Pipe Exchanger (E320)

P4 is a nominal pipe diameter dimension. Actual outside diameter is used for graphic display.
P8 defines the bundle pulling area. The default is the value of P1 + P2.
If P9 and P10 are not defined, the corresponding support is not placed.
If P12 is not defined, all supports are not placed.

Plant Design System (PDS) Equipment Eden Interface

181

Appendix: Delivered Parametrics

The ANCH field defines which support will be anchored.


The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E320 Notes Specific to Form E320, Dbl Pipe Exchanger

P4 is a nominal pipe diameter dimension. Actual OD is used for graphic display.


Use P8 to define the bundle pulling area. It defaults to P1 + P2.
If P9 or P10 is not defined, the corresponding support will be omitted.
If P12 is not defined, all supports will be omitted.
The ANCH field defines which support will be anchored.
The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952

P1

13

953

P2

12

954
955

4
5

P3
P4

12
9

1
1

3
4

0
0

3
3

;
;

956
957

6
7

P5
P6

12
12

1
1

5
6

0
0

3
3

;
;

958
959

8
9

P7
P8

12
13

1
1

7
8

0
0

3
3


F2+F3

;
;

960

10

P9

13

11

11

P10

13

10

12
13

12
13

P11
P12

12
9

1
1

11
12

0
0

3
3

;
;

14
15

14
15

P13
ANCH

12
1

1
3

13
14

0
0

3
3

;
;

16

16

TUTNO

"E320"

17

17

DATE

11

C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

208

208

ANG

11

209

209

SLOPE

13

SHELL

SUPPORTS

182

;Form no
-

;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N
;Slope

Following is a list of form elements and their associated files:


E320

Define

Define Weights

e320.eqp

e200.uf

e201.uf

e320_ck.uf

e200.tdf

e201.tdf

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


e320.tdf

E200.fb

E201.fb

E320.fb

Plate Exchanger (E325)

The ANCH field defines which support will be anchored.


The SLPE field defines the rise per foot around the selected place point for sloped equipment.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E325 Notes Specific to Form E325, Plate Exchanger

The ANCH field defines which support will be anchored.


The SLPE field defines the rise per foot about the selected PP for sloped equipment.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

;Equip group
no

952

P1

13

953
954

3
4

P2
P3

13
9

1
1

2
3

0
0

3
3

;
;

955
956

5
6

P4
P5

13
13

1
1

4
5

0
0

3
3

;
;

957
958

7
8

P6
P7

13
13

1
1

6
7

0
0

3
3

;
;

EXCHANGER

Plant Design System (PDS) Equipment Eden Interface

183

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

959
960

9
10

P8
P9

13
9

1
1

8
9

0
0

3
3

;
;

11
12

11
12

P10
P11

13
9

1
1

10
11

0
0

3
3

;
;

13
14

13
14

P12
P13

12
13

1
1

12
13

0
0

3
3

;
;

15
16

15
16

P14
P15

9
12

1
1

14
15

0
0

3
3

;
;

17

17

ANCH

16

18

18

TUTNO

"E325"

19

19

DATE

11

C38

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

209

209

SLOPE

13

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N
;Slope

;Form no
-

;Date

Following is a list of form elements and their associated files:


E325

Define

Define Weights

e325.eqp

e200.uf

e201.uf

e325_ck.uf

e200.tdf

e201.tdf

e325.tdf

E200.fb

E201.fb

E325.fb

184

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Air Cooler (E330)

To select the appropriate Air Cooler Bay, you must key in either I or F in the TYPE field.
Type I (induced draft) brings up the Induced Draft Air Cooler Bay form (E332) (see "Induced
Draft Air Cooler Bay (E332)" on page 186).
Type F (forced draft) brings up the Forced Draft Air Cooler Bay form (E334) (see "Forced Draft
Air Cooler Bay (E334)" on page 188).
The BAYS field defines the number of units that apply.
Data points (DP) are assumed to be located at mid-height and mid-width of inlet headers.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E330 Notes Specific to Form E330, Air Cooler

In the TYPE field, define whether an induced (I) or a forced draft (F) air cooler applies. A
secondary form will be accessed to allow definition of details. All air coolers must be identical.
If revision of details is desired, re-entry of the applicable type is required.
In the BAYS field, define the number of units that apply.
DPs are assumed to be located at mid-height and mid-width of inlet headers.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

951

ITEM

12

' '

952

TYPE

;Equip group
no
;

953

BAYS

954

P1

12

Plant Design System (PDS) Equipment Eden Interface

T2210
Att No

Explanatory
Remarks

185

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

955
956

5
6

P2
P3

12
12

1
1

3
4

0
0

3
3

957

TUTNO

"E330"

958

DATE

11

C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

204

204

EL

16

208

208

ANG

11

T2210
Att No

Explanatory
Remarks
;
;
;Form no

;Date
;
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


E330

E332

E334

Define

Define Weights

e330.eqp

e332e334.uf

e334.tdf

e200.uf

e201.uf

e330_ck.uf

e332e334_ck.uf E334.fb

e200.tdf

e201.tdf

e330.tdf

e332.tdf

E200.fb

E201.fb

E330.fb

E332.fb

Induced Draft Air Cooler Bay (E332)

186

To enter this form, you must key in I in the Air Cooler form (E330) (see "Air Cooler (E330)" on
page 185). To accept the current modifications and return to the Air Cooler form, select the
ACCEPT option. Select the EXIT option to ignore the current modifications and return to the
parametric main menu.
Data points (DP) are assumed to be located at mid-height and mid-width of inlet headers.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

P30 defines the number of fans that apply in one unit. Fans are spaced by the distance
specified in P32.
If P34 is not defined, fans are not placed.

E332 Notes Specific to Form E332, Induced Draft Air Cooler Bay

DPs are assumed to be located at mid-height and mid-width of inlet header.


P30 defines the number of fans that apply in one unit. Fans are spaced by a distance P32.
If P34 is not defined, fans will be omitted.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

P21

13

21

' '

952

P22

13

22

953
954

3
4

P23
P24

13
13

1
1

23
24

0
0

3
3

;
;

955

P25

13

25

956

P26

12

26

957
958

7
8

P27
P28

12
12

1
1

27
28

0
0

3
3

;
;

959
960

9
10

P29
P30

12
1

1
3

29
30

0
0

3
3

;
;

11
12

11
12

P31
P32

13
13

1
1

31
32

0
0

3
3

;
;

13

13

P33

13

33

14

14

P34

12

34

15

15

DATE

11

10

C38

;
-

;Date

Following is a list of form elements and their associated files:


E332
e332e334.uf
e332e334_ck.uf
e332.tdf
E332.fb

Plant Design System (PDS) Equipment Eden Interface

187

Appendix: Delivered Parametrics

Forced Draft Air Cooler Bay (E334)

To enter this form, you must key in F in the Air Cooler form (E330) (see "Air Cooler (E330)" on
page 185). To accept the current modifications and return to the Air Cooler form, select the
ACCEPT option. Select the EXIT option to ignore the current modifications and return to the
parametric main menu.
Data points (DP) are assumed to be located at mid-height and mid-width of inlet headers.
P30 defines the number of fans that apply in one unit. Fan are spaced by the distance
specified in P32.
If P34 is not defined, fans are not placed.

E334 Notes Specific to Form E334, Forced Draft Air Cooler Bay

188

See paragraph E332 for notes.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

P21

13

21

952

P22

13

22

953
954

3
4

P23
P24

13
13

1
1

23
24

0
0

3
3

;
;

955
956

5
6

P25
P26

13
12

1
1

25
26

0
0

3
3

;
;

957
958

7
8

P27
P28

12
12

1
1

27
28

0
0

3
3

;
;

959

P29

12

29

960

10

P30

30

11
12

11
12

P31
P32

13
13

1
1

31
32

0
0

3
3

;
;

13
14

13
14

P33
P34

13
12

1
1

33
34

0
0

3
3

;
;

15

15

DATE

11

10

C38

Explanatory
Remarks

;Date

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Following is a list of form elements and their associated files:


E334
e332e334.uf
e332e334_ck.uf
e334.tdf
E334.fb

Horizontal Rotating Equipment and Driver (E405)

Values of P1, P2, P3, and P4 must be positive values greater than zero. Values for the other
fields are optional.
P5 must be specified as a negative value.
The following rules must be followed:
-P5 + P7 + P12 + P14 must be less than or equal to P1.
P8 must be less than or equal to P2.
P9 must be less than or equal to P3.
P15 must be less than or equal to P2.
P16 must be less than or equal to P3.
P17 must be greater than P11 + P13 / 2.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

Plant Design System (PDS) Equipment Eden Interface

189

Appendix: Delivered Parametrics


E405 Notes Specific to Form E405, Hor Rot Equip & Driver

Values of P1, P2, P3, and P4 must be nonzero positive values. Values for other fields are
optional.
P5 must be specified as a negative value.
Following rules must be observed:
-P5 + P7 + P12 + P14 must be less than or equal to P1
P8 must be less than or equal to P2
P9 must be less than or equal to P3
P15 must be less than or equal to P2
P16 must be less than or equal to P3
P17 must be greater than P11 + P13/2
The following comments apply, but do not include in the help form:
P13/2 must be less than P8
P13/2 must be less than P9
P13/2 must be less than P10
P13/2 must be less than P11
P13/2 must be less than P15
P13/2 must be less than P16
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No / Att
No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

952
953

2
3

P1
P2

13
13

1
1

1
2

0
0

3
3

;
;

954
955

4
5

P3
P4

13
12

1
1

3
4

0
0

3
3

;
;

956

P5

14

BASE

ROTATING EQUIP
957

P6

13

958
959

8
9

P7
P8

13
13

1
1

7
8

0
0

3
3

;
;

960
11

10
11

P9
P10

13
13

1
1

9
10

0
0

3
3

;
;

12

12

P11

13

11

13

13

P12

13

12

14
15

14
15

P13
P14

12
13

1
1

13
14

0
0

3
3

;
;

16
17

16
17

P15
P16

13
13

1
1

15
16

0
0

3
3

;
;

18

18

P17

13

17

19
20

19
20

TUTNO
DATE

4
11

7
9

4
1

0
0

1
1

"E405"
C38

201
202

201
202

PP
X

1
18

1
1

0
0

0
0

1
1

203

203

18

DRIVER

190

;Form no
;Date
;
;Site EW coord
of PP
;Site NS coord
of PP

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No / Att
No

Nozzle
Seq No

Exit
Code

Default
Value

204

204

EL

16

208

208

ANG

11

T2210
Att No

Explanatory
Remarks
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


E405

Define

Define Weights

e405.eqp

e200.uf

e201.uf

e405_ck.uf

e200.tdf

e201.tdf

e405.tdf

E200.fb

E201.fb

E405.fb

Vertical Rotating Equipment and Driver (E410)

Values of P1, P2, P3, and P4 must be positive values greater than zero. Values for the other
fields are optional.
P9 defines the pulling area.
Select the Define option to establish user specific definitions and insulation thickness using
the Define (E200) (on page 160) form.
Select the Define Weights option to establish the empty and operational weight of the
parametric using the Define Weights (E201) (on page 161) form.

E410 Notes Specific to Form E410, Vert Rot Equip & Driver

Values of P1, P2, P3, and P4 must be nonzero positive values. Values for other fields are
optional.
Use P9 to define the pulling area.

Plant Design System (PDS) Equipment Eden Interface

191

Appendix: Delivered Parametrics

The following comments apply, but do not include in the help form:
If P5 is specified, value of P5 must be less than or equal to value of P3.
If P8 is specified, value of P8 must be greater than or equal to value of P3.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

ITEM

12

' '

;Equip group
no

PUMP
952

P1

13

953
954

3
4

P2
P3

13
13

1
1

2
3

0
0

3
3

;
;

955
956

5
6

P4
P5

13
12

1
1

4
5

0
0

3
3

;
;

957

P6

13

958
959

8
9

P7
P8

13
13

1
1

7
8

0
0

3
3

;
;

960

10

P9

13

11
12

11
12

TUTNO
DATE

4
11

7
9

4
1

0
0

1
1

"E410"
C38

201

201

PP

202

202

18

203

203

18

204

204

EL

16

208

208

ANG

11

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

DRIVER

;Form no
;Date

Following is a list of form elements and their associated files:


E410

Define

Define Weights

e410.eqp

e200.uf

e201.uf

e410_ck.uf

e200.tdf

e201.tdf

e410.tdf

E200.fb

E201.fb

E410.fb

192

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

E1 Ends (E905)

Valid for the E1 prompt (E205 (see "Complex Vertical Cylindrical Equipment, Skirt (E205)" on
page 163) or E240 (see "Complex Horizontal Cylindrical Equipment (E240)" on page 170))
include: 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI, NONE, TORC, or TORS.
2TO1, CAP, F&D, FLAT, HEMI, and NONE ends are depicted using data retrieved by the system
(Form E905 is not displayed).
CONE, DOME, FLGD, TORC, and TORS ends are depicted from data defined in this form (Form
E905 is displayed and must be defined).

E905 Notes Specific to Form E905, E1 Ends

2T01, CAP, F&D, FLAT, HEMI, and NONE ends are depicted using data derived by the
system.
CONE, DOME, FLGD, TORC, and TORS ends are depicted from data defined in this form.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

TYPE

31

'C1'

;Head type

952
953

2
3

P50
P51

14
13

1
1

50
51

0
0

3
3

;
;

954
955

4
5

P52
DATE

13
11

1
9

52
34

0
0

3
1


C38

Explanatory
Remarks

;
;Date

Following is a list of form elements and their associated files:


E905
e905.uf
e905_ck.uf

Plant Design System (PDS) Equipment Eden Interface

193

Appendix: Delivered Parametrics


e905.tdf
E905.fb

E2 Ends (E906)

Valid values for the E2 prompt (E205 (see "Complex Vertical Cylindrical Equipment, Skirt
(E205)" on page 163) or E240 (see "Complex Horizontal Cylindrical Equipment (E240)" on
page 170)) include: 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI, NONE, TORC, or TORS.
2TO1, CAP, F&D, FLAT, HEMI, and NONE ends are depicted using data retrieved by the system
(Form E906 is not displayed).
CONE, DOME, FLGD, TORC, and TORS ends are depicted from data defined in this form (Form
E906 is displayed and must be defined).

E906 Notes Specific to Form E906, E2 Ends

Refer to paragraph E905 for comments.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

TYPE

32

'C2'

;Head type

952
953

2
3

P55
P56

14
13

1
1

55
56

0
0

3
3

;
;

954
955

4
5

P57
DATE

13
11

1
9

57
35

0
0

3
1


C38

Explanatory
Remarks

;
;Date

Following is a list of form elements and their associated files:


E906
e906.uf

194

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


e906_ck.uf
e906.tdf
E906.fb

E3 Ends (E907)

Valid values for the E3 prompt (E205 (see "Complex Vertical Cylindrical Equipment, Skirt
(E205)" on page 163) or E240 (see "Complex Horizontal Cylindrical Equipment (E240)" on
page 170)) include: 2TO1, CAP, CONE, DOME, F&D, FLAT, FLGD, HEMI, NONE, TORC, or TORS.
2TO1, CAP, F&D, FLAT, HEMI, and NONE ends are depicted using data retrieved by the system
(Form E907 is not displayed).
CONE, DOME, FLGD, TORC, and TORS ends are depicted from data defined in this form (Form
E907 is displayed and must be defined).

E907 Notes Specific to Form E907, E3 Ends

Refer to paragraph E905 for comments.


Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

951

TYPE

33

'C3'

;Head type

952
953

2
3

P60
P61

14
13

1
1

60
61

0
0

3
3

;
;

954

P62

13

62

955

DATE

11

36

C38

Explanatory
Remarks

;Date

Following is a list of form elements and their associated files:

Plant Design System (PDS) Equipment Eden Interface

195

Appendix: Delivered Parametrics


E907
e907.uf
e907_ck.uf
e907.tdf
E907.fb

Complex Vertical Cylindrical Equipment (N205)

The nozzle parametrics, N205 - N410, are included in this appendix, but Appendix:
Equipment Data Definition contains more information on nozzles.

196

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Simple Vertical Cylindrical Equipment (N210)

Simple Vertical Cylindrical Equipment (N215)

Plant Design System (PDS) Equipment Eden Interface

197

Appendix: Delivered Parametrics

Spherical Equipment (N230)

Complex Horizontal Cylindrical Equipment (N240)

198

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Simple Horizontal Cylindrical Equipment (N245)

Horizontal Shell and Tube Exchanger (N305)

Plant Design System (PDS) Equipment Eden Interface

199

Appendix: Delivered Parametrics

Kettle Exchanger (N307)

Vertical Shell and Tube Exchanger (N310)

200

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Double Pipe Exchanger (N320)

Plate Exchanger (N325)

Plant Design System (PDS) Equipment Eden Interface

201

Appendix: Delivered Parametrics

Air Cooler (N330)

Horizontal Rotating Equipment and Driver (N405)

202

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Vertical Rotating Equipment and Driver (N410)

Gear Cover (U850)

U850 Notes Specific to Form U850, Gear Cover

This form is used to define a flat oval projected with face parallel to each other.

Plant Design System (PDS) Equipment Eden Interface

203

Appendix: Delivered Parametrics

It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection. The active secondary axis orients the flat sides of the faces.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

16

' '

;Distance

952

16

;Diameter1

953
954

3
4

C
D

16
16

1
1

3
4

0
0

2
2

;Diameter2
;Projection

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U850
u850.eqp
u850.uf
u850.tdf
U850.fb

Round Torus Miter (U860)

204

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


U860 Notes Specific to Form U860, Circular Miter

This form is used to define a segmented round torus.


It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection of the first segment. The active secondary axis points to the center of rotation.
Maximum number of miter sections per miter is 30.
Maximum bend angle per miter is 180 degrees.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

951

16

' '

;Bend radius

952

16

;Bend angle

953

16

954

16

;No of miter
sections
;Cyl diameter

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U860
u860.eqp
u860.uf
u860.tdf
U860.fb

Plant Design System (PDS) Equipment Eden Interface

205

Appendix: Delivered Parametrics

Rectangular Torus Miter (U861)

U861 Notes Specific to Form U861, Rectangular Miter

This form is used to define a segmented rectangular torus.


It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection of the first segment. The active secondary axis points to the center of rotation.
Maximum number of miter sections per miter is 30.
Maximum bend angle per miter is 180 degrees.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

951

16

' '

;Bend radius

952

16

;Bend angle

953

16

954

16

;No of miter
sections
;Rect depth

955

16

;Rect width

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U861
u861.eqp
u861.uf

206

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


u861.tdf
U861.fb

Vertical Oval Torus Miter (U862)

U862 Notes Specific to Form U862, Vertical Oval Miter

This form is used to define a segmented flat oval torus.


It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection of the first segment. The active secondary axis points to the center of rotation.
Maximum number of miter sections per miter is 30.
Maximum bend angle per miter is 180 degrees.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

16

' '

;Bend radius

952
953

2
3

B
C

16
16

2
3

2
3

0
0

2
2

954
955

4
5

D
E

16
16

1
1

4
5

0
0

2
2

;Bend angle
;No of miter
sections
;Oval depth
;Oval width

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:

Plant Design System (PDS) Equipment Eden Interface

207

Appendix: Delivered Parametrics


U862
u862.eqp
u862.uf
u862.tdf
U862.fb

Flat Oval Torus Miter (U863)

U863 Notes Specific to Form U863, Horizontal Oval Miter

208

This form is used to define a segmented horizontal flat oval torus.


It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection of the first segment. The active secondary axis points to the center of rotation.
Maximum number of miter sections per miter is 30.
Maximum bend angle per miter is 180 degrees.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

951

16

' '

;Bend radius

952

16

;Bend angle

953

16

954
955

4
5

D
E

16
16

1
1

4
5

0
0

2
2

;No of miter
sections
;Oval depth
;Oval width

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

T2210 Att
No

Explanatory
Remarks
;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U863
u863.eqp
u863.uf
u863.tdf
U863.fb

Flat Oval Prism (U870)

U870 Notes Specific to Form U870, Oval to Oval Prism

This form is used to define a flat oval prism projected with face parallel but offset along both
secondary and normal axis to each other.
It is placed by a point in the middle of the first face. The active primary axis orients the direction
of projection. The active secondary axis orients the flat sides of the faces.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDFNo

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Plant Design System (PDS) Equipment Eden Interface

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

209

Appendix: Delivered Parametrics

Form
Gadget
Label

TDFNo

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

951

16

' '

;Prism height

952

16

;Oval width1

953
954

3
4

C
D

16
16

1
1

3
4

0
0

2
2

;Oval depth1
;Oval width2

955
956

5
6

E
F

16
16

1
1

5
6

0
0

2
2


'0'

;Oval depth2
;Oval offset1

957

16

'0'

;Oval offset2

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U870
u870.eqp
u870.uf
u870.tdf
U870.fb

Flat Oval Torus (U880)

U880 Notes Specific to Form U880, Oval Torus

210

This form is used to define a flat oval torus.

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics

It is placed by a point in the middle of the first face. The active primary axis is the normal of the
starting face. The active secondary axis points to the center of rotation.
A value of 0 for Parameter E (oval rotation) places the oval face vertical. A value of 90 for
Parameter E (oval rotation) places the oval face horizontal.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF Name

Field
Length

Field
Type

Var No /
Att No

Nozzle Seq
No

Exit
Code

Default
Value

T2210 Att
No

Explanatory
Remarks

951

16

' '

;Bend radius

952
953

2
3

B
C

16
16

2
1

2
3

0
0

2
2

;Bend angle
;Oval width

954

16

;Oval depth

955

16

;Oval
rotation

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site EW coord
of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U880
u880.eqp
u880.uf
u880.tdf
U880.fb

Plant Design System (PDS) Equipment Eden Interface

211

Appendix: Delivered Parametrics

Rectangular 90 Cone Torus with Offset (U881)

U881 Notes Specific to Form U881, Rectangular to Rectangular Torus

This form is used to define a rectangular torus, with or without an offset.


It is placed by a point in the middle of the first face. The active primary axis is the normal of the
starting face. The active secondary axis points to the center of rotation.
Characteristics of the parameters that apply to this form are as follows:
Form
Gadget
Label

TDF No

TDF
Name

Field
Length

Field
Type

Var No /
Att No

Nozzle
Seq No

Exit
Code

Default
Value

T2210
Att No

Explanatory
Remarks

951

16

' '

;Bend radius

952

16

;Rect width1

953
954

3
4

C
D

16
16

1
1

3
4

0
0

2
2

;Rect depth1
;Rect width2

955

16

;Rect depth2

956

16

957
958

7
8

G
H

16
16

1
1

7
8

0
0

2
2

0
0

;Rect
offfset1
;Rect offset2
;Rect offset3

202

202

16

203

203

16

204

204

EL

16

208

208

ANG

16

;Site <EW
coord of PP
;Site NS coord
of PP
;Site elev of
PP
;Ang site N
equip N

Following is a list of form elements and their associated files:


U881
u881.eqp

212

Plant Design System (PDS) Equipment Eden Interface

Appendix: Delivered Parametrics


u881.uf
u881.tdf
U881.fb

User Projected Shape (USRPRJ)

Plant Design System (PDS) Equipment Eden Interface

213

Index

Call Statement 35
Call Tutorial (C) 113
Circular Platform (A001) 141
Comments 33
Common Keywords 31
Compiling New Modules 100
Complex Horizontal Cylindrical Equipment
(E240) 170
Complex Horizontal Cylindrical Equipment
(N240) 198
Complex Vertical Cylindrical Equipment
(N205) 196
Complex Vertical Cylindrical Equipment,
Skirt (E205) 163
Concurrent Display 112
Convert NPD to Subunits 40
Convert Unit 48
Creating a New Equipment Component 97

Define Active Orientation 40


Define Active Point 49
Define Datum Point 49
Define Library 50
Define Nozzle 51
Define Orientation By Points 52
Define Placepoint 53
Define Point 54
Define Weights (E201) 161
Defining Symbols 107
Deposit Global (DG) 114
Deposit Local (DL) 114
DESCRIPTION Statement 32
Display Message 55
Display Tutorial 55
Do While Statement 36
Double Pipe Exchanger (E320) 181
Double Pipe Exchanger (N320) 201
Draw Arc 57
Draw Complex Surface 58
Draw Con Prism 60
Draw Cone 41
Draw Curve 61
Draw Cylinder 42
Draw Ecc Prism 61
Draw Ecc Transitional Element 62
Draw Eccentric Cone 43
Draw Ellipse 63
Draw Line 64
Draw Line String 64
Draw Proj Hexagon 65
Draw Proj Octagon 66
Draw Proj Shape 67
Draw Projected Rectangle 44
Draw Projected Triangle 45
Draw Rectangular Torus 68
Draw Revolved Shape 69
Draw Semi-Ellipsoid 46
Draw Shape 70
Draw Sphere 47
Draw Torus 47
Draw Transitional Element 71

Davit A (A061) 157


Davit B (A063) 159
Debugger Commands 112
Default Project Control Data 98
Define (E200) 160

E1 Ends (E905) 193


E2 Ends (E906) 194
E3 Ends (E907) 195
Eden Debugger 111
Eden Language Structure 23

A
Abort 48
Additional Features of the Form Interface
104
Air Cooler (E330) 185
Air Cooler (N330) 202
Appendix
Codelist (CL330) 119
Delivered Parametrics 139
EQP Eden Program Examples 129
Equipment Data Definition 125
Application Commands 103
Arithmetic Operators 33

B
Basic Use of Forms 101
Begin 24
Begin EQP Category 25
Beginning Statements 23

Plant Design System (PDS) Equipment Eden Interface

215

Index
Editing Modules 100
Ending Statements 24
Equipment Group Database Table 126
Equipment Nozzle Database Table 126
Equipment Symbol Processor 13
Examine Global Variables (EG) 115
Examine Local Variables (EL) 114
Examine Source File Segments (TYPE)
116
Examine Symbol Name (ES) 116
Example 1 (Use of loops) 129
Example 10 (Insulation Graphics) 137
Example 2 (Use of arrays and loops) 130
Example 3 (Placing nozzles) 130
Example 4 (Use of character string
variables) 131
Example 5 (Graphic selection commands)
131
Example 6 132
Example 7 132
Example 8 133
Example 9 133
Exchanger Ends (E319) 180
Exiting the Debugger 111
Expressions 34
Extracting Sample Modules 99

Flat Oval Prism (U870) 209


Flat Oval Torus (U880) 210
Flat Oval Torus Miter (U863) 208
Forced Draft Air Cooler Bay (E334) 188
Forms Interface 22
Functions 37

Local Variables 27
Logical Operators 34

G
Gear Cover (U850) 203
Get Arc Points 71
Get Arc Size 72
Get Date 73
Get EQP Category 73
Get Line Size 74
Get Point 74
Global Variables (EQP Specific) 30
Global Variables Common to Equipment and
Pipe Support Modeling 29
Global Variables Common to Piping,
Equipment, and Pipe Support Modeling
28

216

Handrail A (A051) 156


Holes for Miscellaneous Platforms (A016)
147
Holes for Platforms (A015) 145
Horizontal Rotating Equipment and Driver
(E405) 189
Horizontal Rotating Equipment and Driver
(N405) 202
Horizontal Shell and Tube Exchanger
(E305) 174
Horizontal Shell and Tube Exchanger
(N305) 199

I
If - then - else Statement 37
Indexed Do Statement 36
Induced Draft Air Cooler Bay (E332) 186
Input Fields 102
Invoking the Debugger 111

K
Kettle Exchanger (E307) 176
Kettle Exchanger (N307) 200

M
Miscellaneous Platform (A003) 143
Move Along Arc 76
Move Along Axis 77
Move Along Line 77
Move By Distance 78
Move Data 79
Move To Placepoint 79
Move to Specific Source Line or Continue
(Go) 117

O
Operators 33

P
Place COG 80
Plate Exchanger (E325) 183
Plate Exchanger (N325) 201
Position Cursor 81
Preface PDS 9

Plant Design System (PDS) Equipment Eden Interface

Index
Primitives 38
Put Field 81

R
Read Table 82
Rectangular 90 Cone Torus with Offset
(U881) 212
Rectangular Torus Miter (U861) 206
Relational Operators 34
Replacement Statements 35
Retrieve Nozzle Parameters 83
Revising Modules 101
Rotate Orientation 84
Round Torus Miter (U860) 204

S
Set Line Break (B) 113
Setup for Equipment 97
Side Ladder A (A031) 152
Side Ladder Details (A039) 153
Simple Horizontal Cylindrical Equipment
(E245) 172
Simple Horizontal Cylindrical Equipment
(N245) 199
Simple Vertical Cylindrical Equipment
(N210) 197
Simple Vertical Cylindrical Equipment
(N215) 197
Simple Vertical Cylindrical Equipment, Legs
(E215) 167
Simple Vertical Cylindrical Equipment, Skirt
(E210) 165
Spherical Equipment (E230) 169
Spherical Equipment (N230) 198
Stairs A (A041) 154
Start Complex Shape 84
Step into User Function (SI) 117
Step through Source Code (S) 117
Stop Complex Shape 85
Store Nozzle Parameters 86
Store Orientation 86
Subscripted Global Variables 30
Switch Modes (ON and OF) 112
Switch the Prompt Terminal (P) 118
System-Defined Application Commands
103
System-Defined Field Numbers 102

Thru Ladder Details (A029) 150


Tutorial Definition Table 17
TYPE Statement 32

U
User Function 87
User Function FLAT_OVAL_PRISM 88
User Function FLAT_OVAL_SEG_TOR1
90
User Function FLAT_OVAL_SEG_TOR2
91
User Function FLAT_OVAL_TOR 89
User Function RECT_FLAT_OVAL 95
User Function RECT_SEG_TOR 94
User Function ROUND_RECT 96
User Function ROUND_SEG_TOR1 92
User Function ROUND_SEG_TOR2 93
User Projected Shape (USRPRJ) 213
User-Defined Application Commands 103

V
Variables 26
Vertical Oval Torus Miter (U862) 207
Vertical Rotating Equipment and Driver
(E410) 191
Vertical Rotating Equipment and Driver
(N410) 203
Vertical Shell and Tube Exchanger (E310)
178
Vertical Shell and Tube Exchanger (N310)
200

W
What's New in Equipment Eden Interface
11

T
The Eden Basics 13
Thru Ladder A (A021) 149

Plant Design System (PDS) Equipment Eden Interface

217

You might also like