Atributos y Pseudo Atributos

321
pdms1160/Software Customisation Reference Manual Issue 090904 VANTAGE Plant Design PDMS Software Customisation Reference Manual Version 11.6

Transcript of Atributos y Pseudo Atributos

pdms1160/Software Customisation Reference Manual Issue 090904

����

VANTAGE Plant Design

PDMS Software Customisation Reference Manual

Version 11.6

AVEVA Solutions Limited, High Cross, Madingley Road , Cambridge, CB3 0HB, UK.

������������������� ���� ���� ���

�������������������������������������������������

�������� �������������� ������������������������� �� ���������!�������� ����������������������� �� ��������"�����������#�����������$�

���������%�&����'�(������)�**���+��,���+�(&�-�)&�.�*�/�*-�����.&��-�0%'���!�&�0�%-&�/�1%�������&'&��-���!��.��&'��&�-�)�**���&����,�'�*0.����1&�&�+���-�,&������,�*�����*�&0%��*��%*����$�

)�� ����������������� ������������������������������������ �!��������� ��������� ������ ��� ������������������������������!�������!������ !������� �������2���� ��� �������������#���������������!������ ����������������� ����� $�

����� ��� ������������� ������� ��������������������#��������� �������������������#����� �������� �����������$�,�������������� �������#����������������� ������������� ��������������� ������������$�

�0���������3443���������5667��������� �������� ����0���������3443���������5667��������� �������� ����0���������3443���������5667��������� �������� ����0���������3443���������5667��������� �������� �������

� �������������$��������������������� �� �������������!����������������� ����� �������� ����!��������� ���������� ��!� ������!� ������ !������������!����������������#��!�#�������������#������� ����������������� �����$�

�������#��������� ��������������������� ������������� ����� ��������������������������������������� ������������� ������$�

,������� ����������8��#�� �#����� �������������������!�������#�������������99###$����$�� $��

������������������� ���� ���� ���

Revision History

PDMS Software Customisation Reference Manual revisi on history - i

Revision History

Date Version Notes

���� �566:� 33$;� -������������� �� ���������������������� ���� �������

���� �5667� 33$<�-�����

-�����������������-'��33$<$�

'���5667� 33$<�-�����

%�����������-'��33$<$�

=��5667� 33$<3�-�����

%�����������-'��33$<!�� ����� � ������ ������������� �$�

�������5667� 33$<�-�����

0������� �#������#�������� ����� ��� $�

�������5667� 33$<�

-�����

0���������������������%���� ���"��$�

Revision History

revision history - ii PDMS Software Customisation R eference Manual

������������������� ���� ���� ���

Contents

PDMS Software Customisation Reference Manual contents - i

Contents

Contents........................................... .......................................................... i

1 Introduction ....................................... ............................................1-1

2 A Summary of Objects, Members and Methods.......... ...............2-1

2.1 Object Classification ................................................................................2-1 2.2 Methods Available to All Objects..............................................................2-3 2.3 Forms and Menus Objects.......................................................................2-4

2.3.1 Members Contained by All Gadgets.......................................................2-4 2.3.2 Summary of Gadget-Specific Methods...................................................2-5

2.4 Gadget Syntax Graphs ............................................................................2-7 2.4.1 Rules for Presenting and Using Syntax graphs......................................2-7 2.4.2 Setting Up Gadget Anchoring: <fganch>................................................2-8 2.4.3 Setting Up Gadget Docking: <fgdock> ...................................................2-8 2.4.4 Setting-Up the Gadget’s Position: <fgpos> and <fgrel> .........................2-9 2.4.5 Setting Up the Gadget’s Width and Height: <vshap>...........................2-10 2.4.6 Setting Up the Gadget’s 2D Screen Position: <xypos> ........................2-11

ALERT Object Forms and Menus................................................................2-12 ARC Object 3D Geometry ...........................................................................2-13 ARRAY Object PML Built-in Type.............................................................2-22 BANNER Object PDMS ..............................................................................2-26 BAR Object Forms and Menus....................................................................2-27 BLOCK Object PML Built-in Type.............................................................2-29 BOOLEAN Object PML Built-in Type ..........................................................2-30 BORE Object PDMS ..................................................................................2-31 BUTTON Object Forms and Menus ............................................................2-33 COLLECTION Object Collection and Report................................................2-35 COLUMN Object Collection and Report.......................................................2-37 COLUMNFORMAT Object Collection and Report ........................................2-38 DATEFORMAT Object Collection and Report ..............................................2-39 DATETIME Object PML Built-in Type ..........................................................2-41 DB Object PDMS ......................................................................................2-43 DBSESS Object PDMS ..............................................................................2-45 DIRECTION Object PDMS...........................................................................2-46 EXPRESSION Object Collection and Report ...............................................2-48 FILE Object PML Built-in Type ....................................................................2-49 FMSYS Object All.....................................................................................2-51 FORM Object Forms and Menus................................................................2-52 FORMAT Object Formatting........................................................................2-57 FRAME Object Forms and Menus ............................................................2-59 LINE Object 3D Geometry ...........................................................................2-61 LINEARGRID Object Construction Aids.......................................................2-68 LIST Object Forms and Menus....................................................................2-72 LOCATION Object PDMS Global.................................................................2-77 MACRO Object PDMS ..............................................................................2-79 MDB Object PDMS ......................................................................................2-80 MENU Object Forms and Menus................................................................2-82 OBJECT All ................................................................................................2-89

Contents

contents - ii PDMS Software Customisation Reference Manual

OPTION Object Forms and Menus ............................................................2-90 ORIENTATION Object PDMS......................................................................2-92 PARAGRAPH Object Forms and Menus......................................................2-93 PLANE Object 3D Geometry....................................................................2-95 PLANTGRID Object Construction Aids ........................................................2-99 POINTVECTOR Object 3D Geometry........................................................2-100 POSITION Object PDMS ...........................................................................2-103 POSTEVENTS Object PDMS ....................................................................2-107 PROJECT Object PDMS............................................................................2-108 PROFILE Object 3D Geometry..................................................................2-110 RADIALGRID Object Construction Aids .....................................................2-120 REAL Object PML Built-in Type...............................................................2-122 REPORT Object Collection and Report.....................................................2-124 RGROUP Object Forms and Menus ..........................................................2-127 SELECTOR Object Forms and Menus.......................................................2-129 SESSION Object PDMS ............................................................................2-131 STRING Object PML Built-in Type...........................................................2-133 TABLE Object Collection and Report ........................................................2-137 TEAM Object PDMS ................................................................................2-139 TEXT Object Forms and Menus..............................................................2-140 TEXTPANE Object Forms and Menus .......................................................2-143 TOGGLE Object Forms and Menus ..........................................................2-145 UNDOABLE Object PDMS.........................................................................2-147 USER Object PDMS ................................................................................2-148 VIEW Objects: AREA View Forms and Menus...........................................2-150 VIEW Object: PLOT View Forms and Menus.............................................2-152 VIEW Objects: VOLUME Views Forms and Menus....................................2-154 VIEW Object: ALPHA Views Forms and Menus.........................................2-157 XYPosition Object 3D Geometry................................................................2-158 2.5 Deprecated Gadgets............................................................................2-159

Appendix A. Communicating with PEGS ............................ ................1

A.1. Directing Commands to PEGS ................................................................... 1 A.2. Setting Connections Between FMLayer and PEGS .................................... 1 A.3. Sending Commands to PEGS .................................................................... 2 A.4. Some Special FMLayer Commands............................................................ 5 A.5. Handling Errors Returned from PEGS ........................................................ 5

Appendix B. Communicating with REVIEW .......................... ..............1

B.1. Invoking the Command Line Interface ........................................................ 1 B.2. Directing Commands to REVIEW ............................................................... 1 B.3. Sending Commands to REVIEW ................................................................ 2 B.4. Errors from the Application-to-REVIEW Link .............................................. 3 B.5. Sample Application ..................................................................................... 3 B.6. Progress Monitoring.................................................................................... 4

B.6.1. Engineering Data .......................................................................................4 B.7. Using the Sample Application ..................................................................... 5

B.7.1. Progress Monitoring...................................................................................6 B.7.2. Engineering Data .......................................................................................7 B.7.3. Maintenance ..............................................................................................8

B.8. A Summary of the Application Data .......................................................... 12 B.8.1. Progress Monitoring.................................................................................12 B.8.2. Engineering Data .....................................................................................12 B.8.3. Maintenance ............................................................................................12

Contents

PDMS Software Customisation Reference Manual conten ts - iii

B.9. The Application Files Supplied.................................................................. 14 B.9.1. The ADMIN Directory .............................................................................. 15 B.9.2. The ENGDATA Directory......................................................................... 15 B.9.3. The PROGRESS Directory...................................................................... 15 B.9.4. The MAINTAIN Directory......................................................................... 16 B.9.5. The DATA Directory ................................................................................ 16

Appendix C. PML 1 Expressions .................................. ....................... 1

C.1. Format of Expressions................................................................................ 2 C.1.1. Operator Precedence ................................................................................ 2 C.1.2. Nesting Expressions.................................................................................. 3

C.2. Logical Expressions.................................................................................... 3 C.2.1. Logical Operators ...................................................................................... 3 C.2.2. Logical Functions....................................................................................... 6 C.2.3. Logical Array Expressions ....................................................................... 10

C.3. Numeric (Real) Expressions ..................................................................... 10 C.3.1. Numeric (Real) Operators ....................................................................... 11 C.3.2. ADD and SUBTRACT (+ and -)" ............................................................. 11 C.3.3. MULTIPLY and DIVIDE (* and /) ............................................................. 11 C.3.4. Numeric (Real) Functions........................................................................ 12 C.3.5. Real Arrays.............................................................................................. 20

C.4. Using IDs in Expressions.......................................................................... 20 C.5. Positions, Directions and Orientations in Expressions (PDMS only) ......... 21

C.5.1. Using Positions in Expressions ............................................................... 21 C.5.2. WRT (PDMS Only) .................................................................................. 22 C.5.3. FROM...................................................................................................... 24 C.5.4. Comparing Positions ............................................................................... 27 C.5.5. POLAR .................................................................................................... 28 C.5.6. Direction .................................................................................................. 28 C.5.7. Orientations ............................................................................................. 29

C.6. Text Expressions ...................................................................................... 30 C.6.1. Text Operator .......................................................................................... 30 C.6.2. Text Functions......................................................................................... 30

C.7. Late Evaluation of Variables in expressions.............................................. 39 C.8. PDMS Attributes in Expressions ............................................................... 39 C.9. Querying Expressions............................................................................... 39 C.10. Units in Expressions ................................................................................. 39 C.11. Precision of Comparisons......................................................................... 41 C.12. Undefined Values ..................................................................................... 41 C.13. Unset Values ............................................................................................ 42

Appendix D. PDMS Attributes and Pseudo-Attributes.............. ......... 1

D.1. Attributes .................................................................................................... 1 D.2. Pseudo-Attributes ..................................................................................... 49

D.2.1. Pseudo-Attribute Syntax.......................................................................... 49 D.2.2. Grouping of Pseudo-Attributes ................................................................ 49 D.2.3. All elements on All DBs ........................................................................... 50 D.2.4. Draft Database ........................................................................................ 75 D.2.5. Catalogue DB .......................................................................................... 76 D.2.6. Spooling DB............................................................................................. 76 D.2.7. System DB............................................................................................... 77 D.2.8. Full List of Attributes on TUBI.................................................................. 79

Contents

contents - iv PDMS Software Customisation Reference Manual

������������������� ���� ���� ���

Introduction

PDMS Software Customisation Reference Manual 1-1

1 Introduction

����� ��� �������*����'��� �������������������� ���������!��'�$��

&�������������������#������� ������� � ����#�����'�$�%����#���������������������'������ �������������-'������#���0���� �������/���!�#��������� ���������������#��������� ��� $�

��������#�������������'�!����� ����!���#�����'��3!�������#���!���#�����'��5$��'��5�������#������������� ��������������������� ��������������/%&!��������� ��� ���� �� ��������#�����'��5$�

.�#��!��'��5���������� � � ���� �����'��3!������������� �������#������������������� ��������� ��������'��3����� ����$�&�������� ��!������ ��� �������������'��3�>��������������!�#������������#������-'�?�����>� � !�����#�������� ������������������ � ���$�

&������������ ���������������'��3!�����>� � ����������� ��������� �����!�����#� �����������������������������������-'������#���0���� �������/���$���� �����������������'��3��� ��#���������������344;$�

����� ��� ���������

• �� ��������'��5���"���!�' �������'�����$�,������,�� �����'�����"���!������ �������>�� �������������"��������� ���$�

Note: '���������������,�� �����/�����������#��������� ������������ �������� ���#��������������,�� ����/����� �����$�&���� !����� ���� ��������������������#���������������� ������� �����$�&��������� ��������� �����!����� ����������������������������������������#���0���� �������/����������������344;!�#����������������� ������>������� $$�

• &��� �����������������'������/�$�

• &��� �����������������'����*��&�)$�

• �������������������'��3�>��������������$�

• ����������-'��������������������@���������!�#�������������������$�

Introduction

1-2 PDMS Software Customisation Reference Manual

������������������� ���� ���� ���

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-1

2 A Summary of Objects, Members and Methods

2.1 Object Classification

������ �� �#� ����������"��������������#��#������ ������������������ �����$�

Classification Object Type

ARRAY

BLOCK

BOOLEAN

PML

STRING

DATETIME

PML Built-in Objects

ARC

LINE

LINEARGRID

PLANE

PLANTGRID

POINTVECTOR

PROFILE

RADIAL GRID

XYPOSITION

3D Geometry Objects

BANNER

BORE

DB

DBREF

DBSESS

DIRECTION

MACRO

MDB

ORIENTATION

POSITION

POSTUNDO

PROJECT

PDMS Objects

SESSION

A Summary of Objects, Members and Methods

2-2 PDMS Software Customisation Reference Manual

Classification Object Type

TEAM

UNDOABLE

USER

ALERT

ALPHA

BAR

BUTTON

FMSYS

FORM

FRAME

LIST

MENU

OPTION

PARAGRAPH

RGROUP

SELECTOR

TEXT

TEXTPANE

TOGGLE

VIEW ALPHA

AREA

PLOT

VOLUME

Forms and Menu Objects

COLLECTION

COLUMN

COLUMN-FORMAT

DATE-FORMAT

EXPRESSION

REPORT

TABLE

Collection and Report Objects

Formatting Text FORMAT

Table 2-1: Object Types and Classification

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-3

2.2 Methods Available to All Objects

������ ��� �#��� �������� ���������� �� ����� ���"���$������� ���������� �������� ��������������������� ����������������� ���$��

����������� � ���������� ���������#������� ��������$�

Name Result Purpose

Attribute( 'Name') ANY �������������� ����������"��!������������� ���� ������STRING$�

Attributes() ARRAY OF STRINGS

�������� ����������� �������� �����������"�����������������STRING$�

Delete() NO RESULT -�����������"���@� ������������

EQ(any) BOOLEAN ���@������� �������

LT(any) BOOLEAN ���@������� �������A�����������������STRING����� � ����� �B�

Max(any) ANY *���� �>� � ������"�������������"���

Min(any) ANY *���� �� � ������"�������������"���

NEQ(any) BOOLEAN TRUE������"������������������� ��� �A�B�

ObjectType() STRING *�������������������"��������������

Set() BOOLEAN TRUE���������"����������������� �A�B�

String() STRING 0����������"��������STRING�

Unset() BOOLEAN TRUE���������"������������������ ��

Table 2-2: Methods Available to All Objects

A Summary of Objects, Members and Methods

2-4 PDMS Software Customisation Reference Manual

2.3 Forms and Menus Objects

2.3.1 Members Contained by All Gadgets

� ������������������� �#��� ���$��

Name Type Purpose

visible BOOLEAN

/�9���

+���2��������� ��������� ��������������������� ���������� $�

��� ���������������� !����������TRUE?���� ������������������ !����������FALSE$�

active BOOLEAN

/�9���

+���2��������� ��������� ��������������������������������A����@���B$�

��� ����������������!����������TRUE?���� ������������������!����������FALSE$�

callback STRING

/�9���

C���������������������D���� �����������

tag STRING

/�9���

C��������������������D�������>�$���������������� ��������� �������$�

Table 2-3: Members Contained by All Gadgets

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-5

2.3.2 Summary of Gadget-Specific Methods

������ �� �#��� ��������� ��������������������������������$��

Bar

But

ton

List

Opt

ion

Par

a

Rgr

oup

Tex

t

Tex

t-pa

ne

Tog

gle

Vie

w A

lpha

Vie

w 2

D

Vie

w 3

D

Add X X X X

AddPixmap X X X

Background E� E�

Clear E� E� E� E� E�

ClearSelection E�

CurPos E�

Highlight E� E�

InsertAfter E�

InsertBefore E�

FieldProperty E�

FullName E� E� E� E� E� E� E� E� E� E� E� E�

GetPickedPopup E� E� E� E� E� E� E� E� E� E� E�

Line E�

Name E� E� E� E� E� E� E� E� E� E� E� E�

Owner E� E� E� E� E� E� E� E� E� E� E� E�

Refresh E� E� E� E� E� E� E� E� E� E� E� E�

RemovePopup E� E� E� E� E� � E� E� E� E� E�

RestoreView E� E�

SaveView E� E�

Select E� E� E�

Selection E� E� E�

SetActive E� �

SetCurPos E�

SetEditable E� E�

SetFieldProperty E�

SetFocus E� E� E� E� E� E� E� E� E�

SetLine E�

SetPopup E� E� E� E� E� � E� E� E� E� E�

SetSize E� E� E�

SetTooltip E� E� E� � E� E� � E�

SetValue E�

A Summary of Objects, Members and Methods

2-6 PDMS Software Customisation Reference Manual

Bar

But

ton

List

Opt

ion

Par

a

Rgr

oup

Tex

t

Tex

t-pa

ne

Tog

gle

Vie

w A

lpha

Vie

w 2

D

Vie

w 3

D

Shown E� E� E� E� E� E� E� E E� E� E� E�

Type E� E� E� E� E� E� E� E� E� E� E� E�

ValidateCall E�

Table 2-4: Summary of Gadget-Specific Methods.

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-7

2.4 Gadget Syntax Graphs

2.4.1 Rules for Presenting and Using Syntax graphs

����� ����������>���������������� �#����

�$ ���������������������� ���A��������������� ��B�����-'���������� ����������������#����������������$��������������������Fgraph_name>-- F����F>-- G!����>��������F--> G$����� �#��� �#�������������������������� !���� �����������!�>����#���������������#��������F* F����F<F��� �� $�

��$ ������ � ���#��������� ���F+F��� �� ����������#�����$��������� #��������������##����$��������� �������F+G���������� �#�� ��������������������$����F+G��� �� ������ ��������������� � �����������$�

���$ .���H��� ���������������������� ��!��������� ���#�������������#��������� �#�� ����������$��������� ��������������� � �����������$�

�B )�������������#���������� ���������� ���#����$���������� �H����������������� �� � �����>�#�������������H�$���#���������������������� ����������$����#�� �������������� �������������������������������������$��

�B )������ ������F<�>F����������� �������� �������$��������� ���� �#�����$�/������� ��������������$�

�B )������� �#������� �!�������I����� �D���� ���������� �!�$�$��>�!�����!��� �A� ������ �B$��� �� ������������������������ �!�$�$�Ifname’ ����Igname’ $��� �� ��������������������$�$�Itagtext’ !����� ���� ��� �����"����F�>�G���������������������������������!����!��Jfgtag K$�

��$ 0�������������� ��������H��� � ���#���������F�+�F��� �� �������� �#� ��������������$�

�B �������������F* F��� �� ����������� � ������������������� �#�������������������������#����$��

�B �������������F<F��� �� ���������H��� ������������������ �#���������������������������#����$��

�B ����� �� ��F$F, �F/ F, �F�‘ �F����"������� �������� �������������� ��������$�

A Summary of Objects, Members and Methods

2-8 PDMS Software Customisation Reference Manual

2.4.2 Setting Up Gadget Anchoring: <fganch>

���ANCHOR����������� �#�������������� ��������������������������������� ��������������������������������������$�

,���>� � �ANCHOR RIGHT������������������������������������������#� � ����������>������������ �������������������������#���������$�

.---<---- ---------. / | >-- <fganch> -----------+-- ANCHOR --+--+- Left --- -. | | +- Right –- -| | | +- Top ---- -| | | ‘- Bottom – -+---+---* | | +---- None --- -| ‘---- All----- -’-->

Syntax Graph 2-1: Gadget Anchoring

2.4.3 Setting Up Gadget Docking: <fgdock>

���DOCK����������� �#���������������������������� ��!������!����!��������� �����������������!������� ������� ��������� ?������������������������������������� ����!������������$�

>-- <fgdock> -----------+-- DOCK ----+-----Left --- -. +---- Right –- -| +---- Top ---- -| +---- Bottom – -| +---- None --– -| ‘---- Fill --– -’-->

Syntax Graph 2-2 Gadget Docking

Note: ���DOCK����ANCHOR�������������� ���� ��>� ����$�

���������DOCK������������������ANCHOR����������� �?����������ANCHOR���������������DOCK�����$�

+������������������������ ��#���������������������������������������������>������ ���� �����$����������������� �#�����������H���������������@�� $�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-9

2.4.4 Setting-Up the Gadget’s Position: <fgpos> and <fgrel>

+������������AT�����>!����#�� �#������J�����K������!�����������������������������D��������#���������� $�

+���������������������������� �� ��A����� � ���������������B����� �����������>�� ��������>������������!����� �������������H���������� ������������$�

>-- <fgpos> - AT --+-- val -- val ----------------- --------------------------. +-- X val ---------------------- --------------------------| +-- XMIN -. | +-- XCEN -| | +-- XMAX -+- <fgrel> -----. | ‘---------‘---------------+-- Y val ----------------------| +-- YM IN -. | +-- YC EN -| | +-- YM AX -+- <fgrel> ----. | `----- -------------------‘------‘-->

Syntax Graph 2-3 Absolute Positioning

������������J��� K!����#�� �#!����������������������� ����������������������������� D��>��$�,���>� � !����������������������������������� �#�������������#������������� $�

>-- <fgrel>---+- <gname> -. +-- FORM ---| ‘-----------+- * val --. +- + val --| +- - val --| +- val ----+--- + val * S IZE --. | +-- - val * SI ZE ---| | +-- - SIZE --- ------| | `------------- ------| +-- SIZE ---------------- ------| `------------------------ ------‘--->

Syntax Graph 2-4: Relative Positioning

A Summary of Objects, Members and Methods

2-10 PDMS Software Customisation Reference Manual

Examples of Using the AT Syntax

AT 5 7.5 ����������������������� ����������������A;!�L$;B$�

AT X 5.5 ����������������������� ����������������A;$;!��B�#���������� �� �������� ����� ����� ������>�� ���������� ����� ����������������������VDISTANCE������$�

AT YMAX+1 ���������#����������A>!��B�#���>������ �� �������� ����� ����� ����>�>�� ���������� ����� ����������������������HDISTANCE������$����������YMAXM3������� ���������$�

AT XMIN.GAD1-2 YMAX.GAD2+1 ���������#�������#��������������#��>������������$�/�����������������5����������������� ������GAD1(X=XMIN-2)����3������ �#�$GAD2 (Y=YMAX+1).�

AT XMAX FORM-SIZE YMAX FORM-SIZE XMAX�FORM������������������������������H���������� ������������������������������A���������� � �>� � �>��B$�YMAX FORM��������������� D������������� �>��$����@SIZE����������������������H���������������������������������� $������>� � �������������������������>�� ������@��������� ������������� $�

2.4.5 Setting Up the Gadget’s Width and Height: <vs hap>

�������������� �#�������������������D��#���������������

<vshap>--+- WIDth val –+- HEIght –. | +- LENgth -| | +- LINes –-‘- val -. | +- ASPect –- h/w --| | ‘------------------‘--- > +- HEIght -. +- LENgth -| ‘- LINes --‘- val -+- WIDth val --. +- ASPect h/w -| ‘--------------‘-- >

Syntax Graph 2-5: Gadget Geometry

Note: �9#��������� ��������������*�����A�����9#����B$�

������������J�����K�#� �����������������> �����,N'����������!����������� �$�

������� ��#������������������J�����K�#� �����������!���� ��������������#����� ��#�������������������� ��� ����������� ��$�

� ��� ��� ���������������������� �$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-11

2.4.6 Setting Up the Gadget’s 2D Screen Position: < xypos>

��������#����#�����������������D��5-����������������� � �H����@�������$�

<xypos>--+- XR val -+- YR val -. ‘- YR val -+- XR val –‘-->

Syntax Graph 2-6 Gadget's 2d Screen Position

Note: ��� � �H����@���������������������������������� �������H$�

6$6�JO�E*�JO�3$6����6$6�JO�+*�JO�3$6$�

A Summary of Objects, Members and Methods

2-12 PDMS Software Customisation Reference Manual

ALERT Object Forms and Menus

Methods

Name Result Purpose

Confirm( Message is STRING, X is REAL, Y is REAL )

STRING ‘YES’ OR ‘NO’

���#���� ������CONFIRM�ALERT������������������$�X����Y���������� �������������$�

Error(Message is STRING, X is REAL, Y is REAL )

STRING ‘YES’

���#���� ������ERROR�ALERT������������������$�X����Y���������� �������������$�

Message(Message is STRING, X is REAL, Y is REAL)

STRING ‘YES’

���#���� ������MESSAGE�ALERT������������������������������������$�X����Y���������� �������������$�

Question(Message is STRING, X is REAL, Y is REAL )

STRING ‘YES’, ‘NO’ OR ‘CANCEL’

���#���� ������QUESTION�ALERT������������������$�X����Y���������� �������������$�

Warning(Message is STRING, X is REAL, Y is REAL)

STRING ‘YES’

���#���� ������WARNING�ALERT������������������������������������$�X����Y���������� �������������$�

!!Alert.Input( ! prompt is STRING, !default is STRING) is STRING

STRING ���#���� ������INPUT�ALERT$�Pprompt���������� ������� �������������!����Pdefault����������� ���� ��������>����>$�

!!Alert.Input( !prompt is STRING, !default is STRING, xPos is REAL, yPos is REAL) is STRING

STRING ���#���� ������INPUT�ALERT$�Pprompt���������� ������� �������������!����Pdefault����������� ���� ��������>����>$�xPos����yPos��������������������������� ��@���������������� �����>$�

Table 2-5: Alert Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-13

ARC Object 3D Geometry

Basic ARC Definition: Members

Name Type Purpose

Orientation ORIENTATION

/�9���

������������������$�

Position POSITION

/�9���

�����90������������$�

Radius REAL

/�9���

*����������������

StartAngle REAL

/�9���

�� ���� �E��>��������������������$�

EndAngle REAL

/�9���

�� ���� �E��>����������������$�

Sense BOOLEAN

/�9���

��������

• 6������ ���#���

• 3��������@� ���#���

Table 2-6: Basic ARC Definition Members

Basic ARC Definition: Methods

���� ������������ ��������������� ���"��$�

Name Result Purpose

Arc( POSITION, ORIENTATION, REAL, REAL, REAL,BOOLEAN)

ARC 0�����������#������������������!���������!��������� !������ !�*�����$�&����� �������� �����TRUE!������������ ���#��$��

String() STRING *�����������������������

Table 2-7: Basic ARC Definition Methods

A Summary of Objects, Members and Methods

2-14 PDMS Software Customisation Reference Manual

ARC Methods that Return ARCs

���������� ������ ���������������� ���"��$�

Name Result Purpose

StartPosition(POSITION) ARC *�������#����!����������������� !�#�������������� !����������������� ���� ������������������������������������������� ����������������� �!���� �����E��>��$�

EndPosition(POSITION) ARC ���StartPosition!������������EndAngle.�

Through(POSITION) ARC *�������#����!�#�������������A�������� ����� B��������������������������������#�� ����������������� �$�

ChordHeight(REAL) ARC *�������#����!����������������� !�#������EndAngle���������������������������������������������������$�

• 0�����������K�*���������0�����������J�6������������"���$�

• �#��������� ��������������������� �K�3Q6$�

Chord(REAL) ARC *�������#����!� ����������������� �StartAngle!�������EndAngle���������������������������� ����������

• 0����� ����K�*������R�5����J�6��������������"��$�

Circle() ARC *��������� ����� ������������������$�

Circle(BOOLEAN) ARC *��������� ����� ������������������$�&�����!��������������@� ���@#���

Complement() ARC *���������� � ���������������������������A���� ��������������� B�

Table 2-8: ARC Methods that Return ARCs

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-15

StartPosition(POSITION)

EndPosition(POSITION)

Through(POSITION)

Complement()

Cord(REAL)

CordHeight(REAL)

�Figure 2-A: ARCs Returned by ARC Methods

ARC Method that Returns POSITIONs

����� ������������ ��������������� ���"��$�

Name Result Purpose

AnglePosition(REAL) POSITION *�������������������������������� ���������$�

Table 2-9: ARC Methods that Return POSITIONs

AnglePosition(REAL)

Figure 2-B: POSITIONs Returned by ARC Methods

A Summary of Objects, Members and Methods

2-16 PDMS Software Customisation Reference Manual

ARC Methods that Return DIRECTIONs

���������� ������ ���������������� ���"��$�

Name Result Purpose

AngleDirection(REAL) DIRECTION *������������������� ��������������������������������������������� ���� ����E��>���

StartTangent() DIRECTION *�����������������������������!������� ��������������� � �$����F��G�����������������$�

EndTangent() DIRECTION *�����������������������������!������� ����������� � �$����F��G�����������������$�

AngleTangent(REAL) DIRECTION *���������������!������� ��������� ������$�

Table 2-10: ARC Methods that Return DIRECTIONs

AngleDirection(REAL)

StartTangent()

EndTangent()

AngleTangent(REAL)

�Figure 2-C: DIRECTIONs Returned by ARC Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-17

ARC Methods that Return XYOffsets

����� ������������ ��������������� ���"��$�

Name Result Purpose

XYOffset(POSITION) XYPOSITION *���������������!� ����������������� �!����� ������E+���������� ��������� ��������

Table 2-11: ARC Methods that Return XYOffsets

XYOffset(POSITION)

�Figure 2-D: XYOffsets Returned from ARC Methods

ARC Methods that Return REALs

���������� ������ ���������������� ���"��$�

Name Result Purpose

Proportion(REAL) REAL *���������������!����� ��������� ���� ����E��>��!�������������������� ������������ �������������� �O�A���� �@�������� B�R�J�� K�M�������� �

Angle() REAL *����������������� ������������

Near(POSITION) REAL *���������������!����� ��������� ���� ����E��>��!������������������������� �����������������������

Table 2-12: ARC Methods that Return REALs (a)

A Summary of Objects, Members and Methods

2-18 PDMS Software Customisation Reference Manual

Proportion(REAL)

Near(POSITION)

Figure 2-E: REALs Returned by ARC Methods (a)

Name Result Purpose

Chord() REAL *�������������� ������#���������������������������������

Length() REAL *������������ �������������� ��

ChordHeight() REAL *������������������������������ ��

Table 2-13: ARC Methods that Return REALs (b)

Chord()

Length()

ChordHeight()

�Figure 2-F: REALs Returned by ARC Methods (b)

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-19

ARC Intersection Methods that Return REAL ARRAYs

���������� ������ ���������������� ���"��$�

Name Result Purpose

Intersections(LINE) REAL ARRAY *����������������������!����� ������� ����� ����E��>��!������������� ��A �������������� �B�#����������� ����������������

Intersections(PLANE) REAL ARRAY *����������������������!����� ������� ����� ����E��>��!�������������� ��#����������� ����������������

Intersections(ARC) REAL ARRAY *����������������������!����� ������� ����� ����E��>��!����������� �� � �������������������#����������� ����������������

�������� ��� ��� ��� ������������� �� �!��$$������ ���#�S��� ������������������� ������6����3Q6�

Table 2-14: ARC Intersection Methods that Return RE AL ARRAYs

Intersections(LINE) Intersections(PLANE)

Intersections(ARC) �

Figure 2-G: REAL ARRAYs Returned by ARC Intersectio n Methods

A Summary of Objects, Members and Methods

2-20 PDMS Software Customisation Reference Manual

ARC Tangent Methods Returning Real Arrays

���������� ������ ���������������� ���"��$�

Name Result Purpose

Tangents(POSITION) REAL ARRAY *������������������������������������ ���� �����������������!����� ������� ����� ����E��>��!�

Tangents(ARC) REAL ARRAY *������������������������������������ ���������������������� !����� ������� ����� ����E��>���

Split() REAL ARRAY �� ������������������@H���� �������� ���

Pole() POSITION *���������� �������������������

Table 2-15: ARC Tangent Methods that Return REAL AR RAYs

Tangents(POSITION)

Tangents(ARC) �

Figure 2-H: REAL ARRAYs Returned from ARC Tangent M ethods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-21

ARC Methods that Return BOOLEANs

���������� ������ ��������������� ���"��$�

Name Result Purpose

On(POSITION) BOOLEAN *����������������������������� ������������ ��

OnProjected(POSITION) BOOLEAN *����������������������������!�#�����"��������������� �!� ���#��������

OnExended(POSITION) BOOLEAN *����������������������������!�#�� ���������������� �!� ��������������

Table 2-16: ARC Methods that Return BOOLEANs

On(POSITION) ����

On(POSITION) ����

A Summary of Objects, Members and Methods

2-22 PDMS Software Customisation Reference Manual

ARRAY Object PML Built-in Type

Methods

Name Result Purpose

Append(ANY value) NO RESULT �����value������#� ������������������$�

AppendArray(ARRAY values) NO RESULT �����array��� ������#� �������������������$�

Clear() NO RESULT * ���� � ��$�

Compress() NO RESULT * ����� ������� �������@��>�� ����� ��$�

DeleteFrom( REAL index, REAL n) ARRAY '���������n� ��������������index$�* ����� ����������@��>���

*�������������������� ��� ���A#�������������������������#���B$�

DeleteFrom( REAL index) ARRAY '��������� ������ �index��������������$��

*�������������������� ��� ��$�

* ����� �������@��>�$�

DeleteTo(REAL index, REAL n) ARRAY '���������n� ���������index�*�������������������� ��� ���* ����� �������@��>�$�

DeleteTo(REAL index) ARRAY '��������� ������ ����������index�*�������������������� ��� ���* ����� �������@��>�$�

Difference(ARRAY two) ARRAY *�������������������� �������������� �����������������������two$�-�� ������#� �������� �����

Empty() BOOLEAN TRUE������������� ����

Evaluate(BLOCK command) NEW ARRAY ��� ����������command�������� �$�

Find(ANY value) NEW ARRAY ������������ �����������value����������������������>�������������#��������#�������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-23

Name Result Purpose

FindFirst(ANY value) REAL *������>���������������������value$�*�����UNSET�����������$�

First() ANY *������ ���������������� ���

From(REAL index, REAL n) ARRAY 0�����������������n� ��������������index.�

From(REAL index) ARRAY 0�������������������������index��������������$�

GetIndexed(REAL index) ANY & � ���ARRAYTindexU�A�������������� � ����B$�

Indices() NEW ARRAY *������������������������������������������������������������� �$�

Insert(REAL index, ANY value) NO RESULT &����value������#� �����index$�

����� �������@��>��

InsertArray(REAL index, ARRAY ANY values)

NO RESULT &������ ������#� ���#����������������index.

����� �������@��>��

Intersect(ARRAY two) NEW ARRAY *������������� ���������������������$�-�� ������#� �������� ����$�

Invert() NEW ARRAY *�����������������������������$�

Last() ANY *���� ���� ���� �$�

MaxIndex() REAL ������������� ���������A�@ ���B� �$�

MinIndex() REAL ������������������������A�@ ���B� �$�

Overlay(REAL index, ARRAY two) NEW ARRAY *� ��������� ������index�#���� ������ ����������two$�*������������������� ���#�����#�����#�����A#��������������������������2����B$�

ReIndex(REAL ARRAY indices) NO RESULT ��� ����� �����SORTEDINDICES�����@����������� ���������������������������indices.�

Remove(REAL nth) ANY * ������*����nth� ��A#��������������������������2����B$�

* ����� �������@��>�$�

A Summary of Objects, Members and Methods

2-24 PDMS Software Customisation Reference Manual

Name Result Purpose

RemoveFirst() ANY * ������*���������� ��A#��������������������������2����B$�

* ����� �������@��>�$�

RemoveFrom(REAL index, REAL n) NEW ARRAY * ������*����#����������n� �����������#����index�A#��������������������������2����B$�

* ����� �������@��>�$�

RemoveFrom(REAL index) NEW ARRAY * ������*����#���������� ������ �index���������������A#��������������������������2����B$�

* ����� �������@��>�$�

RemoveLast() ANY * ������*���� ���� ��A#��������������������������2����B$�

* ����� �������@��>�$�

RemoveTo(REAL index, REAL n) NEW ARRAY * ������*����n� ������ ����������index�A#��������������������������2����B$�

* ����� �������@��>�$�

RemoveTo(REAL index) NEW ARRAY * ����������� ������ ����������index�A#��������������������������2����B$�

* ����� �������@��>�$�

Size() REAL *��������� ����������� ��$�

Sort() NO RESULT ��������������������������$�

SortUnique() NEW ARRAY *������������������������������#������� ������� ���$�

SortedIndices() NEW REAL ARRAY

*����#����������������������������������������� ����������$�

������������ �������������$�

To(REAL index, REAL n) ARRAY 0�����������������n� ������ ����������index.�

To(REAL index) ARRAY 0����������������� �������������������index.�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-25

Name Result Purpose

Union(ARRAY two) NEW ARRAY *������������� ���������������������A��� ������#� �������� ����B$�

Unique() NO RESULT -���������� ����������@��>�� ����� ��$�

Width() REAL *������� �>� � �#�������������� ���A����� ���������������B$�

Table 2-17: ARRAY Object Methods

A Summary of Objects, Members and Methods

2-26 PDMS Software Customisation Reference Manual

BANNER Object PDMS

Members

Name Type Purpose

Company STRING 0� ����� !�������356����������$�

Copyright STRING ���������������!�������Q6����������$�

Libraries ARRAY OF STRINGS

��������� ��

Name STRING ��� ����� ���#���#�!�������3:�����������

Short STRING ��������� ������ ����� �

Status STRING �-'��� ����������

Table 2-18: BANNER Object Members

Command

!BANNVAR = BANNER! $ Returns a BANNER object

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-27

BAR Object Forms and Menus

Methods

Name Result Purpose

Add(STRING dText, STRING enu) NO RESULT ����������� ���� �!�#�����������#������������ ��������� ��#� �$��

���� ��������� ��#� �����������menu?����DTEXT��������� ������������dText$�

Clear() NO RESULT * ����� ���� ���� ��$�%��������� ��������%��������� ��������%��������� ��������%��������� ������������������������������������$�

Clear(STRING dText) NO RESULT * ����� ���� ���� ������������� ���������� #����DTEXT�dText$��

%��������� ��������%��������� ��������%��������� ��������%��������� ������������������������������������$�

FieldProperty(STRING field, STRING property)

BOOLEAN /������� ����������������� ����property�������� ���� ��� ����field$�

���� �#���� ���������������������IACTIVE’����IVISIBLE’$�

FullName() STRING /������� �� ������������!�$�$8PP,�� $���8$�

InsertAfter(STRING field, STRING dText, STRING menu)

NO RESULT &�������#���� ���� ��� ���� �����������������������field$�

���� ������� �����������menu?����DTEXT�������#��� ������������dText$�

InsertBefore(STRING field, STRING dText, STRING menu)

NO RESULT &�������#���� ���� ��� ���� �����������������������field$�

���� ������� �����������menu?����DTEXT������� ������������dText$�

Name() STRING /����������8��� !��$$�8���8�

Owner() FORM /������#������ $�

SetActive( STRING dText, BOOLEAN state)

NO RESULT -�������9����������� ���� ��#����DTEXT����dText$��

%��������� ��������%��������� ��������%��������� ��������%��������� ������������������������������������$�

A Summary of Objects, Members and Methods

2-28 PDMS Software Customisation Reference Manual

Name Result Purpose

SetFieldProperty(STRING menu, STRING property, BOOLEAN state)

NO RESULT �������� ����������������� ����property�#��������� �����state!�������� ��� ����menu$�

���� �#���� ���������������������IACTIVE’����IVISIBLE’$�

Shown() BOOLEAN /�����#�������$�

Type() STRING /�����GADGET����������STRING.�

Table 2-19: BAR Object Methods

Command

���BAR��� ��������������� ��#���������� ��������$�

������ ���#����������� ���� ���������������������������8��Add()� ����$�

bar !this.bar.add ( 'Choose', 'Menu1') !this.bar.add ( ' window', 'Window' ) !this.bar.add ( 'help', 'Help' )

�����������������#������� � ��� ���D. �D!�#���������������� �� �� ��������� ������ ��� �?����I)���#D!�#���������������� �)���#� ������� ������ �������� ����#���#�$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-29

BLOCK Object PML Built-in Type

�������"����� ���>������������������ ����� ���$�

Methods

Name Result Purpose

Block( STRING expression) BLOCK 0�������� ����>������$�

Evaluate() ANY ��� ����� ����>�����������"������������ ��������TYPE����$�

Evaluate() ANY ��� �������>��������������������� ��

Evaluate(STRING type) ANY ��� ����>������������������������������� �����������TYPE�type$�����#��������������� �$�

Table 2-20: BLOCK Object Methods

A Summary of Objects, Members and Methods

2-30 PDMS Software Customisation Reference Manual

BOOLEAN Object PML Built-in Type

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

BOOLEAN(REAL value) BOOLEAN 0�������������������������� ����"������������@H����� �������� �����TRUE?�6������� �����FALSE�

BOOLEAN(STRING value) BOOLEAN 0�������������������������� ����"����������

'TRUE’������� �����T!�TR!�TRU!�TRUE!�Y!�YE�YES?�

IFALSE’������� �����F!�FA!�FAL!�FALS!�FALSE!�N!�NO$�

BOOLEAN( STRING value, FORMAT format)

BOOLEAN �������$�FORMAT����� ���2���������������������,�� �����'��$�

AND() BOOLEAN TRUE����������� ������TRUE�

NOT() BOOLEAN TRUE����FALSE?�FALSE����TRUE�

OR(BOOLEAN value) BOOLEAN TRUE����������� �����TRUE�

Real() REAL 3������� �����TRUE?�6������� �����FALSE�

String() STRING ITRUE’������� �����TRUE$�

IFALSE’������� �����FALSE.�

Table 2-21: BOOLEAN Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-31

BORE Object PDMS

Member

Name Type Purpose

Size REAL��

/�9��

���1�*����H�

Table 2-22: BORE Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

BORE(REAL value) BOOLEAN 0�����������������������BORE���"���#�����������value$�

BORE(STRING value) BOOLEAN 0�����������������������BORE���"���#�����������value.�

BORE(STRING value, FORMAT format) BOOLEAN 0�����������������������BORE���"���#�����������value!������������ ��������������format$�

EQ(REAL value) BOOLEAN 0� �������#����������� ��value��������������BORE�����$�

GEQ(BORE bore) BOOLEAN TRUE�����������"�������������������2�� ����������� ��bore$�

GEQ(REAL value) BOOLEAN 0� �������#����������� ��value��������������BORE�����$�

GT(BORE bore) BOOLEAN TRUE����BORE�����������BORE�

GT(REAL value) BOOLEAN 0� �������#����������� ��value��������������BORE������

LEQ(BORE bore) BOOLEAN TRUE�����������"������ ����������2�� ����������� ��bore$�

LEQ(REAL value) BOOLEAN 0� �������#����������� ��value��������������BORE������

LT(BORE bore) BOOLEAN TRUE�����������"������ �������bore$�

A Summary of Objects, Members and Methods

2-32 PDMS Software Customisation Reference Manual

Name Result Purpose

LT(REAL value) BOOLEAN 0� �������#����������� ��value��������������BORE������

Real() REAL 0�����BORE������REAL��� ��

String(FORMAT format) STRING 0�����BORE������STRING���������������������� ��� �format ��"��$�

Table 2-23: BORE Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-33

BUTTON Object Forms and Menus

Members

Name Type Purpose

Background REAL

��9/��

���������1���������0� ������ ���

Background STRING

���� ��

���1���������0� ������ �

Val BOOLEAN� TRUE�#��������������������FALSE�#�����������

Table 2-24: BUTTON Object Members

Methods

Name Result Purpose

AddPixmap(STRING file1, STRING file2, STRING file3 )

AddPixmap(STRING file1, STRING file2)

AddPixmap(STRING file )

NO RESULT �������> ���������������������� ���!�� �������������������$���� �����#����������� $�

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /���#������ $�

SetPopup(MENU menu) NO RESULT ������������ ��#�����������������������$�

RemovePopup(MENU menu) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *��������� ������� ����������� ��������$�

Shown() BOOLEAN /�����#�������$�

SetFocus() NO RESULT '������������������������������$�

Refresh() NO RESULT *��������� �����������$�

SetToolTip(STRING) NO RESULT ��������>����������� ���$�

Type() STRING /����������@���������STRING$�

Table 2-25: BUTTON Object Methods

A Summary of Objects, Members and Methods

2-34 PDMS Software Customisation Reference Manual

Command

���BUTTON��� ���������������!�����������������������!����������> ��!��� ������>���������� ���������$�

+�������������BUTTON������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

����� �������������> �������� �������������������� 8������ ������������� ������������������8��AddPixmap()� ����$�

.--------<-------------. / | >- BUTTON gname -+-- tagtext -------------| +-- PIXMAP <vshap> ------| +-- <fgpos> -------------| +-- <fganch> ------------| +-- <fgdock> ------------| +-- CALLback text —------| +-- TOOLTIP text --------| +-- BACKGround <colno> --| +-- CORE ----------------* Core managed gadget `--------+--FORM fname---. `---------------+-- OK -- ----------. +-- APPLY ---------| +-- CANCE L --------| +-- RESET ---------| +-- TOOLT IP text --| +-- HELP ----------| ‘-------- ----------‘-->

Syntax Graph 2-7: Creating a BUTTON Object

Note: &��������������������� �������������������������$������ ��� �������������������������

Defaults: &������������������!������������ ��������������D��gname$�

�������� ������������������ ��������������� �����OK!�APPLY!�HELP!�CANCEL����RESET$�������� ���� ����������������������������DOCK�O��!����ANCHOR�O�����M����$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-35

COLLECTION Object Collection and Report

����� �������"�������������>�������������� ������ �������� ��������� ������� ���A��>���������"��B!����������������� ����������� ����$�

Methods

Name Result Purpose

Collection() 0����������A����� ����� ������"���������B$�

Scope (COLLECTION) � ������������������� ������� �������������COLLECTION��������������$�

Scope (DBREF) � ������������������� ������� �������������DBREF��������������$�

AddScope ��������������DBREF������������������ ���$�

Scope (DBREF ARRAY) *� ������������������ ����#������������� �������DBREF�.�

AppendScope (DBREF ARRAY) ��������������� �������DBREF������������� ���$�

ClearScope() � ������������������� ���$�

Filter (EXPRESSION) ��������� ����������� ����������� ����$�

ClearFilter () � ���������� ����������� ����������� ����$�

Type (STRING) � ����������������������� ��������������������� �����$�

AddType(STRING) �������������� ��������������������� ���$�

ClearTypes() � ��������������������� ����������� ����$�

Types (ARRAY elements) *� ������������ ������ ����#������������� ���!�elements$�

AppendTypes (ARRAY types) ��������������� ���!�types!���������������� ���$�

Initialise() &���� �������� ���� ���!����� �2������������@�� ��������� ������� �$�������>������������3$�

Filter() EXPRESSION *��������>���������������� ����������� ��$�

Scope() DBREF ARRAY *�������� ��������������� ���������$�

A Summary of Objects, Members and Methods

2-36 PDMS Software Customisation Reference Manual

Name Result Purpose

Types() STRING ARRAY *�������� ��������������� �������������� ���$�

Results() DBREF ARRAY *��������#�� ��� ����$�

Next(REAL n) DBREF ARRAY *������������������ ��� ��������n� ����������������������>��������$�

Index() REAL *����������������>�����������������������Next().�

Size () REAL *��������� ������ ���������� ����$�

Table 2-26: COLLECTION Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-37

COLUMN Object Collection and Report

����� � ���"�����������#�����#��������� � ��������� ���"���������� ���$�

������ ������������� � ����� �������������� ������ � ������������ �������� ��#����������������"����������>�������������� ������ ���"��$������#� �� �#������ ���� �������� ���������������������������� ���!�#��������������������������� $�

Methods

Name Result Purpose

Column() 0����������A����� ����� ������"���������B�

Column(EXPRESSION, BOOLEAN, BOOLEAN, STRING)

0�����������������>������!�����!�������!�(��

Key (STRING) ��������������������������������

Expression (EXPRESSION) -�������>������������������ �������� � �

Sort() �#���������� � ������

NoSort() �#������������ � �����!���������������� ��������

Ascending() ������ � ���������������������

Descending() ������ � ���������������������

Key() STRING *�����������#�����������#����������

Expression() EXPRESSION *��������>����������������������������������� � �

IsSorted() BOOLEAN *������*%���������� � ����������

SortType() STRING *���������� � �����������!�������!���������������

Table 2-27: COLUMN Object Methods

A Summary of Objects, Members and Methods

2-38 PDMS Software Customisation Reference Manual

COLUMNFORMAT Object Collection and Report

����� � ���"�����������#�����#��������� � ��������� ���"���������� ���$�

������ ������������� � ����� �������������� ������ � ������������ �������� ��#����������������"����������>�������������� ������ ���"��$������#� �� �#������ ���� �������� ���������������������������� ���!�#��������������������������� $�

Methods

Name Result Purpose

ColumnFormat() 0����������A����� ����� ������"���������B�

Format(FORMAT) ���������� ����������� � ���������������� ���

Format(DATEFORMAT) ���������� ����������� � �������������������� ���

FORMAT('STRING') %���������� ����������� � !��$$������ � �

Width (REAL) ��������� � �#�����

Widest() ������� �>� � ��� � �#������ ��!�����������������#������� ������ ����� ���������� ������FALSE$���������������������� ����������� ���������)��������������� � ������������������������ �����#����$�

Indent(REAL, REAL) ���� �����������������A�$$������B�������� � �

Format() FORMAT *����������� �������� ������ ��������� � �

Width() REAL *���������� � �#����!����������������������� � �#��������#��������������>�� �!�� ������ ������������������ � �#���������������������� � ���������$�

GetWidest() BOOLEAN *�����TRUE����F#����G�������

Justification() STRING *���������� � �"������������

LeftIndent() REAL *�������� �������������

RightIndent() REAL *������������������������

Table 2-28: COLUMNFORMAT Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-39

DATEFORMAT Object Collection and Report

���DATEFORMAT���"�������������� �#������������������������������������$�

�>� � ���

!format = object DATEFORMAT(T D/M/Y’)

!format.month(‘INTEGER’)

!format.year(2) $ 12:10 05/01/01

!format = object DATEFORMAT(‘T D M Y’)

!format .month(‘BRIEF’) $ 12:10 05 Nov 01

!format = object DATEFORMAT (‘D M’)

!format.year(4)

!format.month(‘FULL) $ 5 November 2001

Methods

Name Result Purpose

DateFormat(STRING format) 0���������$�-��������� ��$�

�������������!�format!������������ �'T*D*M*Y'!�#���T�O��� !�D�O����!�M�O� ���!�Y�O����!������������������ ������������������ ����2����$�

T����D���������� $�H���� ������������ ������������2����$�

R������������������������$�

DateFormat() �������� ����� ���(‘T M D Y’!� ����O�IINTEGER’!�����O�5B�

Month(STRING) ���� ������� ��$�'INTEGER'!�'BRIEF'����'FULL'�

Year(INT) ����������� ��$�5����7������ �������������

String(DATETIME) STRING &������������DATETIME���� ����������������������������� ��$�

String(STRING) STRING &������������PDMS���� ����������������������������� ��$�

A Summary of Objects, Members and Methods

2-40 PDMS Software Customisation Reference Manual

Table 2-29: DATEFORMAT Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-41

DATETIME Object PML Built-in Type

Methods

Name Result Purpose

DateTime() DATETIME 0������DATETIME���"���#������������������� �����$�

DateTime(REAL year, REAL month, REAL date)

DATETIME 0������DATETIME�����������������!� ���!����$��� ����� ������66�66�66$�

DateTime(REAL year, STRING month. REAL date)

DATETIME �������!����� ���������STRING���� ������������������ ����������� ����$�$�I=�D!�I'����D!�I-�0�'D�

DateTime(REAL year, REAL month, REAL date, REAL hour,REAL minute)

DATETIME 0������DATETIME���"����������������!� ���!����!�����!� ���$����������� �����6$�

DateTime(REAL year, STRING month, REAL date, REAL hour, REAL minute)

DATETIME �������!����� ���������STRING���� ������������������ ����������� ����$�$�I=�D!�I'����D!�I-�0�'D�

DateTime(REAL year, REAL month, REAL date, REAL hour, REAL minute, REAL second)

DATETIME 0������DATETIME���"����������������!� ���!����!�����!� ���!�����$��

DateTime(REAL year, STRING month, REAL date, REAL hour, REAL minute, REAL second)

DATETIME �������!����� ���������STRING���� ������������������ ����������� ����$�$�I=�D!�I'����D!�I-�0�'D�

Date() REAL *����������� �������������DATETIME���"���A3@:3B$�

GEQ(DATETIME) BOOLEAN ����#����������DATETIME���� ���������������� �������� ��DATETIME$�

GT(DATETIME) BOOLEAN ����#����������������� ������������ ��-����&'�$�

HOUR() REAL *������������REAL����������DATETIME���"���A6@5:B$�

LEQ(DATETIME) BOOLEAN ����#����������DATETIME������ ����������� �������� ��DATETIME�

LT(DATETIME) BOOLEAN ����#����������DATETIME������ ����������� ��DATETIME$�

Minute() REAL *���� ��������REAL����������DATETIME���"���A6@;4B$�

A Summary of Objects, Members and Methods

2-42 PDMS Software Customisation Reference Manual

Name Result Purpose

Month() REAL *���� �������REAL����������DATETIME���"���A3@35B$�

MonthString() STRING *���� �������STRING����������DATETIME���"��AI=�����D!�D,������D!���$B�

Second() REAL *����� ���������������*�������������DATETIME���"��A6@;4B$�

Year() REAL *�����������REALA$�$�344QB�

Table 2-30: DATETIME Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-43

DB Object PDMS

Members

Name Type Purpose

Name STRING ���� ��������������!�������:5����������$�

Description STRING ��������������������!�������356����������$�

Access STRING ����������AUPDATE!�MULTIWRITE!�CONTROLLEDB$�

Claim STRING 0 �� � ������� � ��@#�������������AEXPLICIT!�IMPLICITB$�

File STRING -��������� � !�������3L����������$�

Foreign STRING FOREIGN����LOCAL�

Number STRING -�������� ���

Team TEAM �#����� �

Type STRING -����������!�$�$�DESI�

Refno STRING ��������������-������������� ���

Primary STRING &�������#������������������PRIMARY����SECONDARY������������� ������������ ��� ����"����

Table 2-31: DB Object Members

Methods

Name Result Purpose

MDBList() ARRAY ��������MDBS�#����������������DB$�

Size() REAL ,� ���H�������$�

Sessions() ARRAY OF DBSESS

� ���������������������������$�

Lastsession() DBSESS ��������������� ����������������$�

DB(DBREF) DB *�������DB���"��!�������DBREF$�

DB(STRING) DB *�������DB���"��!�������� ���������� ��$�

Table 2-32: DB Object Methods

A Summary of Objects, Members and Methods

2-44 PDMS Software Customisation Reference Manual

���� ������ ���������������� �#���#����A��� ������!!CE�������� ���������DB DATABASE� �����!!CE.Name �����STRING���"�������������� �D��� B$�

�>� � ���

!D = OBJECT DB(!!CE)

!D = OBJECT DB(!!CE.Name)

!D = !!CE.DB()

!D = !!CE.Name.DB()

���� ���������� �������������� ���� ���� ���������#������ ���������������������� �-������� �������"��$�

Command

!ARRAY = DBS $ Returns an array of the DBs in the current project

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-45

DBSESS Object PDMS

Members

Name Result Purpose

Number REAL ������� ��$�

Date STRING -���#��������������$�

Author STRING 0��������������$�

Comment STRING �������� �$�

Table 2-33: DBSESS Object Members

A Summary of Objects, Members and Methods

2-46 PDMS Software Customisation Reference Manual

DIRECTION Object PDMS

Members

Name Type Purpose

East REAL

/�9����

UP��� ����

North REAL

/�9����

NORTH��� ����

Up REAL

/�9����

UP��� ����

Origin DBREF

/�9����

DB� �������������������

Table 2-34: DIRECTION Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Direction( STRING ) DIRECTION 0�������DIRECTION�#��������� ���������STRING$�

Direction( STRING, FORMAT ) DIRECTION 0�������DIRECTION�#��������� ���������STRING!��������� ����������$�

EQ(DIRECTION) BOOLEAN TRUE�����#������������������� �

LT(DIRECTION) BOOLEAN TRUE��������������� ����������� ��

String(FORMAT) STRING 0��������STRING�

WRT(DBREF) DIRECTION 0����������#�DIRECTION�#������������������� �$�

Angle(DIRECTION) REAL *���������� ���#�����#�����������

Bisect(DIRECTION) DIRECTION *����������������#���������� ��#�����#�����#�����������

Cross(DIRECTION) DIRECTION *�����������������������������#�����������

Dot(DIRECTION) REAL *���������������������������#�����������

IsParallel(DIRECTION) BOOLEAN *������������������� ������������������� !��� ������#��$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-47

Name Result Purpose

Opposite() DIRECTION *������������������������

Orthogonal(DIRECTION) DIRECTION *������������������������ ���#�����#�����������

Projected(PLANE) DIRECTION *������������������"������������������ �$�

Table 2-35: DIRECTION Object Methods

A Summary of Objects, Members and Methods

2-48 PDMS Software Customisation Reference Manual

EXPRESSION Object Collection and Report

�������"�������������������������>�������������������� �������������������� �������������"��������������������������� �!�BOOLEAN!�STRING!���$�

EXPRESSION���"���� ������������COLLECTION���"��������� ��������� ����������� ����$�

Methods

Name Result Purpose

Expression 0����������A����� ����� ������"��D��������B$�

Expression (STRING) 0��������������������>������$�A'ATTRIBUTE@@@@8B����� ����������������������������������������$�������>� � �����A'PURP�2�IPIPINGI'B����A'XLEN�M�STRINGAXLENB8B$�

AttributeExpression (STRING) '������������������������>������$����������>������A'LENGTH'B��������� �����>������A'ATTRIBUTE�LENGTH'B$�

String() STRING *��������������>�����������������$�

Evaluate(DBREF) ANY ��� ��������������>�������������������������"���

Table 2-36: EXPRESSION Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-49

FILE Object PML Built-in Type

Methods

Name Result Purpose

File(STRING) FILE 0������FILE���"��������� �#����� ����������STRING$�

AccessMode() STRING *���������� ������������ �VICLOSED’!�IREAD’!�IWRITE’!�IOVERWRITE’!�IAPPENDW$�

Close() NO RESULT 0 ����� ������$�

Copy(STRING) FILE 0���������� �#��������� ����������STRING$�*�����FILE���"��������������� $�

Copy(FILE) FILE 0���������� ��������������FILE���"��$�*�����FILE���"��������������� $�

DeleteFile() NO RESULT - ������� ���������������� ���"���������>����$�

Directory() FILE *�������FILE���"������������������#�����������$�

DTM() DATETIME *�������DATETIME���"����� ���������������� ������������� �#��� ���� ������$�

Entry() STRING *������� �� ���������$�

Exists() BOOLEAN *�����BOOLEAN����������#������� �>����������$�

Files() ARRAY OF FILES

*�������ARRAY����FILE���"�������������������� ���#������������������$�

FullName() STRING *��������� ��� �������������������FILE���"��������STRING$�

IsOpen() BOOLEAN *����BOOLEAN����������#������� ������������$�

LineNumber() REAL *���� ��� ������ �������������#����$�

Move(STRING) FILE '���������� ���� �������������STRING$�*����FILE���"������� ������ $�

Move(FILE) FILE '���������� ���� �����������������FILE���"��$�

Name() STRING *����� ���������FILE���"������STRING$�

A Summary of Objects, Members and Methods

2-50 PDMS Software Customisation Reference Manual

Name Result Purpose

Open(STRING) NO RESULT ����������� ������ ����������STRING�VIREAD’!’WRITE’!’OVERWRITE’!�IAPPEND’W�

Owner() STRING *��������ID���������FILES��#����STRING$�

Path() ARRAY OF FILES

*�������ARRAY����FILE��������������������#���������������������FILE���"��$�

PathName() STRING *������#�������������STRING$�

ReadFile() ARRAY OF STRING

��!��������������� ����� $�-���������������ARRAY����STRING������������������� ���������� $�

ReadFile(REAL) ARRAY OF STRING

�������!����������������� ������ ��������� ������ ���������*���$�

ReadRecord() STRING *������ ����� �������� �����������������STRING$�*�������UNSET�STRING����������� ���������$�

Set() BOOLEAN *�������BOOLEAN����������#����������,&�����"���������� ���������$�

Size() REAL *�������H������ �������$�

SubDirs() ARRAY OF FILE *�������ARRAY����FILE���"�����������������������������#������������������$�

Type() STRING *�������STRING����������#������������"������������IFILE’������IDIRECTORY’$�

WriteFile(STRING, ARRAY OF STRING) NO RESULT ������ ��� ���������������VIWRITE’!�’OVERWRITE’!�’APPEND’W!�#�����STRING����ARRAY����� ������ $�

WriteRecord(STRING) NO RESULT )�����STRING���������FILE�#����� ����� ���������$�

Table 2-37: FILE Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-51

FMSYS Object All

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

SetMain(FORM) FORM ������� ������ ���������� ������$�

Main() FORM C������������� ������ �

Refresh() NO RESULT *������ �VIEW��������

Checkrefs BOOLEAN 1������ �!�� �����������,�� ������������������#������� �������� ���$�0������������#���������!�#����� �������� ����������� ������� �����>�����$�

SetInterrupt(GADGET) NO RESULT �������/�����#�����#� ��������� �����������������������$�

Splashscreen(BOOLEAN) NO RESULT * ����������� ���������� ������������������� � �>��$�

Interrupt() BOOLEAN ������TRUE���������������������������� ���$�

FMINFO() ARRAY OF STRINGS

*��������������� �FMINFO�������$�

DocsAtMaxScreen(BOOLEAN) NO RESULT �������� ��� �� ������������������ ����� ���������#�������� �>� � �A����� ���B����������$�%��� �����#�����������#�����������$�

CurrentDocument() FORM ����� ��������������������-��� ����������� ���������� #���������FORM���"��$��&��������������������� ����������������� ������� ��Unset$��

Table 2-38: FMSYS Object Methods

A Summary of Objects, Members and Methods

2-52 PDMS Software Customisation Reference Manual

FORM Object Forms and Menus

Members

Name Type Purpose

FormRevision STRING

/�9���

,�� �*�������>�$�

FormTitle STRING

/�9���

,�� ���� $�

IconTitle STRING

/�9���

&������ $�

Initcall STRING

/�9���

0� �����>�����#����� ��������� ���$�

Autocall STRING

/�9���

0� �����>�����#���������������������� ��������������������������$�

Okcall STRING

/�9���

0� �����>�����#��OK���������������$�

Cancelcall STRING

/�9���

0� �����>�����#��CANCEL���������������$�

KeyboardFocus GADGET

/�9���

/����������������� ��������������������� ������������ $������TEXTFIELD!�TEXTPANE!�BUTTON!�TOGGLE����ALPHA�VIEW$�

Maximised BOOLEAN

/�9���

/�9������ D�� �>� �����������A�����B$�

Active BOOLEAN

/��� ��

/������� 8�������9�������������$�

Popup MENU

/�9���

/�9������ D�������������� �$�

Table 2-39: FORM Object Members

Methods

Name Result Purpose

Name() STRING /��� $�

FullName() STRING /������� ���� �� �A&� �����PPB$�

NewMenu(STRING menuname) MENU �������#�� �� ����������� $��

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-53

Name Result Purpose

NewMenu(STRING menuname, STRING type)

MENU �������#�� ���������� ����������� $�������������� ��������� �������#� �?������������� ������������������ �!���� �����������IPOPUP’����IMAIN’$�

SetActive(BOOLEAN) NO RESULT SetActive(FALSE)�����@����� ���������������� !��������D����������������������!���������SetActive(TRUE)�������������� ���������������������#�������������������!��$$������������������#� ���� ���������$�

SetGadgetsActive(BOOLEAN) NO RESULT SetGadgetsActive(FALSE)����������� ���������������� �����������������������������I������D!��$$���������������������������� ���$��� � �� ��SetGadgetsActive(TRUEB�����@��� ������������������������������������I�����D$�

SetPopup(MENU) NO RESULT ��������������@������������ ����#����������@���� �������������� �������������� ����������$�

RemovePopup(MENU) NO RESULT * ���������@�������������#��������� $�

GetPickedPopup() MENU *�������� ���������������� ������������ $�

Show('FREE') NO RESULT ���#������� ���������������FREE���� $�

Show('AT', REAL X, REAL Y) NO RESULT ���#������� ������FREE���� �#�������������������X,Y�� ����������������$�

Show('CEN', REAL X, REAL Y) NO RESULT ���#������� ������FREE���� �#������������������X!Y�� ����������������$�

Shown() BOOLEAN /��8���#8��������

Hide() NO RESULT .���������� �A� ���������� �������B�

Owner() FORM *����������� 8���������� !�������������� ���������� ������@�������

Table 2-40: FORM Object Methods

Note: SetActive()����SetGadgetsActive()�������������� �������#����������������#�������Active�������������������� ��������

A Summary of Objects, Members and Methods

2-54 PDMS Software Customisation Reference Manual

Commands

SETUP FORM

����� ���������������������������SETUP FORM��� �������� ���������������������EXIT��� ��$������,�� ������ ������������ ������ �������������������� D����������!���������� ������A��1�*���"��B!� ������������ ���A��'��%���"��B��������������#���������������#$�

��@� ����� ��������������������������������SETUP FORM��� ��� �?� ������� ������������������������������������ $�

+�������������FORM������������'�@����� �!�������@��������� ����������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$�

Note: &��������������������� �������������������������$������ ��� ������������������������$��

����� ���������� ������� ����������������������������������>������$�

.---------------<---------- -----------------. / | >--SETUP FORM fname --+-- MAIN -----+-------------- -----------------| +-- DOCUMENT -+- FLOAT ------ -----------------| | ‘-------------- -----------------| +-- DIALOG ---+- DOCKing -+-- -----------------| | |- Left ---. | | | |- Right –-| | | | |- Top ----| | | | ‘- Bottom –‘--------| | |- RESIzeable - -----------------| | ‘-------------- -----------------| +-- BLOCKingdialog -+- RESIze able ------------| | ‘-------- -----------------| +-- AT <xypos> -------------- -----------------| +-- SIZE val val ------------ -----------------| +-- NOQUIT ------------------ -----------------| +-- CORE -------------------- -----------------* | .---<------. |/ | +-- <form> --* form contents ‘—EXIT -->

Default : -�� ��!��@���H�� ?���H���"��������� ����� ��������������$

CANCELCALL

������� ������������� �����������#��������>�����#���������� ������� �������� ���������������CANCEL�������������QUIT/CLOSE������ ������#���#���� ����$�

>-- CANCELcall text -->

Note: ������� ���������������� ����������������CANCEL������$�

CURSORTYPE

)�����������������������#!������#���������� ���#������������������� �������� ��������� �!����#��������#� ������� ����������

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-55

����������������������� ���������$�+��������������������� ������������������������������������� ��$�

Note: +���������������������� ����������������VOLUME���#�$�

>-- CURSortype --+-- POINTER ----. +-- NOCURSOR ---| +-- PICK -------| +-- PICKPLUS ---| ‘-- CROSSHAIR –-‘-->

Note: �����������������������������������������D������ �$�

HALIGN

)���������"������#����PATH����HDISTANCE$�-������#���# ����������������� ����� ��������H��� ��#�������������������$��

>-- HAlign --+-- Left ---. ‘-- Right –-‘-->

HDISTANCE

)���������"������#����PATH����HALIGN$�-������#���# ����������������� ��������������H��� ��#����������������������������$�

>-- HDistance value -->

ICONTITLE

-���������� ������������#�������� ���� �� ���$�

>-- ICONTItle text -->

INITCALL

-��������� �������������������>����������� ������� �������� ���$�������� ������������ ������������������ ������������#��������� ������������ ����������� ��$�

>-- INITcall text -->

OKCALL

-�������OK��� �������������������� $�&�����>�����#���������� ������� �������� ����������������OK��������������������������$�

>-- OKcall text -->

Note: �������� ���������������� ����������������OK������$�

A Summary of Objects, Members and Methods

2-56 PDMS Software Customisation Reference Manual

PATH

-�����������������#��������2������#����������������������������� $���������������� ������� ���������������PATH��� ��$�%���#����HALIGN!�HDISTANCE!�VALIGN!�VDISTANCE$�

>-- PATH --+-- Up ------. +-- Down ----| +-- Left ----| ‘-- Right ---‘-->

Default: �����*����$�

TITLE

-���������� ���� $�

>-- TITLe text -->

VALIGN

%������"������#����PATH����VDISTANCE$�-������#���# ����������������� ����� ���������� ��#�������������������$��

>-- VAlign --+-- Top -----. ‘-- Bottom --‘-->

VDISTANCE

)���������"������#����PATH����VALIGN$�-������#���# ����������������� ���������������� ��#����������������������������$��

>-- VDistance value -->

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-57

FORMAT Object Formatting

Members

Name Type Purpose

CompSeparator STRING

X�X�

����������������� � ��@�� ����������������������POSITIONS�A-��� �����0�B$�

Denominator REAL

:5��

��������� ����������& ���� ����������A-��� ��:5B�

Dimension STRING

I����D�

��

�5�

�:�

�� �������@�� �����A-��� �B�

�� ��������LENGTH

�� ��������AREA

�� ��������VOLUME�

DP REAL

5��

�� ��������� � �� ����������� � ����������A-��� ��5B�

ENU BOOLEAN

�*%��

,�����

%��ENU���� ���#������������POSITIONS�A-��� �B�

%��XYZ���� ���#������������POSITIONS�

Fraction BOOLEAN

,������*%��

,������� ������������������� � �A-��� �B�

,������� �������������������������

FtLabel STRING

XDX�

��� ������������$�$�8�����,���������������

A-��� ��I�B�

InchSeparator STRING

X$X�

�����������#������������������

A-��� ��$�B�

Label STRING

X X�

/�� �������� �� ��

$�$� ������ ������Y������IN

A-��� ������� �� B�

PadFractions BOOLEAN

,������*%��

-���������,��������A-��� �B�����,��������#�������� ���������

Units STRING

''�'�,&�0.�&�0.�

�������� ����� � � ����A-��� �B�

�������� ����� ���$�

�������� ������������������������ ����������

A Summary of Objects, Members and Methods

2-58 PDMS Software Customisation Reference Manual

Name Type Purpose

OriginExp BLOCK

XX�X9RX�X0�X�

)�������������)�� ��A-��� �B�

)�������������)�� ��

)�������������0������ ��

Zeros BOOLEAN

�*%��

,�����

������H����������� ��������& ���� ������A-��� �B$�

������H�������������� ��������& ���� ������

Table 2-41: FORMAT Object Members

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-59

FRAME Object Forms and Menus

Members

Name Type Purpose

Tag STRING

/�9���

�>����������������� ��������� $�

Table 2-42: FRAME Object Members

Command

���FRAME��� ������������� ������$�

����� �������������#������#����� ����������������������������#�������������!��� ������������� �$��

������ ����������������visible����active�#� ����� ����� ����� ������ ����������� ��!�����#� �������#������������������������������ ��$��

�������������������FRAME��NORMAL!�TABSET!���$ TOOLBAR�

• ��NORMAL���� �������������������������!��� ������������� �$�

• ��TABSET���� ����������� ������������FRAME�?��������������� ��������������� �$�

• ��TOOLBAR���� ����������� �������������������������BUTTON!�TOGGLE!�OPTION!����TEXT$�&�� ����������� �������������� ���� ������ �$�

.---<---- ---. / | >--FRAME gname -+- TOOLBAR -+- tagtext -+- <toolbar > -* toolbar contents | ‘—- EXIT -- > | .---<--------. | / | +- TABSET -+-- <fgpos> ---| | +-- <fganch> --| | +-- <fgdock> --| | +-- <vshap> ---* | | .---<--------. | |/ | | +-- <tabset> --| tabbed frame contents | +-- NL --------* | ‘-- EXIT --> | .---<--------. |/ | +-- tagtext ---| +-- <fgpos> ---| +-- <fganch> --| +-- <fgdock> --| +-- <vshap> ---* | .---<-------. |/ | +-- <formc> --* normal form contents ‘-- EXIT -->

#���������@�������J��� ���K!�J�����K����J��� �K��������� �#�� ����������� �������� �������� �� �#��������������������������$�

A Summary of Objects, Members and Methods

2-60 PDMS Software Customisation Reference Manual

Note: ���������J��� �K����������� � �������������� !�� ������������A>����1�*B����� �#�$������������������������ ��������������������� �#$�

Setting Up a TOOLBAR Frame

������ ������� �� �#���������������� � ���� ����������������� ������������������� D������$�+��������������� ������� �� �������� ������ !������ ������ ����������� ����� ������� �$�

���������� �#����������� �#�� �������������� ������� ��

>-- toolbar -+-- <fbutn> ----. Button gadget +-- <ftext> ----| text gadget +-- <ftogl> ----| toggle gadget +-- <foptio> ---| option gadget +-- <fvar> -----| form variable definition +-- <pml> ------| general PML +-- <nxasgn> ---| PML expressions ‘-- <varset> ---‘----> variable setting VAR…

Setting Up a TABSET Frame

��TABSET���� ���������������������������������������� �$�&������������� ������������� $�

���������� �#������� �#�� ������������TABSET���� ��

>-- tabset >-+-- <fframe> ---. frame gadget +-- <fvar> -----| form variable definition +-- <pml> ------| general PML +-- <nxasgn> ---| PML expressions ‘-- <varset> ---‘----> variable setting VAR…

Note: ,�� ���������������#���#����������������� ����� �������������� � !������� ���������������� �$�

��� � ���� ������������ ��#����������������� !�#� ���������������������#�������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-61

LINE Object 3D Geometry

��� ��������&����0��*���"��$�

Members

Name Type Purpose

StartPosition POSITION

/�9���

����������������� �$�

EndPosition POSITION

/�9���

�������������� �$�

Table 2-43: LINE Object Members

Definition Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Line( POSITION first, POSITION second) LINE 0�������LINE���#����������������!�first����second$�

String() STRING *�������� �������STRING$�

Direction() DIRECTION *�������DIRECTION�������������������������� �$�

Direction(DIRECTION way) LINE 0�������#� ��#��������� ������������������ ����������������������������way$��

Table 2-44: LINE Object Definition Methods

EndPosition

StartPosition

Direction(DIRECTION)

�Figure 2-I: : Basic LINE Definition

A Summary of Objects, Members and Methods

2-62 PDMS Software Customisation Reference Manual

LINE Object Methods that Return BOOLEANs

���������� ������ ���������������� ���"��$�

Name Result Purpose

On(POSITION where) BOOLEAN *�����TRUE����where� �������������� �$�

OnProjected(POSITION where) BOOLEAN *�����TRUE����where!�#�����"����������� �!� ���#�������������� �$�

Table 2-45: LINE Object Methods that Return BOOLEAN s

OnProjected(POSITION) ����

On (POSITION) ����

�Figure 2-J: BOOLEANs Returned by LINE Object Method s

LINE Object Methods that Return POSITIONs

���������� ������ ���������������� ���"��$�

Name Result Purpose

Intersection(LINE other) POSITION *����������������������������������LINE������ ����������

Intersection(POINT point, VECTOR vector)

POSITION *����������������������������������POINTVECTOR������ ���������$�

Intersection(PLANE plane) LINE *����������������� �����plane������ ���������$�

Intersections(ARC arc) ARRAY OF POSITIONS

*��������������������������arc������ ���������$�

Near(POSITION position) POSITION *�������������������������� ������������ position$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-63

Name Result Purpose

Proportion(REAL proprtion) POSITION *�������������������proportion�� ������F�����G� ����� ����StartPosition$�

�� ���K�3�#� ����������������������������� �$�

�� ���J�6�#� ��������������������������������� �$�

Table 2-46: LINE Object Methods that Return POSITIO Ns

Intersection(LINE)

Proportion(REAL)

Near(POSITION)

�Figure 2-K: POSITIONs Returned by LINE Object Metho ds

LINE Object Methods that Return REALs

���������� ������ ���������������� ���"��$�

Name Result Purpose

Length() REAL *�������� ���������� �$�

Distance(LINE other) REAL *�������� �� � ����������#���� �������������other$�

Distance(POSITION position) REAL *�������� �� � ����������#���� �������������position$�

Table 2-4847: LINE Object Methods that Return REALs

A Summary of Objects, Members and Methods

2-64 PDMS Software Customisation Reference Manual

Distance(LINE)

Distance(POSITION)

Length()

�Figure 2-L: REALs Returned by LINE Object Methods

LINE Object: Miscellaneous Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Plane() PLANE *�������� ����"��!���������StartPosition����-���������� ����"���

Pointvector() POINTVECTOR *�������POINTVECTOR���"��!���������StartPosition����-���������� ����"���

Figure 2-M: LINE Object Miscellaneous Methods

LINE Object Methods that Return LINEs (a)

���������� ������ ���������������� ���"��$�

Name Result Purpose

SetLengthStart(REAL length) LINE *�������#� �!� ����������������� �StartPosition�����������!�#������EndPosition���� �����length$�

SetLengthEnd(REAL length) LINE *�������#� �!� ����������������� �EndPosition�����������!�#������StartPosition���� �����length$�

Towards(POSITION position) LINE *�������#� ����"���#��������� �StartPosition��������� �� �����EndPosition�A����B������������� � �!���������������������� ���������������������position.�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-65

Name Result Purpose

From(POSITION position) LINE *������� �!�#������StartPosition�������position!� ����������������� �EndPosition$�

To(POSITION position) LINE *������� �!�#������EndPosition����������position!� ����������������� �StartPosition��

ExtendStart(REAL distance) LINE *�������#�LINE!�#������StartPosition�������>���������������������������� �����distance.�

ExtendEnd(REAL distance) LINE *�������#�LINE!�#������EndPosition�������>����������������������� �����distance.�

Table 2-48: LINE Object Methods that Return LINEs ( a)

SetLengthStart(REAL)

From(POSITION)

Towards(POSITION)

To(POSITION)

ExtendEnd(REAL)

ExtendStart(REAL)

SetLengthEnd(REAL) �

Figure 2-N: LINEs Returned by LINE Object Methods ( a)

LINE Object Methods thet Return Lines (b)

Name Result Purpose

ExtendStart(PLANE plane) LINE *�������#�LINE!�#������StartPosition�������>�������plane$�

ExtendEnd(PLANE plane) LINE *�������#�LINE!�#������EndPosition�������>�������plane$�

A Summary of Objects, Members and Methods

2-66 PDMS Software Customisation Reference Manual

Name Result Purpose

ReverseSense() LINE *������� �!�#������StartPosition����EndPosition���������������$�

Projected(PLANE plane) LINE *�������LINE����������� � ��������plane$���������$�

Parallel(POSITION position) LINE *����������� ������� ���������������� ����"��!���������position$�� ������ ������������$���������$�

Offset(DIRECTION direction, REAL offset)

LINE *����������� � ��������LINE���"��!����������offset���� ���������� ����������direction$���������$�

Table 2-49: LINE Object Methods that Return LINEs ( b)

Offset(DIRECTION, REAL)

Parallel(POSITION)

Projected(PLANE)

Figure 2-O: LINEs Returned by LINE Object Methods ( b)

LINE Object Methods thet Return Lines (c)

Name Result Purpose

Overlap(LINE other) LINE *����������� ������ ������#������ � ��$�� ���������������������"����������������� ���"��$���������$�

Union(LINE other) LINE *���������������LINE����other$�����#��������� � ��!�� ���������������������"����������������� ���"��$���������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-67

Table 2-50: LINE Object Methods that Return LINEs ( c)

Overlap(Line)

Union(Line)

�Figure 2-P: LINEs Returned by LINE Object Methods ( c)

A Summary of Objects, Members and Methods

2-68 PDMS Software Customisation Reference Manual

LINEARGRID Object Construction Aids

Members

Name Type Purpose

Position POSITION

/�9���

�����������������

Orientation ORIENTATION

/�9���

��������������������

XSpacing REAL

/�9���

������������X���������

YSpacing REAL

/�9���

������������Y���������

Table 2-51: LINEARGRID Object Members

Definition Methods

���� ������������ ��������������� ���"��$�

Name Result Purpose

Lineargrid( POSITION, ORIENTATION, REAL, REAL)

LINEARGRID 0������������#�����������POSITION!�ORIENTATION!����X����Y�������$�

String() STRING *������������������������

Table 2-52: LINEARGRID Object: Basic Members

X

Y Z

Orientation

XSpacing

YSpacing

Position

�Figure 2-Q: LINEARGRID Basic Definition

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-69

LINEARGRID Object Methods that Return POSITIONs

���������� ������ ���������������� ���"��$�

Name Result Purpose

GridPoint(REAL, REAL) POSITION *�������������������������������������������E����+� ������ ��������������������$��� ��������M�����@������������������������������

Snap(POSITION) POSITION *����������������������������������������������!�#�� ������������������ ��

Snap(LINE) POSITION *������������������������������������������������������ �������������� ��

Snap(POINTVECTOR) POSITION *����������������������������������������������������������������������������� ��

SnaptoCentre(POSITION) POSITION *������������� ���� �����������������������������!�#�� ������������������ ��

SnaptoCentre(LINE) POSITION *������������� ���� ������������������������������������� �������������� ��

SnaptoCentre( POINTVECTOR)

POSITION *������������� ���� ������������������������������������������������������������ ��

Figure 2-R: LINEARGRID Object Methods that Return P OSITIONs

A Summary of Objects, Members and Methods

2-70 PDMS Software Customisation Reference Manual

Snap(POSITION)

Snap(LINE)

GridPoint(REAL, REAL) �

Figure 2-S: POSITIONs Returned by LINEARGRID Method s

LINEARGRID Object Miscellaneous Methods

����� ������������ ��������������� ���"��$�

Name Result Purpose

Plane() PLANE *����������������� ����"���

Table 2-53: Miscellaneous LINEARGRID Object Methods

Plane()

Within(POSITION) �

Within(POSITION) � �

Figure 2-T: Miscellaneous Return Values from LINEAR GRID Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-71

LINEARGRID Object Methods that Return XYOffsets

����� ������������ ��������������� ���"��$�

Name Result Purpose

XYOffset(POSITION) XYPOSITION *���������������!� ������������������ �!����� �������XY���������� ���������� ��������

Table 2-54: LINEARGRID Object Methods that Return X YOffsets

XYOffset(POSITION)

�Figure 2-U: XYOffsets Returned by LINEARGRID Object Methods

A Summary of Objects, Members and Methods

2-72 PDMS Software Customisation Reference Manual

LIST Object Forms and Menus

Members

Name Type Purpose

Val REAL

/�9���

� ������ �@� ����������� @������ ���$�

Val REAL ARRAY

/�9���

� ������ ��� ��������� � ��� @������ ���$�

DText STRING ARRAY

/�9���

���������������� ����������� ����>��$�

DText[n] STRING

/��� ��

/��������� ����>��������n8����� �$�

PickedField REAL

/��� ��

����������� ������ ��� ��$�

RText STRING ARRAY

/�9���

������������ ��������� �� ���>��$�

RText[n] STRING

��� ��

/������� �� ���>��������n8����� �$�

Table 2-55: LIST Object Members

Methods

Name Result Purpose

FullName() STRING /������� �� ������������!�$�$$8PP,�� $�����8�

Name() STRING /����������8��� !�$�$�8�����8�

Owner() FORM /���#������ $�

Select(STRING text, STRING value) NO RESULT � ������������� ����� ���$�text� ������I*�>�D����I-�>�D$�value�������RTEXT����DTEXT��������� ������� ���$�

Select(STRING text, ARRAY of STRING values)

NO RESULT � ��� � ��� ������� ������ �$�text� ������8*�>�8����8-�>�8$�values�����������RTEXT����DTEXT��� ��������� ���$�

Selection( ) STRING ARRAY OF STRING

/��� ����RTEXT��

���������RTEXT����� � ��@������ ���$�

Selection(STRING text) STRING ARRAY OF STRING

/��� ����RTEXT����DTEXT

����������>������� � ��@������ ���$�

text� ������8*�>�8����8-�>�8$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-73

Name Result Purpose

Clear() NO RESULT 0 ��� �������������� �����$�

ClearSelection() NO RESULT 0 ��� ����� �����$��

SetPopup(MENU menu) NO RESULT �����menu�#�����������������������$�

RemovePopup(MENU menu) NO RESULT * ����������menu���� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Refresh() NO RESULT *������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /��������������������STRING.�

SetToolTip(STRING) NO RESULT � �#����TOOLTIP����������$�

SetFocus() NO RESULT '������������������������������$�

SetHeadings(Array of STRING) NO RESULT �������� ������� �������� � ��������� ���������������� � �������$�&����� �������� ��������� ������������ ��� ������� ���������������>������������$�&������� ������� � ��@�� � � ������ �$�Array����������������� � �������������$�

SetRows(Array of (Array of STRING)) NO RESULT ���������������� ����>������� ����������� ��������� ���������������#$�&����� �������������� ��������� ������������ ����� ������������#��������#���$�Array���������������I��#�������D!����������H���� ������� ��������#������� ���$�����������������#����������������!�#��������� ���������� �����>������������ � ���������#$������H����������#������� ������ ����������2�� �������� �������� � �������� ���$������ � ������� ���2���� ����� �������������>������$�

A Summary of Objects, Members and Methods

2-74 PDMS Software Customisation Reference Manual

Name Result Purpose

SetColumns(Array of (Array of STRING)) NO RESULT ���������������� ����>������� ����������� ��������� ��������������� � $�&����� �������������� ��������� ������������ ����� ������������#��������#���$�Array���������������I�� � �������D!����������H� ���� ��������� �������� � �������� ���$������H��������� ��� � �������� ����������� ������� �������������#������� ���$�

Select(REAL column, STRING dtext) NO RESULT ������ ������������� ������#�#������ � �column������������ ����>��dtext$�&������� ������������������� ����� ���������� ���$�&����� ��������� � ��@������ ������������������������ �����#� ������ ������������ ���$�

Table 2-56: LIST Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-75

Note: ,��� � ��@�� � � ������

RTEXT�#� ����� �����DTEXT�������� $�RTEXTS� ��������� ��������� ����������>������ �����$�

������� ��#�������������� � ������� ��������� ��������������� ������ ��$�

����� � �#������������������� �� ��������������� �������������������������#$�

� �����������������#������������ �� �$�

����� ������ � ���>�� ��������������#�#� ��� � �������A(�/��$��E�$'�E����Z�� �������� � �B����������$�0���� ��(�/��$��E�$'�E�����O�5;<�����$����������� ������������� � ��!���������������������� �#���������������������#������������� ��������������!����������� �� �������������������������������$�

,����� � ��@�� � � ���������!�������#D��DTEXT����������� �������I����H��� ����D����������������������������� � ����� ����>��!� ������������ � ��������A����������������� � �������������� ��� � � ���B$�

�&��� �����!������� � ��@�� � � �������������� �#��� � ���������

• C������DTEXTS�#� ���������������������������$�

• ���� ����DTEXT�������� ������ ������������� ������#� ��2������������������������������$�

���� � ��������#� ���� ���������� �#��� ��������� �����Select( ‘Dtext’, …), .Selection( ‘Dtext’ ), .val, .Dtext, .Dtext[n].

Note: ,���H���� ����� �����

&��SINGLE ZEROSEL������������� ���!������������������������ ��� ��>� ���� �!������� ����#� �������#����H���� ������ ���#�������� �������������� ���$�

)����� ����������� ����!�������$$$$val� ���������6!�������Selection()� ����������������� ��$�������$$$$ClearSelection()� �����#� ��� ������������� ����$���� �������������� ���.val = 0������� ������#� ������������$�

������� ������ ����!������������������ ���� ������� ����������������H���� ���������$�

Command

����&����� ������������� @��������� � ��� @������ ���������!�����������������������!����!�� �������� � ������� ������>�$�� ���������������A#�������������B���#������������ ��������������� ����#� ������$��

A Summary of Objects, Members and Methods

2-76 PDMS Software Customisation Reference Manual

����������������������� ����>�������� �� ���>���������� ������������������ ������������� 8������ ������������� ����$�

.-------<---------. / | >- LIST gname -*-- tagtext --------| +-- <fgpos> --------| +-- TOOLTIP text ---| +-- CALLback text --| +-- <fganch>--------| +-- <fdock>---------| +-- CORE -----------* | .-------<-----------------------. |/ | *-- SINGle ---+-- ZEROSELection --| | '-------------------| +-- MULTiple ---------------------| +-- COLUMNS ----------------------* ‘-- <vshap> ---+-- TOOLTIP text --. '------------------‘- -->

Syntax Graph 2-8: Setting-up a LIST Object

Note: ���TOOLTIP���#�����������������#���������� �������������>$�

+��������������� ����������� � ��� ��� � ����������COLUMNS���#���!����������������������� @������ �������� �#�H��@� ��������������SINGLE ZEROSEL �� ��.�

Default: ����� ������!� ��������� ����� ���$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-77

LOCATION Object PDMS Global

Members

Name Type Purpose

Name STRING ��������� $�

Description STRING -��������!�������356����������$�

Locid STRING ���������������$�

Refno STRING STRING���������-�������������$�

IsCurrent BOOLEAN ������������������������$�

Table 2-57: LOCATION Object members

Methods

Name Result Purpose

LOCATION(DBREF) LOCATION *�������LOCATION���"��!�������DBREF$�

LOCATION(STRING) LOCATION *�������LOCATION���"��!�������� ���������� ���A/ ��� ����"����� �B$�

Dblist() ARRAY OF DB ���������DB���"��������� ������DB�$������ ������������ ��������������� ���"��$�

Sessions() ARRAY OF SESSIONS

*�������������� ��������>���������� �COMM������������������$������ ������������ ��������������� ���"��$�

String() STRING STRING������������������ $������ ������������ ��������������� ���"��$�

Table 2-58: LOCATION Object Methods

Note: ���Sessions()� ����������������� ������2���������� ���>�����$������� �����#� �������� ��������������� �������������������������� �������

A Summary of Objects, Members and Methods

2-78 PDMS Software Customisation Reference Manual

+������������������������������� �#���#�����

!D = OBJECT LOCATION(!!CE) !D = OBJECT LOCATION(!!CE.Name) !D = !!CE.LOCATION()!D = !!CE.Name.LOCATION()

&�� �����!�!!CE�������� ���������DB��������� �����!!CE.Name������STRING���"�������������� �D��� $�

���� ���������� �������������� ���� ���� ���������)������ ���������������������� �-������� �������"��$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-79

MACRO Object PDMS

Member

Name Type Purpose

Filename STRING &��@DB� ������� � �A������3L����������B$�

From DB ������DB�������@DB�������� ����$�

Number REAL &��@DB� ������ ��$�

To DB ������DB�������@-1�������� ����$�

Table 2-59: MACRO Object Members

Command

!ARRAY = MACROS $ Returns an array of all the MACRO objects in $ the project

A Summary of Objects, Members and Methods

2-80 PDMS Software Customisation Reference Manual

MDB Object PDMS

Member

Name Type Purpose

Name STRING �� �������MDB!�������:5�����������

Description STRING MDB����������!�������356�����������

Refno STRING ��������������-������������� ���

Table 2-60: MDB Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

MDB(DBREF) MDB *�������MDB���"��!�������DBREF$�

MDB(STRING) MDB *�������MDB���"��!�������� ���������� ��$�

Current() ARRAY OF DBS 0����������������������������DB���"����

Deferred() ARRAY OF DBS -����������������������������DB���"����

Mode() ARRAY OF STRINGS

*�����INR’����IRW’���������������DB�������MDB�

Table 2-61: MDB Object Methods

+������������������������������� �#���#�����

!D = OBJECT MDB(!!CE)

!D = OBJECT MDB(!!CE Name

!D = !!CE.MDB()

!D = !!CE.Name.MDB()

&�� �����!�!!CE�������� ���������DB��������� �����!!CE.Name������STRING���"�������������� �D��� $�

���� ���������� �������������� ���� ���� ���������)������ ���������������������� �-������� �������"��$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-81

Command

!ARRAY= MDBS $ Returns an array of MDB objects in the project

A Summary of Objects, Members and Methods

2-82 PDMS Software Customisation Reference Manual

MENU Object Forms and Menus

Members

Name Type Purpose

Callback STRING

/�9���

���9��������� ���������� �$�

PickedField STRING

/��� ��

*��������DTEXT������� ���������� ���� �$�

%��������� �������#�%��������� �������#�%��������� �������#�%��������� �������#��������$�%������������$�%������������$�%������������$�%����������,� ��� ��������������,� ��� ��������������,� ��� ��������������,� ��� ��������������$�����$�����$�����$����

PickedFieldName STRING

/��� ��

*���������� ��� ������� ���@������TOGGLE����CALLBACK��� �$�

Table 2-62: MENU Object Members

Methods

Name Result Purpose

Add('SEPARATOR', {STRING fieldName})

NO RESULT �������SEPARATOR��� �!�#������������ �STRING����� �!�fieldName!������������������������2���� �@� ������ �$�

Add('CALLBACK', STRING Dtext, STRING callback, {STRING fieldName})

NO RESULT �������CALLBACK��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��$�

������� ��callback����������� ������� ��$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-83

Name Result Purpose

Add('FORM', STRING Dtext, STRING formName, {STRING fieldName})

NO RESULT �������FORM����� ����� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��$�

������� ��formName!���������� ���������� ���������� ���!�#����� �����NULL����� ��������� ��$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ ��

Add('MENU', STRING DText, STRING menuName, {STRING fieldName})

NO RESULT �������MENU�A�� �����B��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��$�

menuName����������� ������ ��� !�#����� �����NULL����� ��������� ��$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

Add('TOGGLE', STRING Dtext, STRING callback, {STRING fieldName})

NO RESULT �������TOGGLE��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��$�

������� ��callback����������� ������� ��!�#����� ������������'��������$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

Clear() NO RESULT * ����� � ���� ������ ���� �$�

%��������� ��������%��������� ��������%��������� ��������%��������� ������������������������������������$�

Clear(STRING Dtext) NO RESULT * ���� ���� �����������#�������������� ������Dtext��#����$����

%��������� ��������%��������� ��������%��������� ��������%��������� �������������������������������������

A Summary of Objects, Members and Methods

2-84 PDMS Software Customisation Reference Manual

Name Result Purpose

FieldProperty(STRING menuField, STRING property)

BOOLEAN /������� ����������������� ����property�������� ���� ��� ����menuField$�

���� �#���� �������property����IACTIVE’!�IVISIBLE’!����ISELECTED’$�

FullName() STRING *����� ����"��8���� �� !�����>� � ��IPP,�� $'�D$�

InsertAfter(STRING menuField, ‘CALLBACK’, STRING Dtext, STRING callback, {STRING fieldName})

NO RESULT &������CALLBACK��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � callback����������� ������� ��$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertAfter(STRING menuField, ‘FORM’, STRING Dtext, STRING formName, {STRING fieldName})

NO RESULT &������FORM����� ����� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � formName���������� ���������� $�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertAfter(STRING menuField, ‘MENU’, STRING Dtext, STRING menuName, {STRING fieldName})

NO RESULT &������MENU�A�� �����B��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � menuName���������� ���������� $�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-85

Name Result Purpose

InsertAfter(STRING menuField, ‘TOGGLE’, STRING Dtext, STRING menuName, {STRING fieldName})

NO RESULT �����TOGGLE��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � callback����������� ������� ��!�#����� ������������'��������$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertAfter(STRING menuField, ‘SEPARATOR’, {STRING fieldName})

NO RESULT �������SEPARATOR��� ��� ���� ���������� ���� �������������menuField$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertBefore(STRING menuField, ‘CALLBACK’, STRING Dtext, STRING callback, {STRING fieldName})

NO RESULT &������CALLBACK��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � callback����������� ������� ��$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertBefore(STRING menuField, ‘FORM’, STRING Dtext, STRING formName, {STRING fieldName})

NO RESULT &������FORM����� ����� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � formName���������� ���������� $�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

A Summary of Objects, Members and Methods

2-86 PDMS Software Customisation Reference Manual

Name Result Purpose

InsertBefore(STRING menuField, ‘MENU’, STRING Dtext, STRING menuName, {STRING fieldName})

NO RESULT &������MENU�A�� �����B��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � menuName���������� ���������� $�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertBefore(STRING menuField, ‘TOGGLE’, STRING Dtext, STRING menuName, {STRING fieldName})

NO RESULT �����TOGGLE��� ��#����Dtext!�#����� ��������� � ��@�������������!�����#������������NULL����� ��!�� ���� ���������� ���� �������������menuField$�

������� � callback����������� ������� ��!�#����� ������������'��������$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

InsertBefore(STRING menField, ‘SEPARATOR’, {STRING fieldName})

NO RESULT �������SEPARATOR��� ��� ���� ���������� ���� �������������menuField$�

�������� ����������� �fieldName����� ������!��������!�����������2���� ��� ������ �$�

Name() STRING *����� ����"��8���� � �� !�����>� � ��8'�8$�

Owner() FORM *��������������#������ $�

PopupGadget() GADGET *��������� ������������������������������ �$������ ��������������� ��#�������������������������$�

Refresh() NO RESULT *������������� ��������������$�

Select(STRING Dtext, BOOLEAN status) NO RESULT ������� ��������������TOGGLE��� �������������Dtext��������� �����status$����

%��������� �������%��������� �������%��������� �������%��������� ���������������������������������������$$$$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-87

Name Result Purpose

Selected( STRING Dtext ) BOOLEAN /��� �����������������TOGGLE��� �������������Dtext$�

%��������� ��������%��������� ��������%��������� ��������%��������� ������������������������������������$$$$�

SetActive(STRING Dtext, BOOLEAN active)

NO RESULT ������������������������� ���� �������������Dtext$����

%�%�%�%��������� ���������������� ���������������� ���������������� ������������������������������������$$$$�

SetFieldProperty(STRING menuField , STRING property, BOOLEAN value)

NO RESULT �������� �����property�#����value!�������� ���� �������������menuField$�

���� �#���� �������property����IACTIVE’!�IVISIBLE’!����ISELECTED’$�

1������������ �#���������� ������#�����������SEPARATOR��� �$$�

Table 2-63: MENU Object Methods

Note: ���������Active����Visible���������������SEPARATOR��� ��#� ����������� � �������������� ����� ����������SEPARATOR��� ������ �����2����� ������������������ ��������>��SEPARATOR��� �$�

,�������������Add()� ����������!������������������ ��� �@������������������������ ����� �����������@�����$$�0�*�SEPARATOR!�0�*�CALLBACK!�0�*�FORM!�0�*�MENU!����0�*�TOGGLE$�

+����������������������� ��������������������@ ������� ��$�

Command

MENU���"��������#�����FORM���"���!���������������#�������� ������ ��$�&������ ��������� ����������#� �������>��������� �@����� ���������>��������������� ��$�

A Summary of Objects, Members and Methods

2-88 PDMS Software Customisation Reference Manual

������ ���#������������� ����������� ��!������� ��#�������� ������ ��!�����

!menu = !this.newmenu( ‘Menu1’, ‘MAIN’ ) !menu.add( ‘CALLBACK’, ‘save’, ‘<callback>’, ‘field1’ ) !menu.add( ‘FORM’, ‘save as…’, ‘saveForm’, ‘field2’ ) …

Note: ����� ���������������������'��� ������ ��������������������� ������ !����������� ����������$�

&������������������POPUP����MAIN����������� !������� �D��������������� �����#$�������� �#� ���� �������������������������� ������������������������������ �$�

'��������'������� ����� ����������$��������!��� ������� � ��������������@ ��������� � ��$�

'������������������ � ���������� ���������������������!����� ��������������� ���������������$�

�� ��������������� �!����������� ��������� �������������������#��� ������������ ��������������� ���������#� ����$�

+���������� ���� ���#��+���������� ���� ���#��+���������� ���� ���#��+���������� ���� ���#������������ ��� ����������� ��� ����������� ��� ����������� ��� �@@@@� $�&������������� $�&������������� $�&������������� $�&����������������������� ������������ ������������ ������������ �@@@@� !��������#� �������� �������������� ���� !��������#� �������� �������������� ���� !��������#� �������� �������������� ���� !��������#� �������� �������������� ���$�

+���������������� ��� �@������������������������ ����� �����������@�����$$�0�*�SEPARATOR!�0�*�CALLBACK!�0�*�FORM!�0�*�MENU!����0�*�TOGGLE$�

+����������������������� ��������������������@ ������� ��$�

��� �������������������MENU��� ��!��� �#�������� �D��ADD��� ��������� �����������EXIT��� ��$������ �����>�������#�� �#��

>-- MENU -- gname –+- POPUP –-. .--------<------- . +- MAIN --| / | ‘----------‘-+- NL -+- <fmenu> - | +- PML ----- * +- EXIT –--- . ‘----------- ‘-->

Syntax Graph 2-9: Defining a Menu

.-----<-----. / | fmenu>-+- ADD -+- fieldname -| +- CORE ------* +- SEParator ---------------------- ---------. ‘- dtext -+- rtext ---------------- ---------| +- MENU -- gname -------- ---------| +- FORM -- fname -------- ---------| +- CALLback –+- rtext --- ---------| | ‘----------- ---------| ‘- TOGgle –+- rtext –. | ‘---------+- S ELected -| ‘--- ---------‘-->

Syntax Graph 2-10: Using Menu,Add()

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-89

OBJECT All

Method

Name Result Purpose

GetPathName() STRING �>��������������� ��������� ������PMLLIB����������$�

Table 2-64: PML Object Methods

A Summary of Objects, Members and Methods

2-90 PDMS Software Customisation Reference Manual

OPTION Object Forms and Menus

Members

Name Type Purpose

Val REAL

/�9����

� ����������� ��$�

DText ARRAY OF STRING

/�9���

���������������� ����������� ����>��$�

DText[n] STRING

/��� ��

/��������� ����>��������n8��������$�

RText ARRAY OF STRING

/�9���

������������ ��������� �� ���>��$�

RText[n] STRING

/��� ���

/������� �� ���>��������n8��������$�

Table 2-65: OPTION Object Members

Methods

Name Result Purpose

Clear() NO RESULT 0 ��������D�������$�

ClearSelection() NO RESULT 0 ����� ��������������������� ������������� ���$�

FullName() STRING /������� �������� !�$�$8PP,�� $�����8�

Name() STRING /����������8��� !�$�$�8�����8�

Owner() FORM /���#������ $�

Select(STRING text, STRING value ) NO RESULT � ������������� ����� ������ext� ������I*�>�D����I-�>�D!����value��������� ������� ���$�

Selection() STRING /��������� ����D��RTEXT$�

Selection(STRING text ) STRING /��RTEXT����DTEXT������������ ����?�text� ������I*�>�D����I-�>�D$��

SetPopup(MENU menu) NO RESULT �����menu�#�����������������������$�

Refresh() NOT RESULT *������������� ��������������$�

SetFocus() NO RESULT '������������������������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-91

Name Result Purpose

RemovePopup(MENU menu) NO RESULT * ����A�����B�menu���� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /�������������������������$�

Table 2-66: OPTION Object Methods

Command

���OPTION��� �������������������������������������������!����������> ��!������ ������>��������������A��� ���������B������$�� ����������#������ �#���������� �������� �����������#��������������� ���$�

����������������������� ����>�������� �� ���>�������������������� ��������������� 8������ ������������� ����$�

.-------<---------. / | >-- OPTion gname --*-- tagtext --------| +-- <fgpos> --------| +-- <fganch> -------| +-- <fgdock> -------| +-- CALLback text --| +-- TOOLTIP text ---| +-- CORE -----------* +-- WIDth integer -----. ‘-- PIXmap-+- <vshap> -| ‘-----------+-- TOOLT IP text --. ‘-------- ----------‘-->

Syntax Graph 2-11: Setting Up an OPTION Object

Note: &��������������������� �������������������������$������ ��� ������������������������$�

A Summary of Objects, Members and Methods

2-92 PDMS Software Customisation Reference Manual

ORIENTATION Object PDMS

Members

Name Type Purpose

Alpha REAL

/�9���

���� ������ ���$�

Beta REAL

/�9���

���1����� ���$�

Gamma REAL

/�9���

���/� ���� ���$�

Origin DBREF

/�9���

���DB� ��#����������������$�

Table 2-67: ORIENTATION Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Orientation( STRING) ORIENTATION 0�������ORIENTATION���� ������ ������$�

Orientation( STRING, FORMAT ) ORIENTATION 0�������ORIENTATION���� ������ ������!��������������FORMAT.�

EQ(ORIENTATION) BOOLEAN TRUE����ORIENTATIONS����2�� $�

LT(ORIENTATION) BOOLEAN TRUE����ORIENTATION���� ����������� �$�

String(FORMAT) STRING 0�����ORIENTATION������STRING.�

WRT(DBREF) ORIENTATION 0����������#�ORIENTATION�#�����������������DB� �$�

XDir() DIRECTION *����X��� ���������DIRECTION$�

YDir() DIRECTION *����Y��� ���������DIRECTION$�

ZDir() DIRECTION *����Z��� ���������DIRECTION��

Table 2-68: ORIENTATION Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-93

PARAGRAPH Object Forms and Menus

Members

Name Type Purpose

Val STRING

/�9���

������������8���>��� ����������������$�

&�������������> ����������� ��#� ����������� ���������> ����� �����������$�

Background REAL

/�9���

���������1���������0� ������ ��$�

Background STRING

/�9���

���1���������0� ������ $�

Methods

Name Result Purpose

AddPixmap(STRING)

AddPixmap(STRING, STRING)

AddPixmap(STRING, STRING, STRING)

NO RESULT �������> ���������������������� ���!�� �������������������$��

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /���#������ $�

SetPopup (MENU) NO RESULT ������������ ��#�����������������������$�

RemovePopup(MENU) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /�����GADGET���������������.�

Command

���PARAGRAPH �� ������������������������������������������!��� �����A�������������������#��������� ��������B!���!������� �������>���������> ��$��������������������������������������������D���� ��������������$�������������������������������!������������������ ���$�

A Summary of Objects, Members and Methods

2-94 PDMS Software Customisation Reference Manual

+�������������PARAGRAPH������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

.--------------------<------ ------. / | >-- PARAgraph gname -+-- <fgpos> ------------------ ------| +-- BACKGround <colno> ------- ------| +-- <fganch> ----------------- ------| +-- <fgdock> ----------------- ------| +-- CORE --------------------- ------* Core managed gadget +- PIXMAP -+- filename -. | ‘------------‘-<vsh ap>--> ‘- TEXT text -+-<vshap>-. ‘---------‘-->

Syntax Graph 2-12: Setting Up a PARAGRAPH Object

Note: &���������������������������>�!�������������#� ����������������������$����������������� ������ �������>��������#�������������� �������������������� ��������������2����$������ ����� ���������������� ������� ���!���������������#�������������H���������������� �����������#����!�#�������������� ��� � ��������� ������������������������$�+��� ������������������#�>������������������������������������� �������$�

&����������������������>�!�������� ���������������!������� ���������� � �����#�����A�����������B�2�� �������� �������>�����������$������ �������� �����������������������������������������!�������� ���������������#����>���������������������������$��

&����������������������������� ��������� ������>�!����� ������������������� �����$�����>�!�#��������������# �����������!�#� ���"��������������������$�

&������> �������������!��������������������� ��������������#� �������> �$�* ���������������> ��������������������8��AddPixmap()� ������������$Val� ��$�

&����������������������������������� ��������������>�������> ����� �#�� ���� � �������������������� 8������ ������������� ����!�����������������������������$��

&��������������������� �������������������������$������ ��� ������������������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-95

PLANE Object 3D Geometry

Members

Name Type Purpose

Orientation ORIENTATION

/�9���

������������� �$�

Position POSITION

/�9���

���������� �$�

Table 2-69: PLANE Object Members

Definition Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Plane(POSITION, ORIENTATION) PLANE 0�������PLANE�#�����������POSITION����ORIENTATION$�

String() STRING *��������� ������������$�

Direction(DIRECTION) DIRECTION Z��� ��������������������������������-'�� �������� ��������X����Y��� �������������������$�

Towards(POSITION) NO RESULT '������������������AZ��� ������������������B� ���������� �������������������������������$�

Table 2-70: PLANE Object Definition Methods

Position

Direction(DIRECTION)

Towards(POSITION)

X

Y Z

Orientation

A Summary of Objects, Members and Methods

2-96 PDMS Software Customisation Reference Manual

Figure 2-V: PLANE Object Definition

PLANE Object: Methods that Return POSITIONs

Name Result Purpose

Intersection(LINE) POSITION *���������������������������������������� �������� ���������$�

Intersection(POINT

VECTOR)

POSITION *��������������������������������������������������� ���������$�

Intersections(ARC) ARRAY OF POSITIONS

*�������������������������������������������� ���������$�

Intersection(PLANE, PLANE) POSITION *��������������������������������� ��$�

PointVector() POINT-

VECTOR

*������������������������������������� ��#��������������2�� ��������� � �������� �$�

ThreeDPosition( XYPOSITION)

POSITION *�����3D���������������XYPOSITION���������� ����� �������$�

Near(POSITION) POSITION *��������������������������� �����������������������������$�

Table 2-71: PLANE Object Methods that Return POSITI ONs

Intersection(LINE) Intersection(PLANE, PLANE)

Near(POSITION) ThreeDPosition(XYPOSITION)

�Figure 2-W: POSITIONs returned by PLANE Object Meth ods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-97

PLANE Object: Methods that Return LINEs

Name Result Purpose

Line(REAL) LINE *������� ������������ ������������������������ ���� � $�

Intersection(PLANE) LINE *����������������� ��������������� �������� ���������$������������������������ ��������������������� �������������"������������������ �$������������������ �������� ������������������������������������� �����"����������������� �$�&��������������������������������!��� ����� ����3666 ����������#���������������������������������������������$�

Table 2-72: PLANE Object Methods that Return LINEs

Intersection(PLANE)

�Figure 2-X: LINEs Returned from PLANE Object Method s

A Summary of Objects, Members and Methods

2-98 PDMS Software Customisation Reference Manual

PLANE Object: Methods that Return XYOffsets

Name Result Purpose

XYOffset(Position) XYPOSITION *���������������!� ������������� �!����� ������XY���������� ����� �������$�

Table 2-73: PLANE Object Methods that Return XYOffs ets

XYOffset(POSITION)

�Figure 2-Y: XYPositions Returned from PLANE Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-99

PLANTGRID Object Construction Aids

Members

Name Type Purpose

Position POSITION

/�9���

����������������$�

Orientation ORIENTATION

/�9���

�������������������$�

XSpacings REAL ARRAY

/�9���

��������������������X��������!�������������� ������������������$�

YSpacings REAL ARRAY

/�9���

��������������������Y��������!�������������� ������������������$�

Table 2-74: PLANTGRID Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

Plantgrid(POSITION, ORIENTATION, ARRAY, ARRAY )

PLANTGRID 0������������#�����������POSITION����ORIENTATION!�������X����Y����������������������������$�

Xsize() REAL '�>� � ���H������X��������$�

Ysize() REAL '�>� � ���H������Y��������$�

OutofBounds(POSITION) BOOLEAN *�����#���������� ���#���������������������$�

Table 2-75: PLANTGRID Object Methods

Ysize()

X

Y

Z

Orientation

Xsize() XSpacing

YSpacing

Position

�Figure 2-Z: Return Values from PLANTGRID Object Met hods

A Summary of Objects, Members and Methods

2-100 PDMS Software Customisation Reference Manual

POINTVECTOR Object 3D Geometry

Members

Name Type Purpose

Direction DIRECTION��

/�9��

-���������������

Position POSITION��

/�9��

��������������

Table 2-76: POINTVECTOR Object Members

Definition Methods

Name Result Purpose

Pointvector( POSITION, DIRECTION) POINTVECTOR 0�������POINTVECTOR�#�����������POSITION����DIRECTION�

String() STRING *�������POINTVECTOR�����������$�

Table 2-77: POINTVECTOR Object Methods

Position

Direction

�Figure 2-AA: POINTVECTOR Object Definition

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-101

Methods that Return POINTVECTORs

Name Result Purpose

Offset(REAL) POINTVECTOR *����������������������������������������������������������

Towards(POSITION) POINTVECTOR *�������������������#������������� ������������������������������������ ���������������������������������������

Through(POSITION) POINTVECTOR *��������������������������������������������� ��#������� ���� � ������������ ���������������������������

Table 2-78: POINTVECTOR Object Methods that Return POINTVECTORs

Through(POSITION) Offset(REAL)

Towards(POSITION) �

Figure 2-BB: POINTVECTORs Returned from POINTVECTOR Object Methods

Methods that Return POSITIONs

Name Result Purpose

Intersection(POINTVECTOR) POSITION *������������������������������������������$�

Intersection(LINE) POSITION *������������������������������������������#����������� ��� �$�

Intersection(PLANE) POSITION *������������������������������������������������#����������� ���� ��

Table 2-79: POINTVECTOR Object Methods that Return POSITIONs

A Summary of Objects, Members and Methods

2-102 PDMS Software Customisation Reference Manual

Intersection(PLANE)

�Figure 2-CC: POINTVECTOR Intersection with a PLANE

Miscellaneous Methods

Name Result Purpose

Intersections(ARC) ARRAY OF POSITIONS

*�������������������������������������������������#����������� ������$�

Plane() PLANE *�������� ��#������������2�� ��������������������������������������� � ���������2�� �������������������������$�

Line(REAL) LINE *������� ��#��������������������2�� �������������������������������!�����������2�� ������������������������������������� ����2�� ����������� ��� ���$�

Table 2-80: POINTVECTOR Object Miscellaneous Method s

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-103

POSITION Object PDMS

Members

Name Type Purpose

East REAL

/�9����

���������� ���$�

North REAL

/�9���

����������� ���$�

Up REAL

/�9���

���%���� ���$�

Origin DBREF

/�9���

���-1� ��������������������

Table 2-81: POSITION Object Members

Methods

Name Result Purpose

Position(STRING ) POSITION 0�������POSITION�����������������������STRING$�

Position(STRING, FORMAT) POSITION 0�������POSITION�����������������������STRING!�#���������������FORMAT$�

Component(DIRECTION) REAL '������������ ��������������DIRECTION.�

EQ(POSITION) BOOLEAN TRUE����POSITIONS��������� $�

LT(POSITION) BOOLEAN TRUE����POSITION���� ����������� �$�

String(FORMAT) STRING 0�����POSITION������STRING.�

WRT(DBREF) POSITION 0����������#�POSITION�#�����������������DB� �$�

Angle (POSITION, POSITION) REAL *���������� ���#�����������#���������������������������"��$�

ArcCentre(POSITION, POSITION, POSITION, DIRECTION, REAL )

ARC *����������������������������2�$������������������I�� � ���#��D��������$�

ArcCentre(POSITION, POSITION, POSITION, DIRECTION, REAL)

ARC *����������������������������2�$������������������I�� � ���#��D��������$�� ����������� ������� �>� �����$�

Table 2-82: POSITION Object Methods (a)

A Summary of Objects, Members and Methods

2-104 PDMS Software Customisation Reference Manual

POSITION B

POSITION X POSITION A

RADIUS

�Figure 2-DD: !Arc = !posX.ArcFillet(!posA,!posB,!di r,!radius)

Name Result Purpose

ArcFillet( POSITION, POSITION, DIRECTION, REAL )

ARC *����������������������������2�$������������������I�� � ���#��D��������$�� ����������� ������� �>� �����$���

ArcRadius( POSITION, POSITION, DIRECTION, REAL, BOOLEAN )

ARC *�������������������������������2�$������������������I�� � ���#��D��������$������� ��� ������� ���AFALSEB���� �"��ATRUEB�����$� ����������� ������� �>� �����$�

Table 2-83: POSITION Object Methods (b)

RADIUS

POSITION B

POSITION A

POSITION X

MAJOR = FALSE

�Figure 2-EE: !Arc = !posX.ArcRadius(!posA,!posB,!di r,radius,!major)

Name Result Purpose

ArcThru( POSITION, POSITION, DIRECTION )

ARC *����������������������������:�����������2�$������������������I�� � ���#��D��������$�� ����������� ������� �>� �����$�

Table 2-84: POSITION Object Methods (c)

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-105

POSITION X POSITION A

POSITION B �

Figure 2-FF: !Arc = !posX.ArcThru(!posA,!posB,!dir)

Name Result Purpose

ArcThru( POSITION, POSITION, DIRECTION, REAL )

ARC *����������������������������:���������������������2�$������������������I�� � ���#��D��������$�� ����������� ������� �>� �����$�

Table 2-85: POSITION Object Methods (d)

POSITION X

POSITION A

POSITION B

POSITION X

RADIUS

�Figure 2-GG: !Arc = !posX.ArcThru(!posA,!posB,!dir, !radius)

Name Result Purpose

Arc3Lines( LINE, LINE, LINE, DIRECTION )

ARC *����������� ������������:� ������������$����8����8��������������������H����#������������ � ��$��

Direction(POSITION) BOOLEAN *������������������#���������������������� �����������

Distance(ARC) REAL *�����������������#������������������������������������� ���������������������������

MidPoint(POSITION) POSITION *�������� ����������#�����#�����������

A Summary of Objects, Members and Methods

2-106 PDMS Software Customisation Reference Manual

Name Result Purpose

Near(POSITION, REAL) BOOLEAN *��������������������������������#������������������������ ��������������"���

Offset(DIRECTION, REAL) POSITION *������������������������������� ��� ������������� �����������

Plane(POSITION, POSITION) PLANE *�������� ����#������������������� ��������� �$�

Distance(LINE) REAL *�����������������#��������������������������������������������� ����������

Distance(PLANE) REAL *�����������������#���������������������������������������� ����������

Distance(POSITION) REAL *�����������������#�����#�����������

Line(POSITION) LINE *������� ����#�����#����������!�������������������������"���

MidPoint(POSITION) POSITION *�������� ����������#�����#�����������

Near(POSITION, REAL) BOOLEAN *��������������������������������#������������������������ ��������������"���

Offset(DIRECTION, REAL)

POSITION *������������������������������� ��� ������������� �����������

Plane(POSITION, POSITION) PLANE *�������� ����#������������������� ��������� �$�

Table 2-86: POSITION Object Methods (e)

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-107

POSTEVENTS Object PDMS

������� ������������PostEvents���"��!�#��������� ������������ ��������������� �#$�

����������������!����� ������������ ��� ���"�������������������� ����!!postEvents$�

��� �����!!postEvents.postMark�#� ����� �������� �������� ���������!�������������� ���������������������������$�

�������������� ������ �!�#����������������MARKDB��� ��!�������� ���"������#���������������� ���$�

��� � �� �!���� �����postUndo�#� ����� ���������UNDO������������!��������$������� �����#� �����������STRING���"��������������� ������� ����#����#�������� ���!����!��������������������$�

Methods

Name Result Purpose

postMark(STRING) NO RESULT 0� �������������� ���������������������������$�STRING������������������>������������#������������ ���"��$�

postUndo (STRING) NO RESULT 0� ������������������������$�STRING������������������>������������#������������ ���"��$�

postRedo(STRING) NO RESULT 0� ������������������������$�STRING������������������>������������#������������ ���"��$�

postClearMark() NO RESULT 0� ���������clearMark�������������

postClearAll() NO RESULT 0� ���������clearAll������������$�

Table 2-87: PML PostEvents Object Methods

A Summary of Objects, Members and Methods

2-108 PDMS Software Customisation Reference Manual

PROJECT Object PDMS

Members

Name Type Purpose

Name STRING� ���� ����������"��!�������356����������$�

Evar STRING� ���"������� �������� !�$�$���'666�

Methods

Name Result Purpose

Active() REAL �� ��������������������������"���

Code() STRING ���"������!��������������!�$�$���'�

Description() STRING ���"������������!�������356����������$�

Mbcharset() STRING '� ������������������� ���

Message() STRING ���"��� �����A���� �����������������"��B!�������356����������$�

Name() STRING ���"���� �

Number() STRING ���"���� ��!�������3L����������$�

Isglobal() BOOLEAN )��������"��������� ��� ����"��$�

Locations() ARRAY OF LOCATION

*�������������� ���������������"���

CurrentLocation() LOCATION *�������������� �������

Sessions() ARRAY OF SESSIONS

*�������������� ��������A������������ ������B�

CurrentSession() SESSION *����������������A������������ ������B�

Dblist() ARRAY OF DB OBJECTS

�������������������������"��$�

MDBList() ARRAY OF MDBS

*�������������� �MDB�������"������������ ������$�

UserList() ARRAY OF USERS

*�������������� �USER�������"������������ ������$�

Macros() ARRAY OF MACROS

*�������������� �&��@��� ��������MISC���������"������������ ������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-109

Name Result Purpose

Messages() ARRAY OF STRINGS

*�������������� � ��������MISC������������� ������$�

Commands

!ARRAY = PROJECTS $ Returns an array of all PROJECT objects $ which have project environment variables set.

!PROJECTVAR = CURRENT PROJECT $ Returns the current project object.

A Summary of Objects, Members and Methods

2-110 PDMS Software Customisation Reference Manual

PROFILE Object 3D Geometry

Members

Name Type Purpose

Position POSITION

/�9���

�������������� �

Orientation ORIENTATION

/�9���

����������������� �� ��

Pointer POINTER

/��� ��

-��������������� �

Table 2-88: PROFILE Object Members

Methods

Name Result Purpose

Profile(POSITION, ORIENTATION, ARRAY)

PROFILE 0������������ ���"��$���������ARRAY���������������LINE�!�ARC�����POSITION�$������������ ��������#� ��������$�������� ��� ����������� ���������� �!�����#������#� ��������$�

Profile(DBREF) PROFILE 0������������ ���"������ ���LOOP!�PLOO!�PALJ����SPINE$������>� �� ����� ���POGO!�BOUN!�DRAW$�

3D� ������ ����ASPINE!BOUN!�DRAW!PALJB����� ����������� �� �$��&��������������"����������� ��������������������#������������� �$�

Profile(DBREF1,DBREF2) PROFILE 0������������ ���"������ �SPRO����SLOO����DBREF1$�DBREF2������������ ���������������� ���� ����������������� ������� ��������������������������� ���$�

Profile(PROFILE) PROFILE 0������������ ���"���#������������������������������ �

Plane() PLANE *��������PLANE�������������������� $���������2���� ��������PLANE� �������LINEARGRID���"���

PsClosed() BOOLEAN *������������ ����

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-111

Name Result Purpose

PsValidClosed () BOOLEAN *�������������������� ������ ��������� �������#������� �������GML!�$�$����������� �@��������������

Sense() BOOLEAN ����������@� ���#���A������� �B$�*������������������ �������� ����

Area() REAL &��� ������������� $�*������������������ �������� ����

Length() REAL *���������� � �� ��������������� $��

IsCircle() BOOLEAN *����������������� �������� ����� $�

IsFillet(REAL) BOOLEAN *��������������������������REAL����� ��������� �$������ �� ������������#������������������ ��������������� �����������#����������"���������������� ��!������������ �����������$�

Table 2-89: PROFILE Object Methods

Figure 2-HH: Finding the Length of thje PROFILE Obj ect

.length(<position>, <position>, true) �

.plane() �

A Summary of Objects, Members and Methods

2-112 PDMS Software Customisation Reference Manual

PROFILE Object Decomposition and Display Methods

Name Result Purpose

edges() ARRAY *�������������� ���������������������������� $������������������������ ��������������� ������$�

&���������� �������� ����� �� ������� ��� ����� ������������������� ����������� ������������������� $�

numberEdges() REAL *��������� ����������#������������� �AO�������@3B�

edge(REAL) LINE/ARC *������������� � ����������������>�����������������

dbWrite(DBREF) PROFILE ���� ����DBREF�#��������������������� $�&������� ����� �����>������������� ����#������������ ��� ���$������� ������������������#��������������������������������� �$�����DBREF� �����������LOOP!�PLOO!�PALJ!�SPINE!�BOUN!�DRAW!�POGO$�*�������� ��� ������$��

����#�������LOOP����PLOOP���������������������#������������ $��������� ���������������������� ���������� �����������������#��������������������$�

���� ������������ ������ �������������������

draw(REAL1, REAL2, REAL3) PROFILE -��#���������� ���������������� ����������$��REAL1��������� ��� ���������#���$��REAL2����������� ��������� �$��REAL3���������� ������������ �$$��������#���������������2�������� ���� ���������AID��� �����������$�

LINE����ARC���"����� ����������$���#� ������ � ���

Table 2-90: PROFILE Object Decomposition and Displa y Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-113

PROFILE Object Transformations and Modification Met hods

���� ������������� ������������������������ ����������

Name Result Purpose

mirror(LINE) PROFILE '����������������������������������������� �!�#�� ��������������������� ��

translate(REAL1,REAL2) PROFILE �������������������������������XY���������������� ��#���������������>����REAL1���������REAL2�

rotate(REAL, XYPOSITION) PROFILE *����������������������������������XYPOSITION������������� $��� �������@� ���@#������������Z��>����������������� ��

close() PROFILE 0 ������������ �#�������������� ����A���������B$�&��������#��������� �������������������"�����

reverse() PROFILE *���������������������� ����������������������

mergearcs(REAL1, REAL2) PROFILE '���������������������������������������� �>� � ������� ����REAL1�������������������� ����REAL2���Mergearcs()�#� �� ��������������������������������� ����# $�

mergearcs() PROFILE '�������������������������������$�

mergelines(REAL) PROFILE '����� �������������� ����������������������� �������� ��$�Mergelines()�#� �� ����� ������������������������� ����# $�

mergelines() PROFILE '����� �������������� ��������$�

mergpoints(REAL) PROFILE * ���������������������������������������� �������� ���

mergepoints() PROFILE * ��������������������������

polyline(REAL) PROFILE *� ��������#������������ ������>� ������������� �������� ���

A Summary of Objects, Members and Methods

2-114 PDMS Software Customisation Reference Manual

Name Result Purpose

polyline() PROFILE *� ��������#������������ �������>� �����

projectArcs(REAL) PROFILE * ����� ������������ �����������!�� �� ����������������@ �����$������#������ � �������������� ������� ����������$���������������� ��������� ����������"���������� ������������ ��������������������$�������#������ �������������3Q6����������� ������� ��

Table 2-91: PROFILE Object Transformations and Modi fication Methods

Figure 2-II: Transformations and Modifications by P ROFILE Object Methods

.rotate(<xyposition, <real>) �

.mirror(<line>) �

.offset(<real>,<real>)

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-115

PROFILE Object Methods that Query Position Relation ships

���� ������ ��������������������������������� �� �!������������� ������������������ �������� ���������

Name Result Purpose

Near(POSITION) POSITION *������������������������������� !����������������������"���������������� �� �$�

Near(REAL,POSITION) POSITION ���REAL����� ���������>������������������� $��*����������������������������������POSITION����� ��$��������������� ����.near(POSITION)���������������������� ���$�

NearEdges(POSITION) ARRAY *������������������������������������������������POSITION$�������������� ������������������ $������#� ���������������������������������>$�

IsWithin(POSITION) BOOLEAN *�����TRUE���������������#�� ������������������ �� �� ���������������� $���������� � ������� ���$�

IsWithout(POSITION) BOOLEAN *�����TRUE���������������#�� ������������������ �� �� ������������������ $��������� � ������� ���$�

OnProfile(POSITION) BOOLEAN *�����TRUE���������������A ����������������� �� �B� ������������� ��� ���$�

Table 2-92: Profile Object Methods that Query Posit ion Relationships

A Summary of Objects, Members and Methods

2-116 PDMS Software Customisation Reference Manual

Figure 2-JJ: POSITION Relationships for PROFILE Obj ects

PROFILE Object Methods that Query Profile to Profil e Relationships

���� ������������������������� �����������#��*�,&���$�

Name Result Purpose

IsWithin(PROFILE) BOOLEAN �������������� �������� � ���#�� ��#������������� ������"��$�1��������� �� ������� ���$�

IsWithout(PROFILE) BOOLEAN �������������� �������� � ����� � � ����������������� ���"��$�1��������� �� ������� ���$�

IsIntersecting(PROFILE) BOOLEAN �������������� �������� ����������������� ���"��$�1��������� �� ������� ����

Table 2-93: PROFILE Object Methods that Query Profi le to Profile Relationships

PROFILE Object Intersection Methods

���� ������������������������� ��������������������������#�����"�������������� $������������������������������������>��� ��������"����������#������������������ !�����#�������� ����������������#� �����������������$�

Name Result Purpose

intersections(LINE) ARRAY OF POINTS

*���������������������������������������#������ ��A���������"����������� ���������� ������������� B����������������� $�� ������������>���������� ����������$�

.near(<position>)�

.onProfile(<position>)�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-117

Name Result Purpose

intersections(ARC) ARRAY OF POINTS

*���������������������������������������#����������A���������"����������������������� ������������� B����������������� $����� ������������ ���������� �#�������� ������������� �����#����������#� ������$���������������#������������ �����������A������ � �����������#�����������B�

intersections(PROFILE) ARRAY OF POINTS

*����������������������#�����������������#�������#������� ��������$$�����#������� �� ���������� �A������@���� B�������������

Table 2-94: PROFILE Object Intersection Methods

Figure 2-KK: Intersections of PROFILE Objects

.intersection(<line>)

.intersection(<profile>) .isWithin (<position>)

$�� ��AJ �KB��

.intersection(<arc>)

A Summary of Objects, Members and Methods

2-118 PDMS Software Customisation Reference Manual

PROFILE Object Methods that Return New PROFILEs

���� ��������������������������#������ �$�����#������ ������ ������������� ��������������� ���"��!�>���������I�� �D�������������������$���������� �� ���� ��������� �� ��������!�������������� �������������� ����������������������$�

Name Result Purpose

intersect(PROFILE) ARRAY OF PROFILES

*�������������������� ������������������ ��

union(PROFILE) ARRAY OF PROFILES

*�������������������#������� �$�.� �������������������������� ��A��������������B�

difference(PROFILE) ARRAY OF PROFILES

*�������������������������������� ���������������� ���������

split(LINE) ARRAY OF PROFILES

*����������� ��������� ����� ����"�������������� �������������� ������ ����������������� ���

split(PLANE, BOOLEAN) ARRAY OF PROFILES

*����������� ���������������� ��� �������������� ������ ������������������������������ ������������� �� �$������������������������������ ���BOOLEAN$�&��������TRUE����� ������� ����������������������� � �������������� ����������?�����������FALSE!�� �����������������������������@�� � $�

Table 2-95: PROFILE Object Methods that Return New PROFILEs

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-119

Figure 2-LL: PROFILEs Returned from PROFILE Object Methods

.union(<profile>)

.intersect(<profile>)

.difference (<profile>)

.split(<line>)

A Summary of Objects, Members and Methods

2-120 PDMS Software Customisation Reference Manual

RADIALGRID Object Construction Aids

RADIAL GRID Object Members

Name Type Purpose

Position POSITION

/�9���

����������������$�

Orientation ORIENTATION

/�9���

�������������������$�

Radii REAL ARRAY

/�9���

*���������������$�

Angles REAL ARRAY

/�9���

��� ���������!���� �E��>��AH��B$�

Table 2-96: RADIALGRID Object Members

RADIALGRID Object Definition Methods

Name Result Purpose

Radialgrid( POSITION, ORIENTATION, ARRAY, ARRAY)

RADIALGRID� 0������������#������������������������������!��������� ������������������������������$�

Table 2-97: RADIALGRID Object Definition Methods

Position

X

Y Z

Orientation

Radii

Angles

�Figure 2-MM:RADIALGRID Object definition (a)

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-121

Snap(POSITION)

GridPoint(REAL, REAL)

Snap(LINE)

RadialPosition(REAL, REAL)

Angle[1]

Radius[1] Radius[2] Radius[3]

�Figure 2-NN: RADIALGRID Object Definition (b)

A Summary of Objects, Members and Methods

2-122 PDMS Software Customisation Reference Manual

REAL Object PML Built-in Type

Methods

Name Result Purpose

Real( BOOLEAN ) REAL 0�������REAL���� ��������BOOLEAN��TRUE�O�3!�FALSE�O�6$�

Real( BORE ) REAL 0�������REAL���� ��������BORE.�

Real( STRING ) REAL 0�������REAL���� ��������STRING.�

Real( STRING, FORMAT ) REAL 0�������REAL���� ��������STRING����������������� ��.�

ABS() REAL ���� ����� ��A ����� ���������B.�

ACos() REAL ACOS.

ALog() REAL ALOG.

ASin() REAL ASIN.

ATan() REAL ATAN.

ATanT(REAL) REAL ATANT.

Between(REAL, REAL ) BOOLEAN TRUE������ �� ������������������� ������� ����������.�

Boolean() BOOLEAN FALSE������ �����H��!�����#���TRUE.�

Bore() BORE 0��������BORE�A ������>���B��������������BORE�����.�

Cosine() REAL COSINE.

Dimension() STRING /����� ���������� �.�

Distance() STRING 0�������������������������� ��������.�

Distance( BOOLEAN feet, BOOLEAN us, BOOLEAN fraction, REAL precision, BOOLEAN zeroes)

STRING 0��������������������������N������������A����#�������B?�����%����� ���������A����#����-'����� ��B?������������������������A����#������ � �B?���������������� �������� �������������������� � �� ���?���������H�������H����A����#����� B.�

EQ(BORE) BOOLEAN 0� ��������������������BORE�����.�

EQ(REAL) BOOLEAN TRUE����2�� .�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-123

Name Result Purpose

GEQ(BORE) BOOLEAN 0� ��������������������BORE�����.�

GEQ(REAL) BOOLEAN TRUE�����������������2�� ������������ �.�

GT(BORE) BOOLEAN 0� ��������������������BORE������

GT(REAL) BOOLEAN TRUE���������������������� �.�

INT() REAL 0��������#�� �� ��!����������#.�

LEQ(BORE) BOOLEAN 0� ��������������������BORE�����.�

LEQ(REAL) BOOLEAN TRUE���� ����������2�� ������������ �.�

LOG() REAL LOG .

LT(BORE) BOOLEAN 0� ��������������������BORE�����.�

LT(REAL) BOOLEAN TRUE���� ��������������� �.�

NearestBore() BORE 0�������������BORE��������������BORE�����������.�

Nint() REAL 0�������������#�� �� ���A��������#B.�

Power(REAL) REAL *������ �������#�.�

Real() REAL 0��������REAL�A�������������� ��������B.�

SBetween( REAL,REAL)

BOOLEAN TRUE������ �� �����������������>� ������� ����������.�

Sine() REAL SINE.

Sqrt() REAL �2�������������� �.�

String( STRING precision)

STRING 0��������STRING�#�������������������������STRING����������ID0’����ID6’.�

String(FORMAT) STRING 0��������STRING���������������� ��� �FORMAT���"��.�

Tangent() REAL TANGENT.

Table 2-98: REAL Object Methods

A Summary of Objects, Members and Methods

2-124 PDMS Software Customisation Reference Manual

REPORT Object Collection and Report

�����������"���������������� ��������� ���"���������������� ���������������������� ����������!���� ���������� $���������������� ���������>���������������������� ������ �� �#������������������������������ ������ ���������� $�

���������>������������������ ���TABLE������� ���������������� � ���������������������������COLUMNFORMAT���"��$�+��� ��������� ��������������� ����#��#���������������������MATCH�������A#����� ������ �����������@����B����� ������ ����������������������$�

������ ��� �����>��������

• � ������!���������Results()� �����?�

• ����������� ������������������ !���������NextEntries()� �����$����������#� ���������������� ��� ��?�

• ����������� ������ ���������� !���������NextLines()� �����$������ ���������������� �����������������������!��������>���� ����>�����#� ���������� ��������������$�

���������ARRAY����� ����������������� ������#� ���������������STRING�!��������#������� �����Dtext���#��������$�&�������������������������� �!���������#� ���������������������Rtext!�#�����#� ������� �������DBREF���"�������������#�����������#$�,��� � ��@ ������!������ �Rtext��� ��#� ������������������� �$�

Methods

Name Result Purpose

Report() 0���������$�

Report(TABLE) 0���������������� ������������� ������ � ���� ���$�

Table(TABLE) ���������� ����������������������$�

AddColumn(STRING key, COLUMNFORMAT, STRING heading)

���������� � �#�����������������������������!�#��������������� � ���� ��$�������� ��heading��������� � ������$�

NextEntriesIndex(REAL position) ����������������������� ������������������������>���� �����$�

NextEntriesIndex(REAL n, STRING) �������������������� ��������� ������������������������>���� �����$�

SetCaseMatch(BOOLEAN) %�������"������#�������8[MATCH'� �����!������#����� ��������������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-125

Name Result Purpose

Initialise() *@����� �������>�������$�

EvaluateTable() *@�� ������������� ���� �����������@�����$�

Keys() STRING ARRAY *�������ARRAY����STRINGS�������������� � ���������������������$�

ColumnFormat(STRING key) COLUMN FORMAT

*���������� � ���� ����������������� � ����

ColumnHeading (STRING key)

STRING *���������������������� � ��������������$�

Table() TABLE *����������� �����������������$�

CaseMatch() BOOLEAN C�����#��������MATCH�STRING��������������$����������CaseMatch(BOOLEAN)$�

Results(ARRAY Dtext, ARRAY Rtext) BOOLEAN ��� �������������������� ��������������� �A���� ����� �������3� ��������$�&���� � ���� �����������#���@������Rtext�#� ��������B$�������������TRUE��������������������� ���!�FALSE�����������������$�

1����Rtext����Dtext� ����>���?�����#� ����������#��������� ��$�

Results(ARRAY) BOOLEAN ������������� ��Dtext������ ����$�

ResultsMatch(STRING, ARRAY, ARRAY) BOOLEAN �� � ������Results()������ ���� ��� �������������������������������#��������$�

ResultsMatch(STRING, ARRAY) BOOLEAN ������������� ��Dtext ����� ����$�

NextEntries(REAL n, ARRAY Dtext, ARRAY Rtext)

BOOLEAN ��� ����������������������>����������������� �A���� ����� �������3� ��������!������ � ���� �����������#���@���������*�>��#� ��������B$�������������TRUE��������������������� ���!�FALSE�����������������$�

1����Rtext����Dtext� ����>���?�����#� ����������#�������>��n��� ��$�

NextEntries(REAL n, ARRAY) BOOLEAN ������������� ��Dtext������ ����$�

A Summary of Objects, Members and Methods

2-126 PDMS Software Customisation Reference Manual

Name Result Purpose

NextLines(REAL n, ARRAY Dtext, ARRAY Rtext)

BOOLEAN ��� ��������������#�������>��n� ������������ !������ � ���� �����������#���@���������Rtext�#� ��������$�������������BOOLEAN��������������������� �������� ���$�

1����Rtext����Dtext� ����>���?�����#� ����������#�������>��n��� ��$�

NextLines(REAL n, ARRAY) BOOLEAN ������������� ��Dtext������ ����$�

NextEntriesMatch (REAL n, STRING value, ARRAY Dtext, ARRAY Rtext)

BOOLEAN �� � ������NextEntries()������ ���� ��� �������value����������������#��������$�

NextEntriesMatch(REAL n, STRING value, ARRAY Dtext)

BOOLEAN ������������� ��Dtext������ ����$�

NextEntriesIndex() REAL *����������������������������������������$�

NextLinesIndex() REAL *����������������������������������������$�

NextEntriesIndex (STRING)

REAL *������������������������� �������� ��������$��STRING���������#����'MATCH'$�

Table 2-99: REPORT Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-127

RGROUP Object Forms and Menus

Members

Name Result Purpose

Val REAL�

/�9���

���������RGROUP�� ����������� ���A3!5![B�

Table 2-100: RGROUP Object Members

Methods

Name Result Purpose

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /���#������ $�

Select(STRING) NO RESULT � ������������#�����>��� ��� ��STRING$�

Selection() STRING /������>���� ��������� ���������$�

SetPopup (MENU) NO RESULT ������������ ��#�����������������������$�

SetFocus() NO RESULT '������������������������������$�

Refresh() NO RESULT *������������� ��������������$�

SetToolTip(STRING) NO RESULT ����������������>��������TOOLTIP.�

RemovePopup(MENU) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /�������������������������.�

Table 2-101: RGROUP Object Methods

Command

���RGROUP��� ����������������*�����/���������� ��$�+���������������add tag������ ������������������ �������������$����������������������� #������������� ������������� �����>��#� ��������������� ����������� $�

A Summary of Objects, Members and Methods

2-128 PDMS Software Customisation Reference Manual

&�������������������VERTICAL����HORIZONTAL������ ���������������������������������������PATH��� �������� ����$�+������� ���>� ���� ����������� ������������@��� ����#�������������������������SPACING���#���$�

+�������������RGROUP������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

+���� �����*�����/���������� ������ �����������EXIT��� ��$�

.-------<---------------------- --. / | >-- RGROUP gname -+- tagtext ---------------------- --| +- <fgpos> ---------------------- --| +-- CORE ------------------------ --| Core managed gadget +- <fganch> --------------------- --| +- <fgdock> --------------------- --| +- CALLback –- text ------------- --| +- VERTical ---. | +- HORIZontal -+----------------- --| | ‘- SPACing -- val --* | .-------<---------------------- ----------. |/ .----<------- -------. | +- ADD TAG - text -+- SELect---– text --| | | +- CALLback – text –-* | | ‘- NL -------- ----------* ‘- EXIT ---->

Syntax Graph 2-13: Setting Up an RGROUP

Default: ������� �����������#�����������6$6��������������H��� ���������� �������������$�������� �����#������������ �HDIST����VDIST!�#��������� ������3$6����6$5;�������� �!��������#�)���� ������������������������������@������������!�#����������>� ��������������������� ��$�

Note: ���SELECT��>����������� ���������������������������� ������������������������$�&����������������������� �������������������������� ������������������� �����#� �����������������������$�

&��������������������� �������������������������$������ ��� ������������������������$�

����������������������� ��������������A����B�����!��$$������ ���������HDIST����VDIST$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-129

SELECTOR Object Forms and Menus

Members

Name Type Purpose

Val REAL

/�9����

� ������ ��� ����������� ������� ���$�A3!5![B�

Val ARRAY OF REAL

/�9����

� ������ ��� ��������� � ��� ������� ���$�A3!5![B�

DText STRING ARRAY

/�9����

���������������� ����������� ����>��$�

DText[n] STRING

/��� ��

/��������� ����>��������n8����� �$�

PickedField REAL

/��� ��

����������� ������ ��� ��$�

Table 2-102: SELECTOR Object Members

Methods

Name Result Purpose

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /������#������ $�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /�����GADGET���������������$�

Select(STRING text, STRING value) NO RESULT � ������������� ������ ����$�text� ������I*�>�D����I-�>�D$�value��������� ��RTEXT����DTEXT������� ���$�

Select(STRING text, Array values) NO RESULT � ��� � ��� �������� ������� �������� ���text� ������I*�>�D����I-�>�D$����values�����������������RTEXT����DTEXT��������� ��������� ���$�

Selection(STRING text) STRING ARRAY OF STRING

/��������� ������text� ������I*�>�D����I-�>�D$������ ������Selection�������RTEXT����DTEXT�������� ������ ������� ��$�

SetPopup(MENU) NO RESULT ������������ ��#�����������������������$�

A Summary of Objects, Members and Methods

2-130 PDMS Software Customisation Reference Manual

Name Result Purpose

SetFocus() NO RESULT '������������������������������$�

SetToolTip(STRING) NO RESULT ����������������>��������TOOLTIP$�

Refresh() NO RESULT *������������� ��������������$�

RemovePopup(MENU) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Clear() NO RESULT 0 ���� ����������$�

ClearSelection() NO RESULT 0 ���� ������� �$�

Table 2-103: SELECTOR Object Methods

Command

�� SELECTOR �� ������������������ ��� ���������������������������������!����!������ ������>�$�� �����������#��������� ������ �#������� �������� ����� � ��� �����������������������A#�������������B���#������������ ��������������� ����#� ������$�&��� ���� �#����������������#��������������������������������#����#����������������������������� ����� ������������������������$�

.-------<---------. / | >- SELector gname -+-- <fgpos> --------| +-- tag text --------| +-- <fganch> -------| +-- <fgdock> -------| +-- TOOLTIP text ---| +-- CALLback text --* +-- SINGle -. +-----------‘- <vshap> DATAbase -+- MEMbers -. | +- OWNers --| | ‘-----------+-AUTO-. | ‘------| `- MULTiple <vshap> DATAbase --- +- MEMbers ---------| |- OWNers ----------| ‘-------------------| | .-------<-----------* | +-- TOOLTIP text --. ‘------------------‘-->

Syntax Graph 2-14: Setting up a SELECTOR Object

Default: ��� ������$�&��DATABASE�������2�� ����!����� �����' ����� ����#��$���������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-131

SESSION Object PDMS

Members

Name Type Purpose

UniqueID STRING

/�9���

&��� �ID��

Name STRING

/�9���

�������� �

Login STRING

/�9���

%��D�� ����&-

Host STRING

/�9���

ID�������'�������������������

Entered STRING

/�9���

�� ���������PDMS�

LocationName STRING

/�9���

�� ����������������������

IsRemote STRING

/�9���

������������������* ��� ��������

IsCurrent BOOLEAN

/�9���

TRUE�����%��D���#�SESSION���"���

Table 2-104: SESSION Object Members

Methods

Name Result Purpose

SESSION (STRING) SESSION� *�������SESSION���"��!����������������������������8��%�2�@��$�

Current() ARRAY OF DB ��������0�����DB�������MDB�������SESSION���"��$�

Deferred() ARRAY OF DB �����-�����DBD�������MDB�������SESSION���"��$�

Location() LOCATION *����LOCATION����#����������������� ��$�&����@/ ��� ����"��!�������NULL��������$�

MDB() MDB ���������MDB�������SESSION$�

Mode() ARRAY OF STRING

�������������� ������� �������I*D�!�IRW’�����I�D���������������������DB�$�

Modified() BOOLEAN TRUE������������������ ������$�

A Summary of Objects, Members and Methods

2-132 PDMS Software Customisation Reference Manual

Name Result Purpose

Module() STRING �� �������������PDMS� ��� $�

Status() ARRAY OF STRINGS

�������������������� �������IRD�!�IRWD�����IND���������������������DB�$�

User() USER ���������������SESSION���"��$�

Table 2-105: SESSION Object Methods

Note: ���LocationName� ������Location()� ������ � ����� ����������#����������������� ��$����������� � ����������� ������!�>����#������������� ��� ���������������2����$�&����@/ ��� ����"��!����� ������� ������ ���������� �� �������$�

�� �ADMIN������������/ ��� ����"��� ������ ����������� ������8������ ��������$������#� �����������������������������������������Module()� ����!����� ���$������ADMIN�������� �������� ����/ ��� �-� ��������$������������������������������������������name� ��$�

�� �SESSION���"��� ����������� ��������������� ��� �����

���Modified()� ������ ����� ��������������������������������� ������$�

���Current(),�Deferred(),�Mode()����Status()� ������#� ������� � �������� �������������#� ������������$�

���Location()!�MDB()!�User()����Module()� ����������� �������� ���������$���� �������� ������#� ������-� �������������������������� ��� �������$�

0�����0�����0�����0���������� ���������������������MDB����USER���"����������������MDB()����User()� ������������� ��������$�'��������������"����#� ��������������� ��������� ��������$�������������������� ������8������ ������������� ��������A��������ADMINISTER SYSTEM��� ��B������������� ������������� �� ��������MDB����USER���"���$�

Command

!SESSION = CURRENT SESSION $ Returns the current session object.

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-133

STRING Object PML Built-in Type

Methods

Name Result Purpose

String(BLOCK) STRING 0�������STRING���� ���BLOCK�>������$�

String(BOOLEAN) STRING 0�������STRING�2�� ����TRUE����FALSE$�

String(BOOLEAN,FORMAT) STRING 0�������STRING���� ���BOOLEAN!�����������������FORMAT���"��$�

String(BORE) STRING 0�������STRING���� ���BORE$�

String(BORE,FORMAT) STRING 0�������STRING���� ���BORE!�����������������FORMAT���"��$�

String(DB) STRING 0�������STRING������������DB�� $�

String(DB,FORMAT) STRING 0�������STRING������������DB�� $����FORMAT����� ������2���������������������,�� �����'��$�

String(DIRECTION) STRING 0�������STRING���� ���DIRECTION$�

String(DIRECTION,FORMAT) STRING 0�������STRING���� ���-������!�����������������FORMAT���"��$�

String(MDB) STRING 0�������STRING������������MDB�� $�

String(ORIENTATION) STRING 0�������STRING���� �����������$�

String(ORIENTATION,FORMAT) STRING 0�������STRING���� �����������!�����������������FORMAT���"��$�

String(POSITION) STRING 0�������STRING���� ���POSITION$�

String(POSITION,FORMAT) STRING 0�������STRING���� ���POSITION!�����������������FORMAT���"��$�

String(PROJECT) STRING 0�������STRING������������PROJECT����$�

String(REAL) STRING 0�������STRING���� ���REAL$�

String(REAL,FORMAT) STRING 0�������STRING���� ���REAL!�����������������FORMAT���"��$�

A Summary of Objects, Members and Methods

2-134 PDMS Software Customisation Reference Manual

Name Result Purpose

String(REAL,STRING) STRING 0�������STRING���� ���REAL$����STRING����� ��������������������������� ��������� � �� ����#��������������� ����� ����-$�

String(SESSION) STRING 0�������STRING������������SESSION�� ��$�

String(TEAM) STRING 0�������STRING������������TEAM�� $�

String(USER) STRING 0�������STRING������������USER�� $�

After(STRING two) STRING *�������@�������� �#��� �� ������������������@������two.�

Before(STRING two) STRING *�������@����������� �� ������������������@������two.�

Block() BLOCK '���STRING�������BLOCK������� �����$�

Boolean() BOOLEAN TRUE����STRING����ITRUE’!�I�D!�IYES’����I+D?�

FALSE����STRING����IFALSE’!�I,D!�INO’!���I�D$�

Bore() BORE 0�����STRING������BORE�A>������������@���� ���NEARESTBOREB$�

Bore(FORMAT) BORE 0�����STRING������BORE���������������������� ��� �FORMAT���"��$�

DBRef() DBREF 0�����STRING������DBREF$�

DBRef(FORMAT) DBREF 0�����STRING������DBREF���������������������� ��� �format���"��$�

Direction() DIRECTION 0�����STRING������DIRECTION$�

Direction(FORMAT) DIRECTION 0�����STRING������DIRECTION���������������������� ��� �format���"��$�

DLength() REAL ���Length()��������� � ����������������

DMatch(STRING) REAL ���Match()��������� � ���������������$�

DSubstring(REAL) STRING ���Substring()��������� � ���������������$�

DSubstring(REAL,REAL) STRING ���Substring()��������� � ���������������$�

Empty() BOOLEAN TRUE����� ����H��@ ���������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-135

Name Result Purpose

Length() REAL �� �����������������������$�

LowCase() STRING 0�������������� �#�����$�

LT(STRING) BOOLEAN 0� ��������������0&&��� ������2��$�

Match(STRING two) REAL �����������������������@������two�#�����������������@�H�������������������$�

MatchWild(STRING two) BOOLEAN TRUE������������������� $�STRING�two� ���������#� �����������������

• R��������� �����������������

• \����������� ���������$�

MatchWild(STRING two, STRING multiple)

BOOLEAN TRUE������������������� �������������multiple����������#� �������������� ���������������$�

MatchWild(STRING two, STRING multiple,STRING single)

BOOLEAN TRUE������������������� �������������multiple����������#� �������������� �������������������single�� ����������������������� ���������$�

Occurs(STRING) REAL *��������� ������������������������������$�

Orientation() ORIENTATION 0�����STRING������ORIENTATION$�

Orientation(FORMAT !!format) ORIENTATION 0�����STRING������ORIENTATION���������������������� ��� �!!format$�

Part(REAL nth) STRING �>������nth��� ����� �������#����� ������� � �����������!��������# �$�

Part(REAL nth,STRING delim) STRING �>������nth��� ����� �������#����� ������� � �������delim$�

Position() POSITION 0�����STRING������POSITION$�

Position(FORMAT !!format) POSITION 0�����STRING������POSITION���������������������� ��� �!!format���"��$�

REAL() REAL 0����������� ��$�

Replace(STRING two,STRING three) STRING *� ���� ����������������@�������#��#�������@������three$�

A Summary of Objects, Members and Methods

2-136 PDMS Software Customisation Reference Manual

Name Result Purpose

Replace(STRING two,STRING three,REAL nth)

STRING *� ���� ����������������@������two�#�������@������three���������������nth���������A���@nth������������ �����B$�

Replace(STRING wo,STRINGt hree,REAL nth,REAL count)

STRING *� ���count�����������������@������two�#�������@������three���������������nth���������A���@�������������� �����B$�

Split() ARRAY �� ���������������ARRAY����STRINGS���������A � ��� ��������� �����B$�

Split(STRING elim) ARRAY �� ���������������ARRAY����STRINGS����delim�A � ��� �����delim������ �����B$�

String(FORMAT) STRING 0�����STRING������STRING���������������������� ��� �FORMAT���"��$�

Substring(REALindex) STRING *����������@��������� �index���������������������

Substring(REAL index,REAL nchars) STRING *����������@�����!�nchars��� ���!������������index$�

Trim() STRING * �������� �������� ��������$�

Trim(STRING‘options’) STRING * �������� �������Aoptions�OI�DB!����� ���������Aoptions�O�I*DB���������Aoptions�OD�*DB$�

Trim(STRING options,STRING char) STRING *���� � ��� �������������char��������� �����������������������STRING�A�������O�I'DB$�

UpCase() STRING 0�����STRING������������$�

VLogical() BOOLEAN ��� ����STRING������BOOLEAN.�

VText() STRING ��� ����STRING������STRING.�

VValue() REAL ��� ����STRING������REAL.�

Table 2-106: STRING Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-137

TABLE Object Collection and Report

���TABLE���"��������������� ����#���������� ������������� ���� ������������ ��� ��!��$$��������������$��������#���������� ����������DBREF!��������������������� ������$������ � ����������� ����������� ��������������DBREF��������������������������COLUMN���"��$�

���������������� ����������������������� � ��������������������������� ������ � $������� ��������������� ���������������REPORT���"��!�#�����#� �� �#������ �������������������� ����������#���$�

Methods

Name Result Purpose

Table() 0����������A����� ����� ������"���������B�

Table(DBREF ARRAY, COLUMN ARRAY)

0��������������������������� ����(�������ARRAY����DBREFS��������� � �������ARRAY����COLUMNS�

Table(COLLECTION, COLUMNARRAY) 0��������������������������� ����(�������COLLECTION��������� � �������ARRAY����COLUMNS.�

PrimaryKey(COLLECTION) %����������� ����(������ ��������� ����� ���COLLECTION.�

PrimaryKey(ARRAY of DBREF) %����������� ����(�.�

Column(REAL n, COLUMN) *� �������@����� � ���������� .�

ClearColumns() 0 ����� ������ � ����� ������� .�

Columns(COLUMN ARRAY) ������������ � ����� ���ARRAY����COLUMN���"���.�

Evaluate() ��� ���������� � ����� .�

EvaluatePrimaryKey() *@�� ����������� ����(���� ����.�

PrimaryKey() DBREF ARRAY *����������� ����(����������� !������ ������������� � ����������� .�

Columns() COLUMN ARRAY

*���������� � ���������$������������������ � ������ �������#��������$�

Cell(REAL column, REAL row) ANY *��������������������� �������column����row.�

Column(REAL, n) ARRAY *�����������������nth��� � .�

A Summary of Objects, Members and Methods

2-138 PDMS Software Customisation Reference Manual

Name Result Purpose

Row(REAL, n) ARRAY *�����������������nth���#.�

Cell(STRING key, DBREF) ANY 0������������ ��������� � ������#.�

Column(STRING key) ARRAY *������������������� � ������������key.�

Row(DBREF) ARRAY *�������������������#������������DBREF.�

Table 2-107:TABLE Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-139

TEAM Object PDMS

Members

Name Type Purpose

Name STRING �� �������TEAM!�������:5����������$�

Description STRING TEAM����������!�������356����������$�

Refno STRING STRING���������-������������� ��$�

Table 2-108: TEAM Object Members

Methods

���������� ������ ���������������� ���"��$�

Name Result Purpose

DbList() ARRAY OF DB ��������DB���#��������TEAM.�

UserList() ARRAY OF USER

��������USERS������TEAM.�

TEAM(DBREF) TEAM *�������TEAM���"��!�������DBREF$�

TEAM(STRING) TEAM *�������TEAM���"��!�������� ���������� ��$�

Table 2-109: TEAM Object Methods

���� ������ ���������������� �#���#�����

!D = OBJECT TEAM(!!CE)

!D = OBJECT TEAM(!!CE.Name)

!D = !!CE.TEAM()

!D = !!CE.Name.TEAM()

&�� ������!!CE�������� ���������DB��������� �����!!CE.Name������STRING���"�������������� �D��� $�

���� ���������� �������������� ���� ���� ���������)������ ���������������������� �-������� �������"��$�

Command

!ARRAY = TEAMS $ Returns an array of TEAMs

A Summary of Objects, Members and Methods

2-140 PDMS Software Customisation Reference Manual

TEXT Object Forms and Menus

Members

Name Type Purpose

Val STRING

/�9���

���������������������STRING�����TEXT��� �$�

Val REAL

/�9���

���������������������REAL�����TEXT��� �$�

Val BOOLEAN

/�9���

���������������������BOOLEAN�����TEXT��� �$�

Val 'AS DEFINED'

/�9���

�������������������������� �����������������������������$�

DataType STRING

/��� ��

/����������������� �$�

Echo BOOLEAN

/��� ��

/����������������$���@���� �����������������������#� �� ������������������$�

Format STRING

/��� ��

/������ ���������� �����"�������������#��������� �$�

Scroll REAL

/��� ��

/��������� �)����$�

ValidateCall STRING

/�9���

��9������@������� ��������� ����$�

Table 2-110: TEXT Object Members

Methods

Name Result Purpose

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /���#������ $�

Clear() NO RESULT 0 ��������������$�

SetEditable(BOOLEAN) NO RESULT ������������ ����������������� �$�

SetFocus() NO RESULT '������������������������������$�

SetToolTip(STRING) NO RESULT ����������������>��������TOOLTIP$�

Refresh() NO RESULT *������������� ��������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-141

Name Result Purpose

SetValue(ANY value, BOOLEAN validate)

NO RESULT ��������� ���������� �!�������������� ������������� ��$�&��validate�����TRUE!������ ��������� �����#� ���>����$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /���������������������������$$�'TEXT'$�

Table 2-111: TEXT Object Methods

Command

���TEXT��� �����������>���� ��������#��������������������� ���������������$��

����� �#������� ������������?�/������������!����!���H!��� ����!�����!������������� ���?� �>� � � ��������������������� ��������� ������������?����� ��������� �����"���#������������#����� ������������������>��������������?�������>������������������������!������������������������A�������������#����!�����>� � B?����������� ��������������������������$�

+�������������TEXT���"��������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

.--------<-------------. / | >-- TEXT gname --+-- <fgpos> -------------| +-- CORE ----------------| Core managed gadget +-- tagtext -------------| +-- <fganch> ------------| +-- <fgdock> ------------| +-- TOOLTIP text --------| +-- CALLback text -------* | .---------<---------. | / | `--*-- WIDth integer ----| +-- SCRoll integer ---| +---NOEcho------------* | ‘-- IS --+-- STRING --. +-- REAL ----| +-- BOOLEAN -| `-- word ----+- FORMAT gvarnm -. `-------- ---------+- TOOLTIP text -. `----------------‘-->

Syntax Graph 2-15: Setting Up a TEXT Object

A Summary of Objects, Members and Methods

2-142 PDMS Software Customisation Reference Manual

���&��#��������>�� �#�����������������������������������!����������#� �� ��#���������������� ������������� �FORMAT���"���������� ��$�

Note: ��� �>� � ������� ����ASCROLL�����B����5;<����������!����������� ������������������������ �������3:5$�

&��������������������� �������������������������$������ ��� ������������������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-143

TEXTPANE Object Forms and Menus

Members

Name Type Purpose

Val ARRAY OF STRING

/�9��

/������������������������>����$�

Count REAL

/��� �

/������ ������ �������>������������$�

Table 2-112: TEXTPANE Object Members

Methods

Name Result Purpose

FullName() STRING /������� �������� !�$�$8PP,�� $�����8.�

Name() STRING /����������8��� !�$�$�8�����8.�

Owner() FORM /���#������ $�

Clear() NO RESULT 0 ���� � ������ �����������

Line(REAL ) STRING /������>��������� ��

SetLine(REAL, STRING) NO RESULT *� ����������� ��� ������STRING$�

CurPos() ARRAY[2] OF REAL

/�����������������A �!���������B$�

SetCurPos(REAL[2]) NO RESULT ������������������A �!���������B$�

SetCurPos(REAL, REAL) NO RESULT ������������������A �!���������B$�

SetEditable(BOOLEAN) NO RESULT �������������$�

SetPopup(MENU) NO RESULT ������������ ��#�����������������������$�

RemovePopup(MENU) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

SetToolTip(STRING) NO RESULT ����������������>��������TOOLTIP$�

Refresh() NO RESULT *������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

Type() STRING /�������������������������$�

A Summary of Objects, Members and Methods

2-144 PDMS Software Customisation Reference Manual

Table 2-113: TXTPANE Object Methods

Command

���TEXTPANE��� �����������>����������������������������������������$����������� � ��@ ���>��������� �!�� �#������������������� ������ �������>��A���������� ���������������������B$�������������� ��������������� �#��#��������������!�������������#��������#���#�������������������������>�$�

����� �������TEXTPANE�������������!�� ����������������������!�#������� ������� �������������$�

+�������������BUTTON������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

.--------<--------. / | >-- TEXTPane gname --+-- tagtext---------| +-- <fganch> -------| +-- <fgdock> -------| +-- <fgpos> --------| +-- CORE -----------* Core managed gadget ‘-- <vshap> --->

Syntax Graph 2-16: Setting Up a TEXTPANE Object

Note: &��������������������� �������������������������$������ ��� ������������������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-145

TOGGLE Object Forms and Menus

Member

Name Type Purpose

Val BOOLEAN�

/�9��

���� ���� ����#�TRUE����FALSE$�

Methods

Name Result Purpose

AddPixmap(STRING file1, STRING file2, STRING file3 )

AddPixmap(STRING file1, STRING file2)

AddPixmap(STRING file )

NO RESULT �������> ���������������������� ���!�� �������������������$���� �����#����������� $�

FullName() STRING /������� �������� !�$�$8PP,�� $�����8$�

Name() STRING /����������8��� !�$�$�8�����8$�

Owner() FORM /���#������ $�

SetFocus() NO RESULT '�������������������������������$�

SetPopup(MENU) NO RESULT ������������ ��#�����������������������$�

RemovePopup(MENU) NO RESULT * ����������������� ����� ���������$�

GetPickedPopup() MENU *�������� ���������������� ��������������$�

Refresh() NO RESULT *������������� ��������������$�

Shown() BOOLEAN /��I���#D�������$�

SetToolTip STRING ����������������>��������TOOLTIP$�

Type() STRING /�������������������������.�

Table 2-114: TOGGLE Object Methods

Command

���TOGGLE��� �������������� ������!�����������������������!����!������ ������>�$�� ���� �#������������������������>�������������������� ��ON����OFF������$�

A Summary of Objects, Members and Methods

2-146 PDMS Software Customisation Reference Manual

+�������������TOGGLE������������'�@����� �!�������@��������� ����������������2�� ������������������� ����!�#������ ���I�'�G����F0�*�G$��

.-------<------------. / | >- TOGGLE gname -+- tagtext ------------| +- PIXMAP <vshap> -----| +- CALLback text —-----| +- <fgpos> ------------| +- <fganch> -----------| +- <fgdock> -----------| +- TOOLTIP text -------| +- CORE ---------------* Core managed gadget +- STATES text1 text2 -. ‘----------------------+- TOOLTIP text -. ‘---------- ------‘--->

Syntax Graph 2-17: Setting Up a TOGGLE Object

#����>�3�����������������OFF�����������>�5�����������������ON������$�

Note: &��������������������� �������������������������$������ ��� ������������������������$�

Default: -��� ���>�����������������#������ �����������IOFF’����ION’.

-��� �������#�������� ������������������IOFF’?��$$������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-147

UNDOABLE Object PDMS

�������"���� �#�������������������� ���������������������������$�

Methods

Name Result Purpose

description(STRING) NO RESULT ����������������>��������undoable�

add() NO RESULT '����������������#������������������>���������������undoable ����������������

endundoable() NO RESULT '���������������������������������������$�

undoAction (STRING) NO RESULT ����������� ��������>�����#�������undoable�������������������������

redoAction(STRING) NO RESULT ����������� ������>����#�������undoable������������������������$�

clearAction(STRING) NO RESULT ����������� ������>����#�������undoable����� ����#�����������������������9������������� �$�

Table 2-115: PMLUndoable Object Methods

Command

�������������"��!������������������� ���"��!�����������undoAction()!�redoAction()����clearAction() ����������������>������������$�

0� ���� �����add()���� ������������������������������ ���"������������������$�

'��������������������������� ���#����������!������ ���� �����endundoable()���� ��������������������$�

Note: �-'�33$<!��������"������� ��������������-'��-����

A Summary of Objects, Members and Methods

2-148 PDMS Software Customisation Reference Manual

USER Object PDMS

Member

Name Result Purpose

Name STRING ���� �������%��!�������:5����������$�

Description STRING %��D�����������!�������356����������$�

Access STRING %��D���������������AFREE!�GENERAL!�RESTRICTEDB$�

Refno STRING STRING���������-������������� ��$�

Table 2-116: USER Object Members

Method

Name Result Purpose

TeamList() ARRAY OF USERS

��������TEAM���� ����������USER.�

WorkingList() ARRAY OF DB OBJECTS

��������#������>������DBS��#�������%��$�

Password() STRING ���%��D������#���!�������<��������������������9$�

USER(DBREF) USER *�������USER���"��!�������DBREF$�

USER(STRING) USER *�������USER���"��!�������� ���������� ��$�

Table 2-117: USER Object Methods

���� ������ ���������������� �#���#�����

!D = OBJECT USER(!!CE)

!D = OBJECT USER(!!CE.Name)

!D = !!CE.USER()

!D = !!CE.Name.USER()

&�� ������!!CE�������� ���������DB��������� �����!!CE.Name������STRING���"�������������� �D��� $�

���� ���������� �������������� ���� ���� ���������)������ ���������������������� �-������� �������"��$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-149

Command

!ARRAY = USERS $ Returns an array of USER objects in current project.

A Summary of Objects, Members and Methods

2-150 PDMS Software Customisation Reference Manual

VIEW Objects: AREA View Forms and Menus

Members

Name Type Purpose

Limits REAL ARRAY[4]

/�9���

/�������� � ������>�T>3!�3!>5!�5U$�

Borders BOOLEAN

/�9���

/���������������ON�ATRUEB����OFF�AFALSEB$�

Background REAL

/�9���

/������������������0� ������ ���

Background STRING

���� ��

�������������0� ������ $�

Contents REAL ARRAY[2]

/�9���

/��������%���������ID$�

Defcall STRING

/�9���

/������������ ������������� ����$�

Height REAL

/��� ��

/����#������$�

Highlight REAL

/�9���

/������������ �����0� ������ ��$�

Highlight STRING

���� ��

������� �����0� ������ �

Prompt GADGET

/�9���

/��������%������ ���PARAGRAPH������$�

Subtype STRING

/��� ��

/����������������������#$�

Width REAL

/��� ��

/����#�#����$�

Table 2-118: VIEW AREA Object Methods

Methods

Name Result Purpose

Background() STRING *������������ ������� ���������� ������$�

Clear() NO RESULT 0 ���VIEW�������

Highlight() STRING *������������ ������� ���������� ������$�

Refresh() NO RESULT *������������� ���������������

RestoreView(REAL storeNumber) NO RESULT *��������������VIEW�#����������������� ��$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-151

Name Result Purpose

SaveView(REAL storeNumber) NO RESULT ��������������VIEW$����� ��� ���������������3����7$�

SetSize(REAL width, REAL height) NO RESULT ���VIEW���H$�

Table 2-119: VIEW AREA Object Methods

Command

���VIEW�$$$�AREA��� ������������������#������ ��$�+���� �������#������ ������ �����������EXIT��� ��$�

.-------------------------<------------- -----------. / | (AREa) --+- <vshap> ------------------------------- ----. | +- PUT - <sgid> -------------------------- ----| | +- LIMits <uval> <uval> - TO - <uval> <uva l> -| | +- SETColour - <colno> ------------------- ----| | +- SETHighlight - <colno> ---------------- ----‘- NL -| +- <cursor> ------------------------------ -----------| +- <border> ------------------------------ -----------| +-- <pml> -------------------------------- -----------* ‘-- EXIT -->

Syntax Graph 2-18: Setting Up an AREA VIEW Object

#���J����K���������CE�A������ �B�������� ������2D��������� � ��A$�$!���DRAFT�SHEET!�VIEW!�LIBRARY!���$B����J�� �K��������� ���DRAFT��� �����������$�

���J������K�����������>������ ������������������!������ �#���

>-- CURSortype ---+-- POINTER ----. +-- NOCURSOR ---| +-- PICK -------| +-- PICKPLUS ---| ‘-- CROSSHAIR –-‘-->

Syntax Graph 2-19: Setting Up the Cursor Type

J�����K�� �#������� ����H�� ������������

>--- BORDers --+-- ON --. ‘-- OFF –‘--->

Syntax Graph 2-20: Setting Up the Border

A Summary of Objects, Members and Methods

2-152 PDMS Software Customisation Reference Manual

VIEW Object: PLOT View Forms and Menus

Members

Name Type Purpose

Background REAL

/�9���

/������������������0� ������ ��$�

Background STRING

���� ��

�������������0� ������ $�

Borders BOOLEAN

/�9���

/���������������ON�ATRUEB����OFF�AFALSEB$�

Contents REAL ARRAY[2]

/�9���

/��������%���0�����&-$�

Defcall STRING

/�9���

/������������ ������������� ����$�

Height REAL

/��� ��

/����#������$�

Highlight REAL

/�9���

/������������ �����0� ������ ��$�

Highlight STRING

���� ��

������� �����0� ������ $�

Prompt GADGET

/�9���

/��������%������ ���PARAGRAPH������$�

Subtype STRING

/��� ��

/����������������������#$�

Width REAL

/��� ��

/����#�#����$�

Table 2-120: VIEW PLOT Object Members

Methods

Name Result Purpose

Add(STRING) NO RESULT ����� ����� �#����� ��������STRING$�*� ��������� ����� ������$�

Background() STRING *�������������������� ���������� �STRING$�

Clear() NO RESULT 0 ���������������

Highlight() STRING *������������ ������� ���������� �STRING$�

Refresh() NO RESULT *������������� ���������������

SetSize(REAL width, REAL height) NO RESULT �����#���H$�

Table 2-121: VIEW PLOT Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-153

Command

���VIEW�$$$�PLOT��� ������������������#������ ��$�+���� �������#������ ������ �����������EXIT��� ��$�

.-------------------------<------------- -----------. / | (PLOT) --+- <vshap> ------------------------------- ----. | +- ADD – plot_filename ------------------- ----| | +- CLear --------------------------------- ----| | +- SETColour - <colno> ------------------- ----| | +- SETHighlight - <colno> ---------------- ----‘- NL -| +- <cursor> ------------------------------ -----------| +- <border> ------------------------------ -----------| +-- <pml> -------------------------------- -----------* ‘-- EXIT -->

Syntax Graph 2-21: Setting Up a PLOT VIEW Object

#������

J�� �K��������� ���PDMS��� �����������$�

J������K�����������>������ ������������������!������5@34�

J�����K�� �#������� ����H�� ����������������5@56�

A Summary of Objects, Members and Methods

2-154 PDMS Software Customisation Reference Manual

VIEW Objects: VOLUME Views Forms and Menus

Members

Name Type Purpose

Background REAL

/�9���

/��������1���������0� ������ ���

Background STRING

���� ��

���1���������0� ������ $�

Contents REAL ARRAY[2]

/�9���

/��������%���0�����&-$�

Defcall STRING

/�9���

/������������ ������������� ����$�

Height REAL

/��� ��

/����#�.����$�

Highlight REAL

/�9���

/��������.��� �����0� ������ ��$�

Highlight STRING

���� ��

���.��� �����0� ������ $�

Prompt GADGET

/�9���

/��������%������ ������������������$�

Subtype STRING

/��� ��

/����������������������#$�

Width REAL

/��� ��

/����#�)����$�

Borders BOOLEAN

/�9���

/��������1������ON�ATRUEB����OFF�AFALSEB$�

Direction REAL ARRAY[3]

/�9���

-�������������T��!��!�%U$�

EyeMode BOOLEAN

/�9���

TRUE������� ���FALSE�����'�� ��$�

Limits REAL ARRAY[6]

/�9���

�� ������>�TE1,E2,N1,N2,U1,U2U$�

Mousemode STRING

/�9���

'ZOOM'!�'PAN'!�'ROTATE'!�WALK'$�

Projection STRING

/�9���

IPERSPECTIVE’����IPARALLEL’$�

Radius REAL

/�9���

��#�*�������������K6$�

Range REAL

/�9���

*����������K6$�

Refresh NO RESULT� *������������� ��������������$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-155

Name Type Purpose

RestoreView REAL

/�9���

*��������#���������������#�� ��$�

SaveView REAL

/�9���

�������#����������#�� ��!����������3����7$�

Shaded BOOLEAN

/�9���

TRUE�����������FALSE�����#�� �$�

Step REAL

/�9���

������H�K6$�

Through REAL ARRAY[3]

/�9���

�������������T�!�!%U$�

WalkThrough BOOLEAN

/�9���

TRUE�����)� ���������A2���� ������� ��B$�

Table 2-122: VIEW VOLUME Members

Methods

Name Result Purpose

Background() STRING *��������BACKGROUND��� ���������� ������$�

Highlight() STRING *��������HIGHLIGHT��� ���������� ������$�

SetSize(REAL width, REAL height) NO RESULT �����#���H$�

RestoreView(REAL storeNumber) NO RESULT *��������#���������������#�� ��$�

SaveView(REAL storeNumber) NO RESULT �������#����������#�� ��$�

Table 2-123: VOLUME VIEW Object Methods

A Summary of Objects, Members and Methods

2-156 PDMS Software Customisation Reference Manual

Command

���VIEW ... VOLUME��� ������������������#������ ��$�+���� �������#������ ������ �����������EXIT��� ��$�

(VOLume)--+-- LOok --+-- <dir> -------------------- -. | |-- THRough---. | | |-- FROM -----| | | ‘-- TOWards --+-- <pos> ----. | | |-- <gid> ----| | | ‘-- ID @ NL –-‘- -| +-- ISOmetric --+-- value --. | | ‘-----------‘------------ -| +-- PLAN -------------------------------- -| +-- ELEVation -- (one of N/S/E/W/X/Y) --- -| +-- CLIPping -----+-- ON --. | | ‘-- OFF –‘------------- -| +-- CAPping ------+-- ON --. | | ‘-- OFF –‘------------- -| +-- PERSPective --+-- ON --. | | ‘-- OFF –‘------------- -| +-- WALKthrough --+-- ON --. | | ‘-- OFF –‘------------- -| +--RADius --- value ---------------------- | +--STEP ----- value ---------------------- | ‘--RANGE ---- value ---------------------- ‘--->

Syntax Graph 2-22: Setting Up a VOLUME VIEW Object

)����

�J�� �K��������� ���DESIGN��� �����������?���������� ��������������������� ����� ���

J������K�����������>������ ������������������!������5@34�

J�����K�� �#������� ����H�� ����������������5@56�

Default: 1������ON?��������OFF$�

��#���������PLAN����LOOK DOWN$�

�� �����AUTO�A��������������#� � ���B$�

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-157

VIEW Object: ALPHA Views Forms and Menus

Members

Name Type Purpose

Channel STRING�/�9���

/��������������������� $�

Table 2-124: VIEW ALPHA Object Members

Methods

Name Result Purpose

Clear() NO RESULT 0 ���� � ������ ����� ������+�#���#$�

Refresh NO RESULT *������������� ��������������$�

SetFocus() NO RESULT ��������������������� ���� ����������� ���������$�

� ��*2����AB� ��*2����AB� ��*2����AB� ��*2����AB NO RESULT - ������I�2����D���� ���� ����� ������#������!��������������������� �����������-'��*2�����&�@��� ����������$�

Table 2-125: VIEW ALPHA Object Methods

Command

���VIEW ... ALPHA��� ������������������#������ ��$�+���� �������#������ ������ �����������EXIT��� ��$�

.-------------------------<------------- ------------. / | (ALPha)--+- <vshap> ------------------------------- ----. | +- CHANNEL -+- COMMANDS ------------------ -----| | | ‘- REQUESTS ------------------ -----‘- NL -* ‘-- EXIT -->

Syntax Graph 2-22: Setting Up an ALPHA VIEW Object

A Summary of Objects, Members and Methods

2-158 PDMS Software Customisation Reference Manual

XYPosition Object 3D Geometry

Members

Name Type Purpose

X REAL��

/�9��

X��� �������2D�POSITION.�

Y REAL�

/�9��

Y��� �������2D�POSITION.�

Table 2-126: XYPOSITION Object Members

Methods

Name Result Purpose

XYposition() XYPOSITION 0�������XYPOSITION��������������������$�

String() STRING *�������XYPOSITION������STRING.�

Table 2-127: XYPOSITION Object Methods

A Summary of Objects, Members and Methods

PDMS Software Customisation Reference Manual 2-159

2.5 Deprecated Gadgets

Gadget Replacement

PIXMAP�VIEW�/����� %��PARAGRAPH����BUTTON�#������PIXMAP$�

RADIOGROUP�/������ %��#�RGROUP���"��$�

SELECTOR�/������ %��LIST�OBJECT���������� $�

USERDATA�/����� %��FORM������� ��

A Summary of Objects, Members and Methods

2-160 PDMS Software Customisation Reference Manual

Appendix A: Communicating with PEGS

PDMS Software Customisation Reference Manual A-1

Appendix A. Communicating with PEGS

������������>� ������#��������� ���������/����� ����%&� ��� �,'����!������#������� �������������������� ��������� �������������� ���/�����,'����$�

�����/���� �������� �� ���� �,'��������������� ���/��������� ���!��������#������ ������ ��� ��������������������/���������������� ������������$�

A.1. Directing Commands to PEGS

&�������������������� ��� �������/�!�����>���� ��#��������� ���

PEGS

���� ���������������� �� ������

• ���� ����������������������#�,'������������������/��������?�

• �������������/���� ����2��$�

���������>�������������������� ��� ������������������ �������������������$�

A.2. Setting Connections Between FMLayer and PEGS

1������ �����������������/����� �,'����!��� ��� ��������������#�����#���������$�0� �������������� ������ �������������������$�

�� ��������������� ����������� ������#������� ���������������/������� ���������������,'����$�������������#� ��� � ���� ���������%&� �����$�

PEGS Command Description

PEGS CONNECT integer COMMANDS text

0���������������������� ���integer!�#������������ �text!������������ ���������/�$�����integer���� ������������������

PEGS CONNECT integer RECORDING text 0���������������������� ���integer!�#������������ �text!�������������� ������� ���/�$�����integer���� ������������������

Communicating with PEGS

A-2 PDMS Software Customisation Reference Manual

PEGS Command Description

PEGS DISCONNECT integer

0 ���������������������� ���integer$�

PEGS RECONNECT integer

0���������������������� ���integer�#�� ��������������������������������� ��� $�

�� �������>����� ��#�� ������������������������������ $������������ ����������������#��������/�� ��� �����������������������������#�����>�� ��� ������������$��������#������ ��������2��� ������ ��� D�������������������#����������������� ���� �$�

�������� ����������� ������������2������� �����#������������%&� ���������������������/�� ��� �$�������������������������������� �������� ������� ��$�

,���>� � ��

LAYER_PEGS_PIPE is a user defined name

A.3. Sending Commands to PEGS

� � ������������#�� ��� ��������#������/������������������ ���#���#�������� ��A��������#���������������������������/���0.���,,��� ��B$��

�� ���/�� ��� ��#� !���#��!���� ��������� ���������������2��������������������� ������� ������ ������$�&������������������� �����!��������� �#����� �����������������������

PEGS STARTRECORDING

Sending the Commands and Getting the Results

����������� ��������������/�!�� �������� �����������2������������>����#���������#������/���

PEGS “command string”

����������������������������'�������� ����������������� �!���� �#���������������������������� ����������� ������� �����$��

��������� �������������� �#���

PEGS Variable Description

!!PEGS.RESULT �������������� ��� �������#�� ���������������� ���/���������� ���I�� ����� ����������� �D$�

Appendix A: Communicating with PEGS

PDMS Software Customisation Reference Manual A-3

PEGS Variable Description

!!PEGS.PROMPT �������� ��� ������� ���� ��������������� �$�1��������!����������������������>����� ������������������������/���� ���������$�

!!PEGS.QUERY �������������� ��� �������� � ����2���� ���� ������� �����������������/���� ��$���������� ���� ���#�� ���/�����������������2�����9��#���2����������������� � ��� ������������ ��!���������#����������������������� �$������������!!PEGS.QUERY���� �����>������������������>��������2�������� �������!���������D��������� � D$������#��#� �����������/��������>���� ��$������������2�����9��#���2�����������������!!PEGS.QUERY���� ��������������2��������������#��$�

!!PEGS.NAME �������� ��� ������� ���@���@�� �������������$�1��������!������������������� ��� ����������������������/���� ���������$�

!!PEGS.ERROR �������������� �#������� �������� ����� ���� ������� �����������������/���� ��$��������!������ �������� ������ �!!PEGS.RESULT�#��������������������������!��������

!!PEGS.MEMBERS �������������� ��� ������� ���� ���$�

!!PEGS.CEINDEX �������� ��� ������������� ��������������� ���� ���$�

Dealing with the Responses

���������� ������������������������������������ ������������������������

PEGS Command Description

PEGS variable_id “command string” 0�������������������������������/���� ��$������������variable_id�������������������� $�&����������variable_id�#� �����������������������������!!PEGS.RESULT!����������������������������������������#����#����������� ������� �����$�

Communicating with PEGS

A-4 PDMS Software Customisation Reference Manual

PEGS Command Description

PEGS RAW ’command_string’

PEGS RAW variable_id ‘command_string’

&����������/����������������������� �������2���������������� �� ��A�������!�������� �������#�����B$�

+��� ����!�����>� � !���������������#�������POSITION��� ��!���� �#���������� ������� �������� ������������@������� ����#�������������� ������������>�$��

�����/���� ���#�� ��������������� �PEGS RAW ‘POS’$�

Sending Batch Commands

���������2��������/���� ������������ ��!������������������ ���������� ��������������!�����>������� ���#����BATCH$��

������������� ������������������������� ����@�������� ���������!����#����������� ��� ������� ���������������������/��������������#���������#�����$�

1����� �����������������#������� ������������ ���#����������2�������� ����#����������� ���2�����������/�?��������!��� ��������������������������� ����������� �������������������� ���/�$�

,���>� � !������ �#����������2��������LINE� ��������PIDRAFT����#����

PEGS BATCH ’ED’

PEGS BATCH ’LIN’

PEGS BATCH ’AT 100 100’

PEGS BATCH ’AT 100 400’

PEGS BATCH ’AT 400 400’

PEGS BATCH ’AT 400 100’

PEGS BATCH ’AT 100 100’

PEGS ’AT 100 100’

��� ������ ���������2��������������@�������� ���������#� ������������������ ������������#�����������$�

Appendix A: Communicating with PEGS

PDMS Software Customisation Reference Manual A-5

A.4. Some Special FMLayer Commands

&�������������������������/���� ���!���������� ������ ��� �����

PEGS Command Description

PEGS ECHO ON and PEGS ECHO OFF

�������#����������� ��������������� ���/������������������ ���#���#$�

������� �����PEGS ECHO ON$�

PEGS LIST integer

C��������������������������/���� �����������$���������� �integer������������ ��$�

������ ����������� ��������������������������������������$�

PEGS LIST ALL C����������������� ���/���� ������������ ���$������� ������������ ����

Command pipe is 1 Echo on, Batch mode off, Results off Sync Data on, Sync GUI on #1 Command: Pipe.in Recording: Pipe.out

�������-�����������/%&������������ �������� ��������������� ����� ����������$�

A.5. Handling Errors Returned from PEGS

������������ ���/�������,'������� ���� #������ ������������������!�#������� �����������/�� ��� �� ��!�!�����������@� ��!� $��

&������� ������������������!���������� ����������H��$�

&��������� �������������!������� �������������������/�������������,'����������#������������������ ���ALQ!� B$����������������� ����������� ������� �����$��

,���>� � !����PIDRAFT������ �����

PID7003 WARNING: Flow reversed at attachment point

���������������������� �����

(78,147003) WARNING: Flow reversed at attachment po int

����PIDRAFT�������� ��� �� ���37$�

Communicating with PEGS

A-6 PDMS Software Customisation Reference Manual

�����/�� ��� �� �����������������#����������� �#���

PEGS Module Number Module

3� ACCESS (ACS)

:� PEGS CONVERSION PROGRAM (PCP)

7� DICTIONARY (DIC)

<� FORMFILLER (FOR)

L� LIBRARIAN (LIB)

4� LOOKUP (LUP)

36� MANAGER (MAN)

35� AUTONUMBER (AUT)

37� PIDRAFT (PID)

3;� PLOT (PLO)

3<� REPORT�GENERATOR�AREPB��

A�� �� ����������?�RGCB�

3Q� REPORT GENERATOR (REP)��

A����������������?�RGIB�

53� SYMBOL EDITOR (SYM)

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-1

Appendix B. Communicating with REVIEW

������������������������� � ���� ���������������#����*��&�)!�������� ������������"������#�������*��&�)�%���/���!�#�������� �������� �� ���� ������ ��� ����������� ���*��&�)����>� ���$�&��� ���>� ����������������������� ��������� �������������� �*��&�)$�

���*��&�)��� �������� �� �������������������������� �*��&�)�������� ���!��������#������ ������ ��� ��������������� ������������$�

Note: )������ ���� ���� ���� ���� ���� ���� ���� ��������������������������>!������ ����� ������������� �� �$�

B.1. Invoking the Command Line Interface

+������������� ��� �����������*��&�)����������� �����������������*��&�)�����������$�

B.2. Directing Commands to REVIEW

&�������������������� ��� �����*��&�)!�����>���� ��#��������� ���

REVIEW

���� ���������������� �� ������

• ���� ����2������������ �������� ������*��&�)D���������?�

• ����������������������� ������������ ��� ������*��&�)$�

���������>�������������������� ��� ������������������ �������������������$�

Appendix B: Communicating with REVIEW

B-2 PDMS Software Customisation Reference Manual

B.3. Sending Commands to REVIEW

+��� �������� ��� ������*��&�)���������#��#�����

• ���� ����� �!��������������# ����������������������� ��������� ��� �?�

• &������� ��!�����������>� �������������������������� ���������� �������� ��� ���

*��&�)���������������� ��������� ��������������������������� � � ���������!�#�������� ���������� ������������������� ��� ������������ �����#���������� �����������A#���������� �������������� ������������#�� ��� ����2��B$�

REVIEW Command Description

REVIEW AUTOsend ON

���� ����� ������� ���� �@��@ �$�

REVIEW AUTOsend OFF ��������������� �������� ����� ������������������� ���A#��������������� �B$�

REVIEW SEND

������������������ �������*��&�)�>� ���� ��A�� ���� ��#����������� ������B$�

������� ���#� ����� ��� ��� ��������������������������������REVIEW SEND��� ��$�

0�����!�����>� � !������ �#����� ��� ���A#��������� ���������������������� �B��

1.REVIEW MATERIAL 1 RGB 10 10 10

2.REVIEW ELEMENT /C1101 MATERIAL 1

3.REVIEW SEND

4.REVIEW ELEMENT /C1002 MATERIAL 1

5.REVIEW SEND

1������ �!������� ����������������A�$$�������� ���������B$�������� ���3����5!�#������� ��*��&�)�������� ��� ���!����������������*��&�)���� ����>� ������� ��������������������� ��:$�

�� � �� �!������ ����� ��;������� ��7�A� �B���������������*��&�)$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-3

B.4. Errors from the Application-to-REVIEW Link

�������� ������� �#��� ���� ����������#������� �#���������!�������������� ������� ����������� ������ � ��$�

Problems with the Application Module

(79, 101) Environment variable CADC_IPCDIR unset (79, 102) Cannot start communications: error

Problems with the Communications Link between Appli cations and REVIEW

(79, 201) Commands sent automatically as AUTOSEND i s enabled (79, 202) Cannot connect to Review: error (79, 203) Cannot start command transfer to Review: error (79, 204) No commands to send to Review (79, 205) Cannot send commands to Review: error (79, 206) Cannot end transfer to Review: error (79, 207) Cannot start transfer from Review: error (79, 208) Cannot receive reply from Review: error (79, 209) Cannot receive the error message from Rev iew: error

B.5. Sample Application

Note: ����� � ���� ����������� ����������� ������������������ �$�1������ ���������� ����� ������������������$������ ���������������� ����� ������������ ����� ����#������ ������������ ������������$�

���������������������� � ���� ����������������#��������������� �������!����������������������������������������$�&����������� � � �� ����������� ����������������������������������������"��!�#��������������� �� ������ ���������������������������������$�

����������������������>�������������������������������� �� ���� ���� �� !��� ������������ �������N&-�!���������#������������� ���!����������!����������$�

����������������������� ��������������������������� ���������� ��!������������� ���2������ ������������������������������������ ���$��

'��������������������������������������� �������� ������?� ������������������������ ����������#���������������#������� ��$�0���@������������������������������ ���������������������#���������� �?�����>� � !����'��������������#�� ��������� �������������#��������"��������� ��� ��#������������� ��������������� ��� $�

Appendix B: Communicating with REVIEW

B-4 PDMS Software Customisation Reference Manual

���������� ������ ������ ����� ������������� ��������������������������� �������!�������������������� ���� �� $�������� ������������� �������� ������� �������� �#���������$�

B.6. Progress Monitoring

�����������'����������� ���������������������������#�������������������� ��������� ��������������������������������� � ���$�* �������� ����������������� ����������� ������#�����*��&�)$�

��������������� �������������������� �����������

• ������

• '������ �

• ��� ��

• ��������� �

• &���� ���

,������������� �!������ � ����������!��������#������������ ����#�����*��&�)�������������� ���!� ���������������� �#����

Completion Status Display Colour

�� � �����-���� /��

,�� �-���� 0���

,��������� 1 ��

������ ���� �

����� 1��#�

B.6.1. Engineering Data

����������-������� �����������������������������������������#������ ����������������� � ��� ����#��������*��&�)����� ��?�����>� � ��

• �����������������?�

• -���������?�

• -��� ������ ��� ���������#��������� ���?�

���������������������� ��!����������� ���������� ���������� ���� �������� ���������#�������������������� �������$��>� � ������ ���#� �� �#����������� ���� �!���0&&���������� ����� �$�

���'��������� ���������������������������#����������������� ��� ��#������2���� ������������������ ������ �$�'������������������������� ���������������������� ������������ ���#�����*��&�)$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-5

���������������� ������������������� �����������

• ��� ��

• �>�������

• '������ �

• &���� ���

• � �

,������� �����!���� ����������� !������������� ������������#�� ���������>����!� ���������������� �#����

• ������

• -��������

• -��>��#��

• -��>�� ����

)����� ���������� ����� ���������-���!�� ����� �� ������#� ������� ����������#�#����� ����2���� ���������#�$����� ������������ ��������������� ������2���������� ���������� �������� �#�����������

• '����������� �

• '��������������

• �������������

• &�� ����� ����

B.7. Using the Sample Application

,��������������� �����#������������� �����>� ���������*��&�)�&��� �����/���$���������#���#���������

% run_demo

*��&�)�#� � ������������������������� � � �� �����������$�0 ������������ ������D������������������� ��������$������������ �� ���� ��������� �#��

+���#� ��������-����������������� !�#������������� ����� ����������� ����� �� ��������$�

Note: ����� �run_demo���� �������������� �����������#����������#���#������� �$�*������rvq_docs/README��� ��������������#�A������D����>������C������� �������B������������� ��������� ��������������#������>��� ��������$�

Appendix B: Communicating with REVIEW

B-6 PDMS Software Customisation Reference Manual

B.7.1. Progress Monitoring.

� ���Applications>Progress Monitoring $�

����� �#� ������� ���!�������#���,�����1@3!������ �������������������� ������������ � ������������������������ ��������� �$�

Figure B-1: The Progress Monitoring form

%������#������������������������� �����������2������� ���������������-����� ��A$�$������B����������������� � �����������A$�$������B$�

0 �������Apply �������������� ������� �� �������� �������������#��������*��&�)� �� $�-�������� �����#� �����������������������������������$�

0 �������Make Display Translucent ��������������� � ����� �������*��&�)����� ���������� ��������� ��������-����� �������������� �������������� ���������#�$�

Progress Monitoring Examples

� ������������ ������� �#����� ���������

Combination Resu;t

-����� �O���������������O������ ������������ ���������� �

-����� �O��� �����������O- �����

��� ��������� ������� ��

-����� �O��� �����������O&��� ��

��� ��������� ���������� �

-����� �O��������� ����������O������

�� #����������� ���������� �

-����� �O&���9� ������������O,���������

&���� ��0������������� ������� �R�

-����� �O'������ ����������O�����

�� ���������� ���������#R�

R������������������ ��!�Select Look > ISO > One ���� ����*��&�)����� �$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-7

B.7.2. Engineering Data

�� ���Applications > Engineering Data $�

����� �#� ������� ���!�������#���,�����1@5!������ ��������>������������������ ���������� �� $�

&����*��&�)����� ��!�� ���������� ������������ �A903363B������������������� ��@���� ���������$���#�� ������Name��� ��������������-������� ��������������� �������� ������� ����� ��������������@���� ���������$�

Figure B-2: The Engineering Data form

0 �������Apply �������������� �������������������������� ������������������Purchase Order ����Description $�

�� ��������������������� ���#� ������#��������Document ����Description �������$�������� �������������� �!�������� ������ ��������������� ����������� �� � ����������� �������View Document ������$������� �������� ������ ��� ������

• ���>���� !������������� ������?�

• ��� ���� ���������������������� ���#����������#��?�

• �������� �����������#��$�

Note: ���>��� ���� ������� ���������������� ������� ��$����� ���������� ��� ������ ������ � ����� ��������#��$�

Appendix B: Communicating with REVIEW

B-8 PDMS Software Customisation Reference Manual

Document Examples

�� �������� ������������ ���������������>� ������ $�

Name: /C1101 -3;:LQ;3� ,����������-��#��� -��� ������� ���� �������'���

�����������#�$�

-��35:� �N&-������3@:� ��������� �������N&-�� ���� $�

Name: /P1501A -Q75QL4L� 5-�-��#��� -��� �������������������� ���#�$�

-7:3L:54Q� 1� ���� ����� �� -��� ������1�'������������� ���3;63�$�

�*:57;@663� 0�� ������*����� -��� ��������� �������� ���������$�

Name: /V-70 -LQ<53:7� 0����������� ���#� -��� ������������ ��������

�� �$�

B.7.3. Maintenance

� ���Applications > Maintenance $�

����� �#� ������� ���!�������#���,�����1�:!������ �������������������� ��������������� ��#������2���� ������#��������������� �������$�

Figure B 3: The General Maintenance Form ����

%������#������������������������� �����������2������� ������������ �Type �A$�$���� �B������ �#��>�� �������������������!����#����Due When ��A$�$�-����>��#�B$�

0 �������Apply �������������� ������� �� �������� �������������#��������*��&�)� �� $�

��� �������������������� ������ ������*��&�)����� ��!�� �������Setup camera view ������$�������������0� ������������������������������������������ ���������!�#�������� �������#����<6]$�

���Name!�Description ����Inspection Date ���������� ������ �#� ��� ������������� ������������������������$�������������� �� �������������������� !�� �������� ���������� �� � ����������� �������������������������������������Further data for selected item $������������� �� ��� ���������� �#�����������

• '����������� �

• '������.�������

• ������&������

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-9

• &�� ����������

Maintenance Schedule

���'����������� ���� !����� ����������,�����1�7!�� �#�����������#���� ��������������������������������������� �� �� ��� $�

Figure B 4: The Maintenance Schedule Form

������� ������������ ��������������� �������������������� !�� ����������������������� �� � ����������� �������View Procedure ������$����� ����������#� ������� ����A�����@� �� ��B�������#����� �������� ��������������$�

��� ����������� �� � ���������������������������� �� ��� �#��������������������/�� �'��������� !�������#��� �� ����� �������Apply ������$�

Maintenance History

���'������.���������� !����� ����������,�����1@;!�� �#�����������#���� ��������������������������������������������� �� �� ��� $�

������� ������������ ������������� �������������������� !�� ��������������������� �� � ����������� �������View Report ������$����� ����������#� ������� ����A�����@� �� ��B�������#����� �������� �������������$�

��� ����������� �� � �������������������������� �� ��� �#��������������������/�� �'��������� !�������#��� �� ����� �������Apply ������$�

Figure B-5: Maintenance History Form

Appendix B: Communicating with REVIEW

B-10 PDMS Software Customisation Reference Manual

Parts Inventory

���������&��������� !�� ����������,�����1@<!�� �#�����������#����� ������� �������������������������� �� �� ��� $�

Figure B-6: Parts Inventory Form

������� ������� ������������� �������������������� !�� �������������������� �� � ����������� �������Supplier Details ������$����� ������� ������������� ���������#� ������� ����A�����@� �� ��B$�

��� ����������� �� ����� ������� ��������������� �� ��� �#��������������������/�� �'��������� !�������#��� �� ����� �������Apply ������$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-11

Isolation List

���&�� ������������� !�� ����������,�����1@L!�� �#�����������#����� ����� ��������� ����� ��������������������������� �� �� ��� $�

Figure B-7: Isolation List Form

������� �� � �������#��� ������������� ��#����� ������������ ����� ��� ������������������ $������ � ����� ����� ��#� ������� �����������*��&�)����� ��$�

��� ���������� ����� ������ ��������������� �� ��� �#��������������������/�� �'��������� !�������#��� �� ����� �������Apply ������$�

Appendix B: Communicating with REVIEW

B-12 PDMS Software Customisation Reference Manual

B.8. A Summary of the Application Data

������������������������� �� �#��������>� � ����� ��!������ �#������ �����#���������#����� �����>����������������������������� �������$�

B.8.1. Progress Monitoring

� Piping Mech.

Vessels Civil Structural HVAC Instr./Elec.

Preliminary �� �� �� �� �� �� ��

Final Design ��� �� �� �� �� �� ���

Fabricated ��� 9�� 9�� 9�� �� �� +��

Erected ��� 9�� 9�� 9�� ��� �� +��

Tested ��� ��� ��� 9�� ��� �� ���

Delivered 9�� �� ��� 9�� 9�� 9�� 9��

Installed 9�� �� ��� ��� 9�� 9�� 9��

Excavated 9�� 9�� 9�� �� 9�� 9�� 9��

Foundations 9�� 9�� 9�� �� 9�� 9�� 9��

Oversite 9�� 9�� 9�� ��� 9�� 9�� 9��

B.8.2. Engineering Data

��������������>���������� ���������������A� ����� ��������������� �B���������������� �#����-'�� ����

/C1101 '��������������#��

/P1502A ��������1�������� ��

/V-70 '��� �������#��� ��

B.8.3. Maintenance

Vessels

Overdue Due today Due next week

Due next month

Primary data �� �� ��� ���

Schedule �� �� ��� ���

History �� �� ��� ���

Parts inventory �� �� ��� ���

Isolation list �� �� ��� ���

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-13

Exchangers

Overdue Due today Due next week

Due next month

Primary data �� �� �� ���

Schedule �� �� �� �����

History �� �� �� �����

Parts inventory �� �� �� �����

Isolation list �� �� �� �����

Mechanical

Overdue Due today Due next week

Due next month

Primary data ��� ��� ��� ������

Schedule �� �� �� �����

History �� �� �� �����

Parts inventory �� �� �� �����

Isolation list �� �� �� �����

Instruments

Overdue Due today Due next week

Due next month

Primary data �� �� �� ������

Schedule �� �� �� �����

History �� �� �� �����

Parts inventory �� �� �� �����

Isolation list �� �� �� ��

All

Overdue Due today Due next week

Due next month

Primary data ��� ��� ��� ������

Schedule �� �� ��� ������

History �� �� ��� ������

Parts inventory �� �� ��� ������

Isolation list �� �� ��� ������

Appendix B: Communicating with REVIEW

B-14 PDMS Software Customisation Reference Manual

'���������������>���������� ���������������A� ����� ��������������� �B���������������� �#����-'�� ����

/C1101 '��������������#�$�

/P1502A ��������1�������� �$�

/V-70 '��� �������#��� �$�

/E1301 ����������$�

V121 '��� �������#��� ��

��������������#��������>���������������������#��������������� �� $�&���������������� �#��� �����#� ������� �����

data ignored not in review model

B.9. The Application Files Supplied

,��������!������ � ���� ��������� ��������� ���������������@� ���������������������!�������

FigureB-8: Hierarchy of Supplied Application Files

������������������� ����������� �#������������

ADMIN ����� ������������������������������ ����������C���$�

PROGRESS �������������������������� ����������� �������$�

ENGDATA �������������������������������� �������$�

MAINTAIN ������������������ ��������� �������$�

DATA ���������������������������������������� �������$�

run_demo ������������������*��&�)�� ������������ ������$�

���� ����� ����������� ������#����������>�#������������������ D��������!�������

F -��������� ��������$�

M -������ ������������$�

U -��������� ���� ����$�

I -��������� ������ ������� ����$�

� �������� � ��������� ��� ��#������������������� ������������������ �$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-15

B.9.1. The ADMIN Directory

File Purpose

CONFIG %��@�������������������?�$�$�����������������

FORACLE ,�� ��������� ���������*-1'���������

FSYSTEM ,�� ��������� ��������� ������� � ��

FVERSION ,�� ��������� ����������������

IORACLE &���� ������� ���������*-1'���������

IVERSION &���� ������� ����������������

MORACLE *�� �� ���������*-1'���������

MVERSION *�� �� ����������������

RPODESC %�� ���� ������������������������� ����������������

START C���������@��� �����

UCAMERA %�� ���� ���������������� ���3�

UORACLE %�� ���� �������������*-1'������������ �

UQUIT %�� ���� ��������2����C����

URESET %�� ���� ������������������� ����� ��

UVIEWDOC %�� ���� ����������#����� ���A� ���� ������������� ���B�

VAR2ENV %�� ���� ��������������^������ ^�������� �� ������� �

B.9.2. The ENGDATA Directory

File Purpose

FENGDATA ,�� ��������� �������������������$�

FPLOTVIEW ,�� ��������� ���������� ���� ���#�$�

IENGDATA &���� ������� �������������������$�

MENGDATA *�� �� �������������������$�

UNEXTPLOT %�� ���� ����������#�>��� ��$�

UPREVPLOT %�� ���� ����������#���������� ��$�

B.9.3. The PROGRESS Directory

File Purpose

FPROGRESS ,�� ��������� ����������������� �������$�

IPROGRESS &���� ������� ����������������� �������$�

MPROGRESS *�� �� ����������������� �������$�

UDISCIP %�� ���� ������������������ ��������� ���������� �$�

UTRANSLU %�� ���� �������� ������� ������� ���$�

Appendix B: Communicating with REVIEW

B-16 PDMS Software Customisation Reference Manual

B.9.4. The MAINTAIN Directory

File Purpose

FHISTORY ,�� ��������� ��������� �������������$�

FINVENT ,�� ��������� ���������������������$�

FISOLATE ,�� ��������� ������������ ����� ���$�

FMAINTAIN ,�� ��������� ��������� �������2��� ��$�

FSCHEDULE ,�� ��������� ��������� ����������� $�

FSUPPLY ,�� ��������� ������������� ������� �$�

IHISTORY &���� ������� ��������� �������������$�

IINVENT &���� ������� ���������������������$�

IISOLATE &���� ������� ������������ ����� ���$�

IMAINTAIN &���� ������� ��������� �������2��� ��$�

ISCHEDULE &���� ������� ��������� ����������� $�

ISUPPLY &���� ������� ������������� ������� �$�

MHISTORY *�� �� ��������� �������������$�

MINVENT *�� �� ���������������������$�

MISOLATE *�� �� ������������ ����� ���$�

MMAINTAIN *�� �� ��������� �������2��� ��$�

MSCHEDULE *�� �� ��������� ����������� $�

UMSHOW %�� ���� �����������#������� ���������� ��������� �$�

B.9.5. The DATA Directory

File Purpose

DOCDATA -��� �������������������� �������

NAMEDATA � ��� ������������������������

SUPPLIERDATA ���� ����������������� �!������������� ������$�

ISOLATEDATA &�� ����� ������������� ���� �������

PARTSINVDATA �������������������� ���� ��������� �������

MAINHDATA '������������������������������������ �������

MAINSDATA '���������������������������������� �������

MAINTDATA '����������� �������������������� �������

PROGRESSDATA �������� �������������������������� � ���������

oracle_data ���*�0���������� ��������� ������� ������ �����������*�0��$���� ����������� �������������#��������������������� ����� �$�

Appendix B: Communicating with REVIEW

PDMS Software Customisation Reference Manual B-17

File Purpose

sybase_data.ksh ���� ������������ ������� ����� ������������*-1'�$���� ����������� �������������#��������������������� ����� �$�

C1101.plot � ���� ����5-����#�������������� ����

C1101020592.asc '������������

C1101091092.asc '������������

C1101111091.asc '������������

C1101121089.asc '������������

C1101141090.asc '������������

EI3245.plot � ������ ����#���� ���� �

EI3246.plot � ������ ����#���� ���� �

V-70.spec �� ��������������

P1501A.bom �� ���� ���� ����� ��

P1501A.plot � ���� ����5-����#�������� ��

cablelist..rep � ������ ���� � ����������A��/�@�����B�

panel.rep � ������ ��� �������A��/�@�����B�

pfd.plot �������� �#������� �� ���� �

pid1.plot �N&-�����3������ ���

pid2.plot �N&-�����5������ ���

pid3.plot �N&-�����:������ ���

v-70.tif ������ ���������� ��A����������#��B�

xtiff %�� ����������� ��������� ����

Appendix B: Communicating with REVIEW

B-18 PDMS Software Customisation Reference Manual

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-1

Appendix C. PML 1 Expressions

����������>�>� ��������'��3�>��������������$��������� �����������#�������������������!�����>� � !��������������� � �������-'�$�

Note: /�� �!�� ��������� ���������� ����� �#�����'��5$�

�>����������������$�,���>� � !������������� ����>�������!��>��>����������� ����� �>�������$�� ���� �������>������� ����������������������$�,���>� � !���������������#��� ���!�>�����!�����#���>����������>�3�����>�5!������ �#���>���������� ��� ����

x + text1 $

.�#��!�������������� �#���>������������� ����

x + y $ adds the values of the numeric variables.

Text1 + text2 $ concatenates the two text strings.

����� �#�����������>��������������� �� ��

Expression Reference

������ �>�������� ��������0$5$�

������ �������>�������� ��������0$5$:�

*� �>�������� ��������0$:�

*� �������>�������� ��������0$:$:�

�>��>�������� ��������0$<�

Appendix C: PML 1 Expressions

C-2 PDMS Software Customisation Reference Manual

C.1. Format of Expressions

������ ��������>������!�����>� � �����������������!����������2����!������ ������$�&�������������� �#������ ������� �#�����#� ��������� �������

�>�� ������� ������2����$�,���>� � ��

‘This is text’

���� ���������������#���������������������$�,���>� � ��

x + y

%����������������������� �������������� ���������>��������������� ���������� �������������$�,���>� � ��

SIN(30)

&���� !���������������������������������������!�>����#�����-'��� ������ �#�������������$�&���������������!�����������#� ���������������������� $�,���>� � ��

(NAME EQ /VESS1 )

C.1.1. Operator Precedence

�������������� ����������������������� �#��� ��������������������������� ��������� ����������$�

Operator Comments

BRACKETS 1������������������������ �����������#������������������� ����!�������� �#���������� � ������ ����

FUNCTIONS �

* / �

+ - �

EQ, NEQ, LT, LE, GE, GT �

NOT �

AND �

OR �

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-3

C.1.2. Nesting Expressions

�>�����������������������������$�,���>� � ��

( (SIN(!angleA) * 2) / SIN(!angleB) )

C.2. Logical Expressions

������ �>������������������

• �-'������������������� ����� �$�$�1%&��$�

• ������ ��������$���������������� �� �����TRUE!�ON!�YES��������!����FALSE!�OFF!�NO������� �$�

• ������ ���������$�

• ������ ��������$�

C.2.1. Logical Operators

��� ����� �������������� �� �����

Operator Comments

AND �

EQ, NE ������������EQ����NE� �������� ������������������� ����������� ����$�

GT, GE, LE, LT ������������/�!���!�/�������� ���� ��������#����� ���������������$�,��� ������� ����!���������0$;!�%������������!�-������������������������>�������$�

NOT� �

OR �

Note: ������������EQ!�NE!�LT!�GT!�LE�������GE��������� �� ���������������� ��������������� ����� ������������?�NOT!�AND�������OR��������� �� ��������������1�� �������������$�

��� ���������0$33!�������������0� �������������� ��������� ������� ����

Appendix C: PML 1 Expressions

C-4 PDMS Software Customisation Reference Manual

AND

Synopsis log1 AND log2 -> logical

Description ����� ���� ����� �AND���#��#�� ����� ��� ��$�������������� ������FALSE$�

Side Effects &������������ ����������������������������FALSE!������� �����FALSE$�

Example TRUE and FALSE -> FALSE

EQ and NE

( number1 EQual number2) -> logical

( text1 EQual text2 ) -> logical

( log1 EQual log2 ) -> logical

( id1 EQual id2 ) -> logical

( pos1 EQual pos2 ) -> logical

( dir1 EQual dir2 ) -> logical

( ori1 EQual ori2 ) -> logical

( pp1 EQual pp2 ) -> logical

( number1 NEqual number2 ) -> logical

( text1 NEqual text2 ) -> logical

( log1 NEqual log2 ) -> logical

( id1 NEqual id2 ) -> logical

( pos1 NEqual pos2 ) -> logical

( dir1 NEqual dir2 ) -> logical

( ori1 NEqual ori2 ) -> logical

Synopsis

( pp1 NEqual pp2 ) -> logical�

Description 0� �����#���� ��$�������� �����������������������������!�� ���������������������������� ����$���������0$;$7����� ������� ����$�%����� ������ ����FALSE��������EQ!�TRUE��������NE$

Side Effects &���#������������������� ����������!�����>� � !�’N 10 ne U

10’!������� ����������$�%����������� ��������������� �������$

Example ( 1.0 eq 2.0) -> FALSE

Errors ��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-5

GT, GE, LE and LT

( number1 GT number2 ) > logical

( pos1 GT pos2 ) > logical

( number1 GE number2 ) > logical

( pos1 GE pos2 ) > logical

( number1 LE number2 ) > logical

( pos1 LE pos2 ) > logical

( number1 LT number2 ) > logical

Synopsis

( pos1 LT pos2 ) > logical

Description 0� �����#���� ��$�������� ����������������������������� ���������������������������� ����$���������0$;$7����� ������� ����$�,�����������!������� �������� ���������� ���� ����������� �!�LT�A/�B������������������GE�ALEB$�%����� ������ ������ �

Side Effects &���#������������������� ����������!������� ����������$��,���>� � !�’N 10 gt U 10D$�

%����������� ��������������� �������$

Example ( 1.0 LT 2.0) -> TRUE

( N 0 E 10 GT N 10 E 0 ) -> FALSE

( N 0 E 10 GT N 10 E 0 ) -FALSE

Errors ��$�

NOT

Synopsis NOT log1 -> logical

Description ����� ���� ����� �NOT����� ����� ��� �$�

Side Effects ��$�

Example not TRUE -> FALSE

Errors ��$�

OR

Synopsis OR log2 -> logical

Description ����� ���� ����� ��� �����OR���#��#�� ����� ��� ��$�A���>� �����OR�����������������NE$B��

� �#��� ������������� ����� ��� ��$�

Side Effects &������������ ����������������������������TRUE!������� �����TRUE$�

Example TRUE or FALSE -> TRUE

Errors ��$�

Appendix C: PML 1 Expressions

C-6 PDMS Software Customisation Reference Manual

C.2.2. Logical Functions

��� ����� ������������� �� �����

Function Comments

BADREF �

DEFINED,UNDEFINED �

CREATED �

DELETED �

EMPTY �

MATCHWILD �

MODIFIED �

UNSET �

VLOGICAL �

BADREF

Synopsis BADREF (id) -> logical

Description TRUE����id������� ��!� ��FALSE$

Side Effects ���

Example BADREF(TREF) -> ’true’ if TREF=nulref

Errors ��$�

DEFINED and UNDEFINED

DEFined (variable_name) -> logical

DEFined (variable_name,number) -> logical

UNDEFined (variable_name) -> logical

Synopsis

UNDEFined (variable_name , number) -> logical

Description )���������� �!�DEFINED��������� ����������� ��������� !���������������� ������������������� � ��>����$�

)�����#������ ��!�DEFINED��������� ������������������ ������������������� �#������������� �����������>��������������������� �$�

UNDEFINED( !foo )����2���� �����NOT DEFINED( !foo ).�

Side Effects ��$�

Example DEFINED ( !var ) -> TRUE

DEFINED ( !array ) -> TRUE

DEFINED ( !array[1] )) -> TRUE

DEFINED ( !array , 1 ) -> TRUE

DEFINED ( !var) -> FALSE

UNDEFINED ( !array) -> TRUE

DEFINED ( !array , 3 ) -> FALSE

Errors ��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-7

CREATED

Synopsis CREATED -> logical

Description *�����TRUE������� ���������������������������$�

Side Effects ��$�

Example CREATED -> TRUE

Errors ��$�

DELETED

Synopsis DELETED -> logical

Description *�����TRUE������� ��������� ����������������$�

Side Effects ��$�

Example DELETED -> TRUE

Errors ��$�

EMPTY

Synopsis EMPTY(text) -> logical

Description *�����TRUE�����>�������H��� ���������!� ��FALSE�

Side Effects ��$�

Example EMPTY(‘’) -> TRUE

EMPTY(‘not empty’) -> FALSE

Errors ��$�

MATCHWILD

MATCHW/ILD( text1, text2) -> logical

MATCHW/ILD( text1, text2, text3) -> logical

Synopsis

MATCHW/ILD( text1, text2, text3, text4) -> logical

Description '������������text2����������text1$�&�������������� ����������TRUE!� ��FALSE$�text2� ���������#� ���������������$�

������� �������#� ����������IRD��������� ���������������!����I\D���������� ���������$�

)������������ ��!���� � ��� �#� ���������������IRD� ��������������text3$��

)������������� ��������� �#� ���������������I\D� ��������������text4$

Side Effects ���

Example MATCHW/ILD(’A big bottle of beer’,’*big*’) -> TRUE

MATCHW/ILD(’A big bottle of beer’,’??big*’) -> TRUE

MATCHW/ILD(’A big bottle of beer’,’???*big*’) -> FALSE

MATCHW/ILD(’A big bottle of beer’,’*big*beer’) -> TRUE

MATCHW/ILD(’** text’,’**!’,’!’) -> TRUE

Errors ��$�

Appendix C: PML 1 Expressions

C-8 PDMS Software Customisation Reference Manual

MODIFIED

Synopsis �

.---------------- -------------------. / | >- MODIFIED-(-+- attname -------*- DESCENDANTS –-+- +-comma +-attname –’ | | | | |- DESCENDANTS -. |- SIGNIFICANT --| | | | | | | |- SIGNIFICANT--| |- PRIMARY ----- | | | | | | | |- PRIMARY -----| |- OFFSPRING-----| | | | | | | |- OFFSPRING ---| ‘----------------’ | | | | | | | | | | ‘---------------+-------------------- +--+-- ) - OF – id � | ‘- �

Description ,����������������2������ �������� �����������$�*�����TRUE������ �������������������� ��$�

��������������� � ������� �#���������� �#���2�� ��������#������

OFFSPRING!�������������� ����� ����

SIGNIF!���������� � �������#���������� ������������������������?�

PRIMARY!������� � �������#���������� ��������������� �����?�

DESCENDANTS!������ �������������� �#�A�������B$�

���IOF’�����>� �������������������������$�

���MODIFIED��������������GEOM!�CATTEXT����CATMOD������@����������A�������>�-$5$5$3����������������������AFTERDATE�������$��

���MODIFIED!�DELETED����CREATED��������� ��������#���#�������PDMS�PML1�>������$��$$������Q/VAR����#������� ������

Side Effects ���

Q MODIFIED() *�����TRUE���� ���������������� ���������� ����������$��

&��#� �� ��������TRUE������� ����������������������� ����������$�

Q MODIFIED(POS,ORI) *�����TRUE����POS����ORI� ���������������� ����������$�

Q MODIFIED(P1 POS) *�����TRUE������������������P1����������$�

Q MODIFIED(GEOM DESCENDANTS *�����TRUE��������� ���������� �������������������������

Example

Q MODIFIED(PRIMARY) *�����TRUE������� ������#���������� �������� ���!����������$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-9

Q MODIFIED() OF /PIPE1 *�����TRUE����9PIPE1������� ���������������� ����������$�

Q (BUIL OR MODIFIED()OR ELECREC OF NEXT )

Errors ��$�

���MODIFIED!�DELETED����CREATED���������������� � ���#������'�5�>�������$�

UNSET

Synopsis UNSET(value) -> logical

Description *�����TRUE����value�������!� ��FALSE$������ ������������������������ �����ARRAYS$���� � �����#� ������-'����������$�

Side Effects ��$�

UNSET( DESC ) TRUE�#���DESC�����������>�����������

Example

UNSET(CRFA) FALSE�#���CRFA��������������������������

Errors ��$�

VLOGICAL

VLOGICAL��������������� ����� ��������������� �$�

VLOGICAL ( variable_name )) -> logical Synopsis

VLOGICAL ( variable_name , number) -> logical

Description )���������� �!����������� ����������� ��������� ��������� �������������������� � ������� ����� $�

)�����#������ ��!����������� �������� ���������������������>�� �������� ����� $�

����� �����������������

TRUE���������������’T’!�’TR’!�’TRU’����’TRUE’�A�����������B�������� ������ �����2�� ����H��?�

FALSE���������������’F’!�’FA’!�’FAL’!�’FALS’����’FALSE’�A�����������B������� ������ ��2�� ����H��$�

��� ��������� �� ����������>�$�,���>� � !�VTEXT(!var[1])�#� ������������$�

������������ �� ������������>$�,���>� � !�VTEXT (!array)�#� ������������$�

����� ������������� ���������� ����� $�

��� ���VTEXT!��������� ����� ������#�����>����� ������2����?����VVALUE!��������� ����� ������#����� ������� ������2����$�

Side Effects &�������� ��������� !���������������� !������������������� � ���������>���!������� ����������$�

Example VLOG ( !array[1] ) -> TRUE

VLOG ( !array , 2 ) -> FALSE

Appendix C: PML 1 Expressions

C-10 PDMS Software Customisation Reference Manual

Errors ��$�

C.2.3. Logical Array Expressions

������ �������>������������������

• �-'������������������� ����� ������$�,���>� � !�LOGARR�#���LOGARR�������UDA�������� ����� $�

• ������ ��������$���������������� �� �����TRUE!�ON!�YES��������?����FALSE!�OFF!���������� �$�

• ������ ���������$���������0$5$3$�

• ������ ��������$���������0$5$5$�

C.3. Numeric (Real) Expressions

&��-'��>�������!��������������������� �?���������� ����������� $��� ����>������������������

• �� ���!�����>� � ��:5!�36$3$��

�� ������������������������>����!�����>� � ��36�>��;!����;���<$�

�� �����������������$������ �����������MM!�M/ETRES!�IN/CHES!����FT, FEET$����� ��������������SQU/ARE!�CUBIC!�CUB/E���������@ ������ ��$�,���>� � ��366� !�36�>��;���������$�,������������������#���!�����>� � !��36D<��

• �-'�������������������� ��!�����>� � ��XLEN$�

• �������!�������������������������������#�������������������������������#���������������������������2����$�,���>� � !�POS[2]� ����������� ��������POSITION���������?��������!����������$�����������������!�������������������������������#���������������������� ����������� ���������>�������$�

• �����#����PI�A:$375B$��

• �� ������������$�

• �� �����������$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-11

C.3.1. Numeric (Real) Operators

���� ����������������� �� �����

Operator Comments

+ �������$�

- ����������$�

* '� ��� ������$�

/ -������$�

C.3.2. ADD and SUBTRACT (+ and -)"

number + number -> number

number – number -> number

+ number -> number

Synopsis

- number -> number

Description �����������������#��� ���$��������� ��������������������������������������������������������@>������$�

Side Effects %����������� ����������������������������$�

Example 1 + 2 -> 3.0

1 – 2 -> 1.0

+ 1 -> 1.0

- 1 -> -1.0�

Errors , ��������������� �#$�

C.3.3. MULTIPLY and DIVIDE (* and /)

number * number -> number Synopsis

number / number -> number

Description '� ��� ������������#��� ���$��������� ��������������������������������������������������������@>������$��� �������� �#������������������������������������������ ����������#����$������� �����������H��$�

Side Effects %����������� �������������'� ��� �����-����$�

Example 2 * 3 -> 6.0

2 / 3 -> 0.666666666�

Errors -��������H��$�

Appendix C: PML 1 Expressions

C-12 PDMS Software Customisation Reference Manual

C.3.4. Numeric (Real) Functions

���� ���������������� �� �����

Function Comments

ABS ( number1 ) /����������� ����� �������� ���

ACOS ( number1 ) /���������������������� ��!�������$�

ASIN ( number1 ) /�������������������� ��!�������$��

ATAN ( number1 ) /���������������������� ��!�������$�

ATANT ( number1, number2 ) /�������������������number19number2!�������!�#���������������������$�

ALOG ( number1 ) /�������>����� ��������A����� ����@ ��B������� ��$�

ARRAY(pos or dir or ori) 0���������������!����������������������� ����������������������� ���$�

ARRAYSIZE ( variable-name ) /���������H������������������ $�

ARRAYWIDTH( variable-name ) /������� ���������� ���#������������������������������� @� $�

COMPONENT dir OF pos2 /������� ���������������������#���� ��6��6�%6����pos2!����"�����������������dir1$�

INT ( number1 ) /���������������������� �������� ��$�

SIN ( number1 ) /���������!���������������� �������� ���A�������������������B$�

COS ( number1 ) /���������!���������������� �������� ���A�������������������B$�

TAN ( number1 ) /���������!���������������� �������� ���A�������������������B$�

LENGTH ( text1 ) /������� ��������>�3$�

DLENGTH ( text1 ) /������� �������text1$�DLENGTH��������#��������������#��������������� ����#����������������������� ������������������!���������=����$�

LOG ( number1 ) /������������ � ������� ������� ��$�

MATCH ( text1, text2 ) /��������������������������������� �� ���������������text2���text1$�&��text2����������������text1!�6���������$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-13

Function Comments

DMATCH ( text1, text2 ) /��������������������������������� �� ���������������text2���text1$�&��text2����������������text1!�6���������$��

DMATCH��������#��������������#��������������� ����#����������������������� ������������������!���������=����$�

MAX ( number1, number2[ , number3 [. . .]]) ) /������� �>� � ��� ������������ ��$�

MIN ( number1, number2[ , number3 [. . .]]) ) /������� �� � ��� ������������ ��$�

NEGATE '� ��� ����� ������@3$6$�

NINT ( number1 ) /������������������������ $��&��A�M6$;B����2�� �����M3��������������������2�� ����H��!�������������������$�

OCCUR ( text1, text2 ) /�������� �������� ��������text2����������������text1$�

REAL ( text1 ) �������������� ������������������text1$�

POWER ( number1, number2 ) /��������� �����number1���������������#��number2$�

SQRT ( number1 ) /��������2��������������� ��$�

VVALUE ( variable-name ) %������� ����� ��������������� �$�/�������� ��� �$�

ABS

Synopsis ABS ( number1 ) -> number

Description *������������ ����� ��������� $�

Side Effects ��$�

Example ABS ( -3.2 ) -> 3.2

Errors ��$�

ACOS, ASIN, ATAN and ATANT

Synopsis ASIN ( number1 ) -> number

ACOS ( number1 ) -> number

ATAN ( number1 ) -> number

ATANT ( number1, number2 ) -> number

Appendix C: PML 1 Expressions

C-14 PDMS Software Customisation Reference Manual

Description *����������@����!����@���������@����������� ��!�������$�

ATANT�������������@��������number1/number2�#���������������������$�ATANT�������� �#������������� �����������2�� ����H��$��

,���>� � !�A<�6������B�#� ������������������ �����46�����!�����A<�6�-�����B�#� ���������������#��������������������H��$�

Side Effects ��$�

Example ACOS ( 0.8660254 ) -> 30

Errors ���� �����ACOS������&�������������T@3$6!M3$6U�

ATANT (0.0,0.0)���������$�

ALOG

Synopsis ALOG ( number1 ) -> number

Description *�������>����� ��������A����� ����@ ��B������� ��$�

Side Effects �� �������� �#������������� �������������H��$�

Example ALOG( -0.7 ) -> 0.4965853

Errors , ��������������� �#$�

ARRAY

Synopsis ARRAY(pos or dir or ori) -> number

Description 0���������������!����������������������� ����������������������� ���$�

Side Effects ���

Example ARRAY(e100 ) -> 100 0 0

Errors ��$�

ARRAYSIZE

Synopsis ARRAYSize ( variable-name ) -> number

Description /��������H������������������ $�

Side Effects &����������������� ��������>���!������� ����������$�

Example ARRAYSIZE(!array) -> 2.0

Errors ��������� ��������� ��������� ��������������������� $�

��������� ������������������ � ���������������������� $�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-15

ARRAYWIDTH

Synopsis ARRAYWIDTH ( variable-name ) -> number

Description /������ ���������� ���#������������������������variable_name$�

Side Effects ��$�

Example &���������������������� �#����� ����

!ARRAY[1] ’Bread’

!ARRAY[2] ’is’

!ARRAY[3] ’for’

!ARRAY[4] ’life,’

!ARRAY[5] ’not’

!ARRAY[6] ’just’

!ARRAY[7] ’for’

!ARRAY[8] ’breakfast’

���

ARRAYWIDTH(!ARRAY -> 9

�$$���� �������D��������D$�

Errors ��������� ��������� ��������� ��������������������� $�

��������� ������������������ � ���������������������� $�

COMPONENT ... OF ...

Synopsis COMPonent dir1 OF pos2 -> text

Description *�������� ���������������������#���� ��6��6�%6����pos2!����"�����������������dir1.�

Side Effects ��$�

Example COMP E 45 N of N 0 E 100 U 50 -> 70.710

Errors ��$�

SINE, COSINE and TANGENT

SINe ( number1 ) -> number

COSine ( number1 ) -> number

Synopsis

TANgent ( number1 ) -> number

Description *���������!���������������� �������� ���A�������������������B$�

Side Effects ��$�

Example COS ( 0.0 ) -> 1.0

TAN ( 45.0 ) -> 1.0

Errors -����������H�������TAN�������������A�� �B�2�� ����H��$�

Appendix C: PML 1 Expressions

C-16 PDMS Software Customisation Reference Manual

INT

Synopsis INT ( number1 ) -> number

Description *���������������������� �������� ��$�

Side Effects ��$�

Example INT ( 1.6 ) -> 1.0

INT ( -23.7 ) -> -23.0

Errors &�������� �#$�

LENGTH and DLENGTH

Synopsis LENgth ( text1 ) -> number

DLENgth ( text1 ) -> number

Description *������� �������text1$��

DLENGTH�����������#��������������#��������������� ����#����������������������� ������������������!���������=����$�

Side Effects ��$�

Example LENGTH ( ’abcdef’ ) -> 6.0

LENGTH ( ’’ ) -> 0.0

Errors ��$�

ALOG

Synopsis LOG ( number1 ) -> number

Description *������������ � ������� ������� ��$$�

Side Effects ��$�

Example LOG( 3 ) -> 1 0986123

Errors ����������� ��$�

MATCH and DMATCH

'�����A��>�3�!��>�5B� -> number Synopsis

-'�����A��>�3�!��>�5B� -> number

Description *��������������������������������� �� ���������������text2���text1$�&��text2����������������text1!�6����������

DMATCH�����������#��������������#��������������� ����#����������������������� ������������������!���������=����$�

Side Effects ��$�

Example '��0.�A�D�����D�!�D��D�B�@K�:$6�

'��0.�A�D�����D�!�D>D�B�@K�6$6�

'��0.�A�D�����D�!�DD�B�@K�3$6

Errors ��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-17

MAX and MIN

Synopsis MAX ( number1 , number2 [ , number3 [ ... ] ] ) -> number

MIN ( number1 , number2 [ , number3 [ ... ] ] ) -> number

Description *������� �>� � ���� �� � ��� ������������ ��$�

Side Effects ��$�

Example MAX ( 1 , 3.4 ) -> 3.4

MIN ( 7.6 , -12.33 , 2.3 ) -> -12.33

Errors ��$�

NEGATE

Synopsis NEGate ( number1 ) -> number

Description '� ��� ������ ����@3$6$�

Side Effects ��$�

Example NEG ( 1 ) -> -1.0

Errors ��$�

NINT

Synopsis NINT ( number1 ) -> number

Description *������������������������ $�NINT(N+0.5)����2�� ����N+1����N���������������2�� ����H��!����N����N���������$�

Side Effects ��$�

Example NINT ( 1.1 ) -> 1.0

NINT ( -23.7 ) -> -24.0

NINT ( 1.5 ) -> 2.0

NINT ( -11.5 ) -> -12.0

Errors &�������� �#$�

OCCUR

Synopsis �00%*A�>�3!��>�5B� -> integer

Description 0��������� �������� ��������text2����������������text1�

Side Effects ��$�

Example OCCUR (’ABBACCBBBBBAB’, ’BB’) -> 3

OCCUR(’ZZZZZZZZZZZ’, ’A’) -> 0

Errors ��$$�

Appendix C: PML 1 Expressions

C-18 PDMS Software Customisation Reference Manual

REAL

Synopsis REAL ( text1 ) -> number

Description ��������������� �� ������������������text1$��

�������������>������������� ������>���!�A@35�@3������������>� � B!����� ������������������$��

�����������������#������ � ���� ��NUMBER$�

Side Effects �� �������� �#������������� �������������H��$�

%����������� ���������������)�*$�

Example REAL ( ’12.34’) -> 12.34

REAL ( ’ 7.23 E 3 meters’ ) -> 7.23

REAL ( ’ -12E-1 meters ’ ) -> -1.2

Errors %�� ��������������>���������� �� ��$�

POWER

Synopsis POWer ( number1 , number2 ) -> real

Description *��������� �����number1���������������#��number2$�

Side Effects ��$�

Example POWER ( -2 , 3 ) -> -8

Errors , ��������������� �#$�

S������������� ������@����������������� ��A������ �����������H��B$�

����������������� ������@�������������� �$�

SQRT

Synopsis SQrt ( number1 ) -> number

Description *��������2���������������� $�

Side Effects %����������� �������������SQRT$�

Example SQRT ( 4 ) -> 2.0

Errors ����������� �$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-19

VVALUE

VVALUE��������������� ����� ��������������� �$�

�����A������� _� �B� -> number Synopsis

�����A������� _� �!�� ���B� -> number

Description )���������� �!��������� ����������� ��������� ������ �������������������� � �������� ��$�

)�����#������ ��!��������� �������� ���������������������>�� ��������� ��$�

��� ���VLOGICAL!��������� ����� ������#���� ����� ���� ������2����!����VTEXT!��������� ����� ������#�����>����� ������2����$�

Side Effects &�������� ��������� !���������������� ������������������� � ���������>���!������� ����������$�

Example VVAL ( !array[1] ) -> 1.0

VVAL ( !array , 2 ) -> 0.0

Errors ��� ��������� � ����������>�$�,���>� � !�VTEXT (!var[1]) )�#� ������������$�

������������ � ������������>$�,���>� � !�VTEXT ( !array ) )�#� ������������$�

������������������������������ ��$�

Appendix C: PML 1 Expressions

C-20 PDMS Software Customisation Reference Manual

C.3.5. Real Arrays

*� �������>������������������������������������ ������!�����>� � ��DESP$�

C.4. Using IDs in Expressions

&-�������������>�������$�&-������������������ �#�����

• � ��� !�����>� � ��/VESS1$�

• *��!�����>� � ��O5:97;<$�

• � ���������������������������!�����>� � ��SITE$�

• �� ���#����� ��� ���!�����>� � ��:$�

• �������� ���#����� ��� ���!�����>� � ��BOX 3$�

• ��E�!��*�������>�!���������#����������� ���$������� ��#�������������9��� �����!�����>� � ��NEXT 2 BOX, LAST CYL$�

• NEXT!�PREV�MEMBER�����>�!���������#����� ��� ���$������� ��#��������������9��� �����$��

&����� �������������� ���� �������� ������MEMBER�������� �$�,���>� � !�NEXT�BOX������EQUIPMENT�#� ����� �MEMBER$�

• FIRST!�LAST�������������� ������������ ���$������� ��#�������������9��� �����$�

• FIRST!�LAST�MEMBER�������������� ������ ��� ���$�&����� �������������� ���� �������� ������MEMBER�������� �$�

• END����������������� ������� ���$�

END������ � �������#���������2��������� $�,���>� � !������������� �������GROUP�MEMBER!���������������������� ����GROUP����END�#� ����������������������OWNE�#� ���������������#�$�

• ������������������!�����>� � ��CREF�

• SAME���� �� ���������� ��

• NULREF���� ��O696�

• CE�������������� ��

• ’OF’� ������������������������������� �$�,���>� � ��

SPEC OF SPREF OF FLAN 1 OF NEXT BRAN.

• �������������SPEC� ���#����������� �����������������SPREF���������������������FLANGE�������>��BRANCH$�ILEAVE�TUBE!�IARRIV�TUBE!�HEAD�TUBE!�TAIL�TUBE���������������������$�,���>� � ���

HEAD TUBE OF /BRAN1.

�������#� �������������������� � �������������� �������$�

ID������������ �����������>�������$�,���>� � !�CRFA.

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-21

Note: �� �������ID�����>�� �����#�������������$����� �#���������!������>������� ���� #������������#���������#����ID$�,���>� � !�ID�3�#� � ����������� ��������������� ����������������� �������� ��:$�

C.5. Positions, Directions and Orientations in Expressions (PDMS only)

C.5.1. Using Positions in Expressions

���������#���������������������������

• ������������������ ��������� �)*�$�,���>� � ���

POS OF /VESS1 WRT /* or P1 POS OF /CYL2

• 0��������������$�,���>� � ��

N 45 W 20000 U 1000

• 0������������������ ��� �$�,���>� � ���

N 1000 FROM /ATEST.

• 0������������������ ��������$�,���>� � ���

N 1000 FROM P1 OF /BOX2.

• 0������������������ �����������$�,���>� � ���

N 1000 FROM POSS OF /SCTN1

• ���� ������ ��#��������������� ������ ������>������$�,���>� � ������� �#���������� �����������>�������

N (DESP[1] + 10) E

���0��������������� ��������� ������ �#�����WRT���������������>������� $���������0$;$5$�

Appendix C: PML 1 Expressions

C-22 PDMS Software Customisation Reference Manual

C.5.2. WRT (PDMS Only)

���WRT���#������������������ ���#����� ������� ���������$��

)��#���������� ��A����������������� �B�#������������������� ����������#�� ������$��������������������#�� ������������ �������>��$���� � �������#������2������ ������������#���>������� �������������������������� �$�,���>� � ��

Q POS $ will return the position of the current element $ relatively to its owner.

Q POS OF /EQUIP1 $ will return the position of EQUIP1 relative to its $ owner.

&��#��2���������� ������ �������>������� �������)*����#����������$�,���>� � ��

Q POS WRT /* $.for the position in world coordinates.

)��#����������0����������������#������ ���#������� ������������$��

,���>� � !�D��36D���� ��� ������ �#������������>������� !�������� ��������>������� $��

�����#����WRT�����������!�� �������������� �����������������������������#������������ ���� ���������������������� �����������A�������������>� � �WRT�#���������������� ������� ����������������� ������B$��

,���>� � ��

N 100 WRT /BOX1 $ specifies an absolute position in world space $ which is N100 of /BOX1.

������� ����������0��������������������������#��� �D���>������� $���������� ����������������>���������������������������� ���������� ��������������#�D���>������� $�

Note: ���CONSTRUCT�����>��������#�� ������������ ���>���

Example

Item Comments

��SITE����A6!6!6B� )�������� ��A)�� �B����������

��ZONE����A366!6!6B� )�������� ��A)�� �B����������

��EQUIPMENT����A366!6!6B� )�������������’N IS E�

��BOX����A@366!6!6B� )�������� ��A)�� �B����������

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-23

(-100, 0) wrt Equipment

World origin Site origin

Zone origin (100, 0) wrt World

Equipment origin

(200, 0) wrt World (100, 0) wrt Zone

N

E

N

E

W

N

Box origin

W

N

(100, 100) wrt Zone (200, 100) wrt World

point (300, 100) wrt World

�Figure C- 1: Results of WRT

������ �����Q (N 100 WRT /BOX1)!����#����⊗���,���r�0@�3!�#� ���������������� �$�

Location Result

)�� �� A:66!366!6B!���)�� �����������$�

���� A:66!366!6B���)�� ���������������������)�� ���������#�������������� �$�

S�� A:66!366!6B���)�� �����������!���������������������#�������������� �!����������������������������� �������)�� �����������$�

�2��� �� A566!366!6B!�#�������������������� �������������#�!����S�$�

1�>� A366!366!6B�#�������������������� �������������#�!�����2��� �$�

WRT�������������2�� ��������FROM$�

Appendix C: PML 1 Expressions

C-24 PDMS Software Customisation Reference Manual

C.5.3. FROM

&��� ������#��2��������������� �����>������!���������������������������� $�,���>� � !�������������������$��

���FROM�����>����������������$�)� ������ ����WRT����� �������#����FROM!�������������������WRT����� ������������ ������>�������������������������!�������������������������������FROM�����$��

0����������� �#����

Item Comments

��SITE����A6!6!6B� )�������� ��A)�� �B����������

��ZONE����A366!6!6B� )�������� ��A)�� �B����������

��EQUIPMENT����A366!6!6B� )�������������’N IS E�

��BOX����A@366!6!6B� )�������� ��A)�� �B����������

(-100, 0) wrt Equipment

World origin Site origin

Zone origin (100, 0) wrt World

Equipment origin

(200, 0) wrt World (100, 0) wrt Zone

N

E

N

E

W

N

Box origin

W

N

(100, 100) wrt Zone (200, 100) wrt World

point (200, 200) wrt World

�Figure C- 2: The Effect of FROM

������ �����Q (N 100 WRT /* FROM /BOX1),����#����⊗���,�����0@�5!�#� ���������������� �$�

Location Result

)�� �!����!����S�� A566!566!6B������������������366������� �����#�� ����>�������������91�E3��>��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-25

Location Result

�2��� �� A366!566!6B$������������� ���>������������� ���������S�$�

1�>� A566!6!6B!�������������� ���>������������� ����������2��� �$�

������ �����’Q (N 100 WRT /BOX1 FROM /* )������������

Location Result

�������S�� A366!6!6B�

�2��� �� A6!6!6B�

1�>� A6!�@366!�6B!�����������>������������� ���������2��� �$�

������ �����’Q (N 100 FROM /* )’������������������$�

,��������#������ ���������� ������������������� ������������ ��WRT�#� ������#������������� �$�&�������������SITE!�ZONE!�EQUI���������⊗���� �������,�����0@�:!�����������BOX�����������������#�������ZONE$�

(-100, 0) wrt Equipment

World origin Site origin

Zone origin (100, 0) wrt World

Equipment origin

(200, 0) wrt World (100, 0) wrt Zone

N

E

N

E

W

N

Box origin

W

N

(100, 100) wrt Zone (200, 100) wrt World

point (200, 0) wrt World

�Figure C- 3: Varying WRT

Location Result

�������S�� A6!366!6B�

�2��� �� A@366!366!6B!�������������� ����� ���>���������S�$�

Appendix C: PML 1 Expressions

C-26 PDMS Software Customisation Reference Manual

Location Result

1�>� A6!�@366!�6B!�����������>������������� ���������2��� �$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-27

C.5.4. Comparing Positions

�#������������������ �����#����EQ!�NE!�GT!�LT!�GE����LE$��������������������������� ���� ��������������������>������#���������#������������������$��������������������� #��������� �������������������$��

,�������������������������!�� �����������������#�����������������������������$�,���>� � ��

’N10U3’ $ only the Y and Z coordinates are defined, $ while the X coordinate remains undefined

,������EQ��������!�� �������������������������������� ����2�� $�,���NE!�� �������������������������������������$�,���GT�ALT!GE!LEB!�� ������������������������������������������� ��������������A ������!��������������2�� ���!� ����������2�� ���B�������������������������������������$������ ��������GE���������������������LT����LE���������������������GT$��

&��������������������#��������������������������� ���>���A$�$�D�36D����D)7-LDB!������� ���������� ���������������$��

Examples

’POS EQ W1S2D3’ $ This evaluates to true only if POS of the current $ element is (-1,-2,-3).

’POS GT N10’ or ’N10 LE POS’ $ Only the second coordinate of POS is compared; $ if it is greater than 10, then the result is true.

’E10N10 GT E0N0’ $ Is true because the inequality is verified for the X $ and Y axis (both coordinates are undefined for $ the Z axis, so it is ignored).

’E10N0 GT E0N0’ $ Is false because the Y components are different $ axes.

’E10N0 GT E0U100’ $ Is true. Although no comparison can be $ performed n either the Y or the Z axis, because $ the components are not present in both position $ constants, the comparison is true in the X $ component.

’N10 EQ W4D7’ $ Is undefined (no comparison is possible).

��� ���������0$33!�������������0� �������������� ��������� ������� ���$�

Appendix C: PML 1 Expressions

C-28 PDMS Software Customisation Reference Manual

C.5.5. POLAR

���POLAR���#����� �#������������������������� ������������������������� �������������� �������$�

�������>�����

POLAR dir DISTance expr -+- FROM -+- pos -----. | | | | `- point ---| | | ‘--------------------+--->

&��FROM���������������������� ���������������������#�$�

,���>� � ��

POLAR N 45 E DIST 20M FROM U 10 M

POLAR AXES PL OF PREV DIST ( ABORE * 10 ) FROM PL OF PRE V

C.5.6. Direction

���������#���������������������������

• -����������������� ��������� �)*�$�,���>� � !��

HDIR OF /PIPE1 WRT /*

• 0��������������$�,���>� � !��

N 45 W

• 0���������������WRT������ �$�

� �0�������������������������������>����������#�������������� �$�,���>� � ��

(U WRT CE )

#� ���������S��>��������������� ��� �������������#�$�

Q ( Z WRT /SCTN )

#� ���������S��>��������������9SCTN�� ������������#�������������� �$�,���>� � !���������� ������2�������#�� ��������������������� �� ���������)�� ����������$�

• FROM����5�TO����5$�,���>� � �

FROM N 50 WRT CE TO N 100

• (�#����AXES��� �#��������@��������� �$�

���CLOSEST���#���!�#�����#� ��������� ����� ������������� ����������$��������>�����

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-29

>- CLOSEST type -+- WITH exp -. | | `------------+- DIRECTION dir -+- EXTENT val -. | | `-- ------------+--> cont continued >-+- AFTER val -. | | `-------------+- FROM ? -. | | `----------+-->

&��������������������#���������

EXTENT!�#����������#����������������������������������!����� ��36'�

AFTER!��������������� ��������������#�������������������!����� ��6'�

FROM!�#���������������� ��������������������������������� �$������������������� ������������������#������� �����#����������������HPOS����TPOS$�

�>� � ������

CLOSEST DIR E CLOSEST BOX WITH ( PURP EQ ’FLOO’ ) DIR D WRT /* EXTENT 20M CLOSEST VALVE DIR N 45 U FROM E100 N200 U300 CLOSEST BRAN HANG AFTER 2M

C.5.7. Orientations

���������#����������������������������

• ������������������� ��������� �)*�$�,���>� � ��

ORI OF /BOX1 WRT /*

• 0���������������$�,���>� � ��

dir IS dir AND dir IS dir

,���>� � ����������������������� ��������������������!�����������46����������

(E IS U WRT /SCTN1 AND N IS E WRT /SCTN1)

• ����E�����#���!�#�����#� �� �#������������@�������������������������$�

�������>�����

Appendix C: PML 1 Expressions

C-30 PDMS Software Customisation Reference Manual

----<---------. / | >-- AXES --*--- PArrive ---| | | |--- PLeave ----| | | |--- PTail -----| | | |--- HHead -----| | | |--- HTail -----| | | `--- PPOINT n --+-- OF - <gid> ---->

��>� � �����

( AXES PLEAVE IS AXES PLEAVE OF PREV AND AXES P3 IS UP )

�����#� ���������������� ���!������������� �!���������������� ����#����������������� ������������:������$�

��� ���������0$;$7!�0� ��������������$�

C.6. Text Expressions

�>��>���������������������� �#����

• ���>�������!�#����� ������� ������2����$�,���>� � ��D,*�-D$�

• ���-'�������������������>�����#���$�,���>� � ��,%�0�

• ����� � �������#������������������$�,���>� � ������T5U$��

• �>�����������

• �>����������

C.6.1. Text Operator

����>�������������� �� ����M!������������������$�

Synopsis text1 + text2 -> text -> text

Description *���������������������#���>��������$�

Side Effects ��$��

Example ’no’ + ’space’ -> ’nospace’

Errors �>����� ������ ��$�

C.6.2. Text Functions

����>�������������� �� �����

Function Comments

�,��* �

1�,�*� �

-&����0� �

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-31

��)0���!�%�0��� �

��*�� �

*����0�� �

��*&�/� �

�%1�!�-�%1�� �

�*&'� �

���E�� �

AFTER

Synopsis AFTER ( text1 , text2 ) -> text

Description *�������������������text1�#���������������� �� ���������������text2���text1$��

&��text2����������������text1!����� ���������������$�

Side Effects ��$�

Example AFTER ( ’abcdef’ , ’cd’ ) ->’ef’

AFTER ( ’abcdef’ , ’x’ ) -> ’’

AFTER ( ’abcdef’ , ’’ ) -> ’abcdef’

Errors ��$�

BEFORE

Synopsis BEFORE ( text1 , text2 ) -> text

Description *�������������������text1�#���������������� �� ���������������text2���text1$�&��text2����������������text1!��>�3���������$�

Side Effects ��$�

Example BEFORE ( ’abcdef’ , ’cd’ ) -> ’ab’

BEFORE ( ’abcdef’ , ’x’ ) -> ’’

BEFORE ( ’abcdef’ , ’’ ) -> ‘’

Errors ��$�

DISTANCE

DISTance ( number1 ) -> text Synopsis DISTance( number1, logical1, logical2, logical3, number2, logical4)

-> text

Appendix C: PML 1 Expressions

C-32 PDMS Software Customisation Reference Manual

Description ,�������@���� ����� !����������������������������FINCH!��>������������������������� � �������� ��number1����������� ���D��D��$��9��D$�����#��!��>��������STRING������������number1$�

�����>@���� ����� ���� ����� � >$������� �������

DIST/ANCE (distance, feet, usformat, fraction, denom_or_dp, zeros)

#����

• distance�������� ���������������������������������� ����$�

• feet������ ����� �� ���������������������������������������������������� ��������������������������$�

• usformat������ ����� ��������������%����� �������������������� ������-'����� ��������������$��

• fraction������ ����� ������������������������� ��� ������������������������������������� ������������������������� � ��� _��_��������� �������������� �������� ���������fraction�����TRUE���������������� ��������� � �� �������������FALSE$��

• HHHH������������������ ����� ��������������H���������������#�#��������� ������������������������� ��

,��������%������-'����� ��������� �#����� �������������

• &��distance���������!������������ �� ������ �������$�

• &��feet��������������������������� ����������!�������� ��������������������>�!��� �#���������� �2����ADB$�� �����H�����������#� ����� ����������������������6������������� �������������$�����#���������#� ���� ����$�

• &�����������������!���������#� ������ �����#������������#��$��� ���� ���������#� ����������������������%����� �������������������H�������-'����� ���������$���H���#� ����������������������#�� �����$�

• &��������������������������������������� ���������!�������� ������������������ ��������#����������������������$�� �����H�����������#� ���6������������������������� ������������$��

• &�����������������������fraction�������!�����#� ����� �#���������� � ������A$B$�

• &��fraction����TRUE�������� ����������������� ��� ���!�������� �������������� ������������#��������������� ����A9B$������������� ������������������#������������� ������� ����������� ������#�� �����$�

• &�������i�����FALSE�������� ��������� � �� �����������������H��!���������� � ������A$B�������� ������ �#��������� �������������������������� ��������� � �� ���$�&������ ��������� � �� �������6���������� � ���������������#�����$�

&��%����� ���������� ������������ �#����������� ��� ����������������������

• ���ADB���������� �������������� �#������������A@B$�

• ������ � �������������������������� ����������������� �������������$�

• ��������������������������������� �#����������� �2���AGB$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-33

Side Effects ��$�

Example &��������������������������FINCH��

DISTANCE ( 17.5 ) -> ’1’5.1/2’

�� ��>� � �!�#���������������������������������������

DIST(34.5,TRUE,TRUE,TRUE,100,TRUE) -> 2’-10.1/2.

DIST(34.5,FALSE,TRUE,FALSE,1,TRUE) -> 34.5”

DIST(34.5,FALSE,TRUE,TRUE,4,FALSE) -> 34 1/2”

DIST(128.5,TRUE,FALSE,TRUE,2,TRUE) -> 10’08.1/2”

����� �#������ ����#������������������������ ���������������������� ������������������������������������ ���$�1 ��������������������� ����������������������A_B$�

Distance Feet & Inch US Fraction Denom 100 Zeros

Feet & Inch US Fraction Denom 32 No Zeros

Inches US Decimal DP 1 Zeros

Inches US Fraction Denom 4 No Zeros

Feet & Inch PDMS Fraction Denom 2 Zeros

128.5 10’-_8_1/2”___ 10’-_8_1/2”__ 128.5” 128_1/2” 10’08.1/2

120.0 10’-_0”_______ 10’-_0”______ 120.0” 120”____ 10’00____

11.5 0’-11_1/2”___ 11_1/2”__ 11.5” 11_1/2” 0’11.1/2

0.75 0’-_0_3/4”___ 3/4”__ 0.8” 3/4” 0’01____

0.0 0’-_0”_______ ______ 0.0” ____ 0’00____

-10.0 -0’-10”_______ -10”______ -10.0” -10”____ -0’10____ Errors ����� ������������������������$�

LOWCASE and UPCASE

UPCase ( text1 ) -> text Synopsis

LOWCase ( text1 ) -> text

Description *�������������� �#���������������text1$�

Side Effects ��$�

Example UPCASE ( ’False’) -> ’FALSE’

LOWCASE ( ’False’) -> ’false’

Errors ��$�

PART

Synopsis PART(text1, number1) -> text

PART(text1, number1 , text2) -> text

Description )�����#������ ��!����������number1��� �������text1����� ��������text1������ ��������#�����������������$�&��number1���������!������������� ��������������� ���������$�

)������������ ��!��������!��������text2������������������#������� ������������ ��$�

&���������������������� ����������������� �������� ���������������!������������������� ���������$�

Side Effects ��$�

Appendix C: PML 1 Expressions

C-34 PDMS Software Customisation Reference Manual

Example PART (’x-y-z’, 1, ’-’ -> ’x’

PART (’a b c d e’, 4-> ’d’

PART (’/PIPE45/B9’, -1, ’/’) -> ’B9’

PART(’aa bb cc’, 2) -> ’bb’

PART(’aa-bb-cc’,3,’-’) -> ’cc’�

Errors ��$�

REPLACE

*������A�>�3!�>�5!�>�:B� -> text

*�����A�>�3!�>�5!�>�:!��3B� -> text Synopsis

*�����A�>�3!�>�5!�>�5!��3!��5B� -> text

Description *� ���������������text2��������������text1�#������ �� ��������text3$��

&��int1�����������������������������������������text2����#���������������� �� �$��

&��int2������������������������� �������� �� ������ ��$���3���9���int2� ��������������������������������������������#����$�

Side Effects ��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-35

Example �������� ����

REPLACE (’cat dog cat cat dog ’, ’cat’, ’dog’ ) -> ’dog dog dog dog dog’

� �������������D���D������ ����#����D���D$�

,�������� �����������������������

REPLACE (’cat dog cat cat cat dog’, ’cat’, ’dog’, 2) -> ’cat dog dog dog dog dog

� ������������D���D���� ������������������#���������� ����#����D���D�

REPLACE(’cat dog cat cat dog’ ,’cat’, dog’, -2 -> ’dog dog dog cat dog’

� ���������������������������������������� ��������������������� ���������#���������� �������������������������������� ��#������������������� ��� � �������#����� ��$�

,������� ���������������������� �������� �� ������$�*� ����#��������������D���D��������������������������

REPLACE (’cat dog cat cat cat, ’cat’,’dog’, 2,2) -> ’cat dog dog dog cat’

*� ����#�����������������#�����������������������������������������

REPLACE (’cat dog cat cat cat’, ,’cat’, ’dog’, 2, -2) -> ’dog dog dog cat cat ’�

*� ����#����������������#���������������������������������������� �������������������

REPLACE (’cat cat cat cat dog’, ’cat’, ’dog’,-2,2) -> ’cat cat dog dog dog’

*� ����#�����������������#���������������������������������������� �����������������$�

REPLACE (’cat cat cat cat dog’,’cat’, ’dog’, -2, -2) -> ’cat dog dog cat dog’

����� �#���>� � ��� ���������� ���� ����

REPLACE(’cat1 cat2 cat3 cat4 cat5 cat6 cat7 cat8 cat9 cat10’, ’cat’, ’dog’, 4, 2)

REPLACE(’cat1 cat2 cat3 cat4 cat5 cat6 cat7 cat8 cat9 cat10’, ’cat’, ’dog’, 5, -2)

REPLACE(’cat1 cat2 cat3 cat4 cat5 cat6 cat7 cat8 cat9 cat10’, ’cat’, ’dog’,-6, -2)

REPLACE(’cat1 cat2 cat3 cat4 cat5 cat6 cat7 cat8 cat9 cat10’, ’cat’, ’dog’, -7, 2)�

&��������!���������������������

’cat1 cat2 cat3 dog4 dog5 cat6 cat7 cat8 cat9 cat10’

&������� �� ��������text3������� �����������2������ ���������������������������������text2����� ���$�,���>� � ��

REPLACE (’AAABBABZ’, ’B’, ’’) -> ’AAAAZ’

REPLACE (’AAABBABZ’, ’B’, ’’, -1, -1) -> ’AAABBAZ’

Appendix C: PML 1 Expressions

C-36 PDMS Software Customisation Reference Manual

Errors &����������������text1������� �����������������>����������!���������������text1����������������$�,���>� � ��

REPLACE (’’, ’A’,’B’) -> ’’

&�����������������text2���� ����������������������text1!���������������text1����������������$�,���>� � ��

REPLACE(’AA’, ’AAAAA’ , ’B’) -> ’AA’

&������������������������������text2��������!���������������text1����������������$�,���>� � ��

REPLACE( ’AAAAAA’,’B’,’C’) -> ’AAAAAA

&���2�������������int1��������������������������text1����������������$�,���>� � ��

REPLACE(’AAAAAA’, ’A’, ’B’, 10 ) -> ’AAAAAA’

&������ �������� �� ����2�����int2���������������������� �� ����������������� �������������������������!��� �� ������ ��������������������������A����������������#����� ��B$�,���>� � ��

REPLACE(’AAAAAA’, ’A’, ’B’, 2, 8) -> ’ABBBBB’ REPLACE (’AAAAAA’, ’A’, ’B’, -3, 8) -> ’BBBBAA’�

STRING

��*���A������� �������B� -> text

��*���A�� ���!��>�3�B� -> text Synopsis

��*���A�����!��>�3�B� -> text

Description ��������� ���������>�������$��

)��������� ����� �������*&�/���������������� ����������� �#������ ���������������

• �� ����

• ������ �

• &��

• ��������

• -�������

• ���������

)����� �������� �!���� � �� ����������������������� �>� � ������>�����������������$����� ���H�������� #����� ��������������$�

)�����#������ ��������������� ����������� ����A��� ��B����������������������$�)�����#������ ��!���������� ���������������������>������������������� ��������������text1!�#����� ������������������ �����#�D-6D����D-<D�A���D�6D����D�<DB!�#������� ��������������� ��������� � �� ���$�

,���� ���!�STRING�� #�������������� ������ � � ���$�&��������������������������DIST������������ �������$�,�����������!����������������������������$�

Side Effects ��$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-37

Example STRING ( 1 ) -> ’1’

STRING ( 1 , ’D3’ ) -> ’1.000’

STRING ( 1.23456789 ) -> ’1.23457’

STRING(1.1230000) ->’1.123’

STRING ( 1.23456789 , ’D3’ ) -> ’1.235’

STRING (9*9 LT 100) -> ’TRUE’

STRING (OWN OF CE) -> ’/PIPE1’

STRING(POS) -> ’W1000 N20000 U18000’

STRING(POS, ’D4’ ) -> ’W10000.1234 N20000.1234 U18000.1234’

STRING(HDIR OF /PIPE1-1) -> ’D’

STRING(E 22.0125 N, ’D2’) -> ’E 22.01 N’

STRING (ORI OF NEXT) -> ’Y IS D AND Z IS U’

Errors �

SUBSTRING and DSUBSTRING

Synopsis SUBString ( text1 , number1 ) -> text

SUBString ( text1 , number1 , number2 ) -> text

DSUBString ( text1 , number1 ) -> text

DSUBString ( text1 , number1 , number2 ) -> text

Description )�����#������ ��!���������������������text1���������������������number1������������text1$��

)������������ ��!���������������������text1���������������������number1������� ����number2$�&��number1���������!���������������������������������� ����*.������������������$�&��number2���������!������������������������� ������������������������������$�

DSUBSTRING�����#��������������#��������������� ����#����������������������� ������������������!���������=����$�

&��������������������������������� ������!��� �������������������

Side Effects ��$�

Example SUBSTRING ( ’abcdef’ , 3 ) -> ’cdef’

SUBSTRING ( ’abcdef’ ,-3 ) -> ’abcd’

SUBSTRING ( ’abcdef’ , 3 , 2 ) -> ’cd’

SUBSTRING ( ’abcdef’ , -3, 2 ) -> ’de’

SUBSTRING ( ’abcdef’ , 3 , -2 ) -> ’bc’

SUBSTRING ( ’abcdef’ , 10 ) -> ’’

SUBSTRING ( ’abcdef’ , -10 , 2 ) -> ’ab’

Errors ��$�

TRIM

TRIM ( text1 ) -> text

TRIM ( text1, text2 ) -> text

Synopsis

TRIM ( text1, text2, text3 ) -> text

Appendix C: PML 1 Expressions

C-38 PDMS Software Customisation Reference Manual

Description )��� �������� ��������� ��!�TRIM�� ����� ������������� ���A ����B����������A���� ��B����text1���������������#�����>�$�

)���#������ ���������� ��!�text2���������#���������������� ����� ������� �������D�D����D D����� ��!�D*D����D�D����������!����D'D����D D����� � ��� �A#��� � ��� �������������� ��������2�H���������� ������B��������� �������������������� ����$����������� �����D�*D�#��������� ������ ����$�

)��������������� ��text3����� ������� ��!���������� ��� ��������� ����������#���������������������������������������������������� �$�

Side Effects ��$�

Example TRIM ( ’ How now, brown cow ’, ’LRM’ ) -> ’How now, brown cow’

TRIM ( ’10.3000’, ’R’, ’0’ ) -> ’10.3’

Errors ��$�

VTEXT

VTEXT��������������� ����� ��������������� �$�

VTEXT ( variable-name ) -> text Synopsis

VTEXT ( variable-name , number ) -> text

Description )���������� �!������������� ����������� ��������� ��������� �������������������� � �$��

)�����#������ ��!������������� �������� ���������������������>�� ��$��

����� �����������������>�������$�

��� ���VLOGICAL��������� ����� ������#���� ����� ���� ������2����!����VVALUE��������� ����� ������#����� ������� ������2����$�

Side Effects &�������� ��������� !���������������� ������������������� � ���������>���!������� ����������$�

Example ���E��A�P����B�@K�D� �D�

���E��A�P�����T3U�B�@K�D3$66D�

���E��A�P������!�5�B�@K�D6$66D

Errors ���������� ��������� � ����������>��A$�$�VTEXT (!var[1]) B$�

������������ � ������������>�A$�$�VTEXT ( !array )�B$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-39

C.7. Late Evaluation of Variables in expressions

�����������VVALUE!�VLOGICAL����VTEXT������������ ����� ����������'�������� �!��������!������� ����������������'�������� ����>��������#�����#� �������� �������� ����>������������ ����$�,���>� � !�#������������������������� � ��!������������� ����������� �����#�����#� ����#������������������$�� ������� ������������� � ��� ������������������������������ � ����� �������������?�����#���������� �#� ���������������������� ��������������� �#�������������������� $�������������#��������������������������������$�VVALUE��������������������� ������ �!�VLOGICAL������������� ����� ������� ����VTEXT��������������>�������� $��

C.8. PDMS Attributes in Expressions

� ��-'��������������������@���������� �������������#�����>�������$������� ������ ������� �#�����’OF’����������������� ���������������?�$�$�POS OF /VESS1$�1������� ������������������ ������������!�����>� � �DESP[8 + 1]�������������� �����DESP$���������>�� �������������� !������#����ATTRIB� ���������������������������������� �#�$�,���>� � !�ATTRIB�E�#� �������������@���������EAST����������������������������������������������$��-'����������������������������� ���� ��� �$������@����������#����������������>����������� ������������>�-$5$�

C.9. Querying Expressions

� �>�������� �����2����$������������ #���������������������� ������� $�& ���� ��� ������� #��������������������������� �$������������� �>� � ���������$�������������FINCH!�������DISTANCE�������� ���������$�&���� �>����������������������� �������������!������������������������2����������������������� ���������������������� ���������$��

������� ���2������������� �� �������������������������� �� ���������������������>�������$���������

• Q PPOINT n

• Q POS or cartesian position

• Q ORI or cartesian orientation

���������� ���� ����������#����������������>�������2����$�,���>� � !�’Q N 100 FROM /POSS’��������� ��$�&�� �������������Q N 100 FROM /POSS ).

C.10. Units in Expressions

Appendix C: PML 1 Expressions

C-40 PDMS Software Customisation Reference Manual

)�������������� ���� ��� ������������������������� ����#$��������������'�������� ������ ������#$�)�������������#!����� ����� ��� ������������ $������ ���������������������������A ��� B������������� ������������� ������������$�

�������#����D���#D������������ ��� �������������� ���������� �$������ ��������� ������� �#�����D���#D���������������������$�

������� ������������������������� �#���

Setting Comments

NONE �������$�$�$�����������1�$�

UNKN %��#�����$�$�$�36$�

MM -���9������������������������''!���� ���� �$�$�36� $�

INCH -���9������������������������&�0.9,&�0.!���� ���� �$�$�36D$�

SQIN '� ��� ���#��&�0.��� ���������!���� ���� �$�$�36��2��$�

CUIN '� ��� ���C&�����&�0.!���� ���� �$�$�36�����$�

���� ������!���������������������������#���� �������� �#������� ��������� ��$�&���������������������#�������������������������������UNKN!����������#��� ��������� �������������� ��������������#�����$��������� ��������������������������#���������INCH����SQIN����CUIN$�

,���>� � ���

(XLEN GT 10).

&��#����#���������������������������!���������#������XLEN��������������� �$�&��� ������� ������ ���� !����������������� �����INCH$�������������D36D����� ��������#$������������� ������!����D36D�������� �������������������� � ��� ������5;$7������������������ �������#��������>����$�

����� ����������� �������������������������������������� � ��� ������!��������!�POWER����SQRT!���������� ������ ���������SQIN����CUIN$�&��������������!���������%UNKN��������������$�,���>� � , (10 * XLEN)�������� �������� ����INCH�����������SQIN$���>��������� ���#������������ �#�� ����� ����� ��������$�,���>� � ������(10 /

XLEN)�#����� ���������36����������������������$�

Appendix C: PML 1 Expressions

PDMS Software Customisation Reference Manual C-41

C.11. Precision of Comparisons

���� �#������ � � ����������������!������ �#����� �����������$�

Object Tolerance

�� �� �� ��������������6$666663$��

&������#����!����������������#��#���� ������������������6$666663R�A �>� � ��������#���� ��B��������� �������������������2�� $�$�$�

• A3$666663�/��3B����FALSE���������������3$666663?����3������2�� ?�

• A3$666665�/��3B����TRUE$�

������� 0������������2�� ����#�����6$;� �����������$�

-������������������ 0������������2�� ������ ������#�����6$66;$�

C.12. Undefined Values

&����������� ���>�������� ���((DIAM GT 200.0) OR (TYPE EQ ’BOX’))!�>�������� �������� ��������#������������ ��$�/�� �!���� ���������������������� ������������� ������������������ �$��

�#��>�����������������������AND���������#�������� ������ �!�#� ���� ����FALSE!������ ������#���������������� ��������������� ����������?����OR�#�����������TRUE������������������ �������TRUE$�,���>� � !����������� ������������>�������#����������� ���������>$�DIAM���������?��������(DIAM GT 200.0)����� ��������$�.�#��!�(TYPE EQ ’BOX’)��������� ������������������ ���� ��������#�� �>��������� ��������TRUE$�

����������� ���������#���

• ���������������������� ���������������A>������ ���������AND����ORB���������$�

• ������������������� �� ������������������� ��A$�$’DIAM

OF OWNER’�#����������� ���������>B$�

• �� �����������A$�$�’OWNER’ #����������� ��������WORLDB$�

• ������������������A$�$��>��������������%-����� ����6B$�

• �������� ����������A$�. ’VVAL(!ARC6)’�#���!ARC6��������������� ���B$�

• �#����������������������� �����#����GT!�GE!�LT����LE���������������� ������������A$�$�’N10 EQ E5’B$�

Appendix C: PML 1 Expressions

C-42 PDMS Software Customisation Reference Manual

• &�������� ��������#�� �>���������������!��������������$�

C.13. Unset Values

��������� ���� ��������������� ������������ ��$����������>�������������������#���������� ������������� �!���������#��������� ��������������$������� ������ ����� �������������!����D#���D����������$�*���������� ��O696����� ���������������$�

%����� ������������������������������� ���A>��������1�� ����������@���� �#B$�%������� ��������������������$������������������ ����� ��������UNSET��������������� ���������$�

��������� �������!������� ������������������!������������������� �#���

Operator When Applied to an UNSET

EQ, GT, GE, LT, LE *�� �����FALSE$��

NE *�� �����TRUE.�

OR , AND �� ���������������FALSE.�

,���>� � !����DESP(2)����LVAL(3)������������

(DESP(2) GT 99) -> False (DESP(2) NE 33) -> True (:LVAL(3) AND TRUE) -> False

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-1

Appendix D. PDMS Attributes and Pseudo-Attributes

Note: )������ ���� ���� ���� ���� ���� ���� ���� ��������������������������>!������ ����� ��#����������� �� �$�

���� �� �� �� �� �� �� �� ���������������#���������� �������#����������������� �� �����#��� �$�

D.1. Attributes

����������� ������ ��-'������������������� �������� ������ $�,���������������!���� ����������

• ����� �� ������� �� � ���������������������� �A���#���������� �������������� �������������B?�

• �����������8����������?�

• ����-'�������������A�B����#����������� ��?�

• ������������������������������$�

����� ������ ��������#�������������-'���������������� ��������DBREF���"����

!DBREF.Attributename

Attribute Name Data Type DB Type

Description

AANGXY REAL DESI �� �������������0�����ES�� �����"����

AANGYZ REAL DESI �� �������������0�����+S�� �����"����

ABBREVIATION TEXT(8) CATA �����������

ABLENGTH INTEGER DICT '�� � ������������ ��������%-�9%-���

ABOP POSITION(3) DESI 1���� ��������������

ABORE REAL DESI ����������

ACBORE REAL PROP ����� �����

ACCESSDB TEXT SYST -1�������

ACLASS WORD(100) SYST ����������� ����������� ����

ACONNECTION WORD DESI �����������������

ACPORT REFERENCE DESI *��������� �������

ACRF REFERENCE SYST �0*���������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-2 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

ACRGROUP REF(5000) SYST ���������0*��#��������0*����

ACRLI REF(300) SYST ����������� �������������0*��

ACRMESSAGE TEXT(120) SYST ����������� ���������� �����

ACSTYF REFERENCE PADD ���������������� ������

ACTLENGTH REAL DESI ����� � ����

ADEGREES REAL PADD ���������

ADEND REAL CATA ���������������@�������������A��'%��B�

ADESPARAM REAL(100) DESI -�������� ��������������� ��

ADIRECTION DIRECTION(3) DESI ��������������

ADMLOCATION REFERENCE SYST 0���� ���� ������� �������

ADPRFARRAY REF(500) PADD �-�������������

ADUUID TEXT(120) GLOB �-'�����"���� ��� �%%&-�������������

AGRADIENT REAL DESI �������@������������

AHLISTTYPES WORD(200) ALL ������������� ���������#������������

AIRTIGHT TEXT(120) DESI ��������������� � �����

AKEY WORD PADD ������������

AKEYLIST WORD(20) PADD ������������ ����A��������� ��� ����B�

ALEN INTEGER COMP 0� ���������� ������#������������������������������

ALIGNMENT TEXT PADD ������ �� �� ��

ALLOWANCE REAL DESI � �#���

ANGLE REAL DESI �� ��

ANPJOINT POSITION(3) DESI ������������ ��������"����A�� #���B�

ANPSECTION POSITION(3) DESI ������������ ���������������A�� #���B�

ANSWER REAL CATA ��#�!�#������ ����>�����

ANSYMREF REFERENCE PADD �-������������ �� � ������������

ANTYPE TEXT(120) DESI �� ���������

AODIAM REAL DESI �������@��������������� ���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-3

Attribute Name Data Type DB Type

Description

APARAM REAL(100) DESI ������������ �������� ����

APOFFSET REAL(2) PADD ���� �������� �������

APOSITION POSITION(3) DESI ��������������

APPDATE TEXT(12) PADD -������������� �

APPLICATION TEXT(20) PROP ��� �������

APPROVER TEXT(28) PADD ��������

APROPERTY REAL PROP ������� ���������������

ARCTOLERANCE INTEGER PADD ������ ����

AREA INTEGER DESI ����

ARNO INTEGER PADD ��������������������� ���

ARRIVE INTEGER DESI �������@�����

ASCODE TEXT PADD ��������� ���������

ASTABLE WORD(15) PADD �-���������������� �

ASUBTENDED REAL PADD �� ��������

AT POSITION(3) DESI PADD

��������

ATEXT TEXT(120) PADD %�� �����>��������

ATLENGTH REAL DESI ��������������� � �������

ATLST WORD(50) DESI ���������� ����

ATNAME WORD CATA ���������� �

ATOP POSITION(3) DESI �����������������

ATTCONNECTION WORD DESI �������������������

ATTLIST WORD(500) ALL ������������������

ATTMDC WORD (500) ALL ������������������ ������������� �����������

ATTMOD LOGICAL ALL ���������������� ������������������

ATTMODC LOGICAL ALL ���������������� ������������� �����������

ATTMODLIST WORD (500) ALL ������������������ ���������������������

ATTNAME TEXT(32) DESI ���������� �>��������������**�� ���

ATTRULE TEXT(1000) DESI ����������� �>��������������**�� ���

ATTYPE WORD DESI ������ ������

AUTHOR TEXT(28) PADD �������

AUXLOCATION TEXT (3) TRAN �������� ������������ ���

Appendix D: PDMS Attributes and Pseudo-Attributes

D-4 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

AVAL INTEGER(20) COMP 0� ��������������������������� ��

AWDOWNERS INTEGER(3) ISOD ��� � ������)��-� �������������� �����

AWDREF REF(20) DESI *�������������)��-� ��

AWELDS INTEGER(20) DESI ) ��� ���������������# ���

AZIDEFAULT REAL DESI -��� ���H� ������ ��A��-��&/�B�

AZIFACTOR REAL DESI �H� ���������������������

AZILIMITS REAL(2) DESI �H� ���� � ����A �9 �>B�

AZISETFLAG LOGICAL DESI �H� �������� ���@�������H� ������ ������,� ��

BAINDICATOR TEXT PADD 1���9��������������

BANGLE REAL DESI 1����� �

BBFF REF(500) DESI ����������������1�������,�� ���

BCPYREF REFERENCE SYST 1���#��������������

BDIAMETER TEXT(1000) CATA 1� ����� ���

BEADEFAULT REAL DESI -��� ���������� ��A��-��&/�B�

BEAFACTOR REAL DESI 1����������������������

BEALIMITS REAL(2) DESI 1����� � ����A �9 �>B�

BEASETFLAG LOGICAL DESI 1��������� ���@�&������������ ������,� ��

BFLEXIBILITY REAL PROP �������� ��� >��� �������������������

BFPEN INTEGER PADD 1���������

BFRF REFERENCE DESI *��������� �1�������,�� ��

BITEMS WORD(10) CATA 1� ���� ��

BITLENGTH REAL(10) CATA 1� ���� � �����

BJOINT TEXT DESI 1� ��"����

BKEY TEXT(4) PADD -*�,����������������� �� 9�(�+�� �

BLENGTH REAL(200) CATA 1� �� ����

BLNK LOGICAL PADD ����@� ������ ���

BLRFARRAY REF(10) CATA 1� �������������

BLTMETHOD TEXT(3) CATA 1� �� �����

BLTREFERENCE REFERENCE CATA 1� �������

BMARGIN REAL PADD ����@� ����� �����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-5

Attribute Name Data Type DB Type

Description

BMAXIMUM INTEGER ISOD '�>� � ����� ��������������� ����#���

BOLTPARTNUMBERS INTEGER(20) DESI ���� ����� �������� ����

BORE REAL DESI ��������

BPOFFSET REAL(4) PADD �������������������

BPROPERTY REAL PROP ������� �������������1�

BRACKETS TEXT PADD 1�����������

BRCOG POSITION(3) DESI 1��������������������

BRCONNECT REF (5000) DESI 1����� �����������

BRICOG POSITION(3) DESI 1�������� �������������������

BRIWEIGHT REAL DESI 1�������� ����#�����

BRLEG REF (5000) DESI 1����� ����������� � ��

BRLOCK INTEGER DESI 1���������������������������������*�%��*�

BRWCOG POSITION(3) DESI 1�����#�����������������

BRWEIGHT REAL DESI 1�����#�����

BRWICOG POSITION(3) DESI 1�����#����� �������������������

BRWIWEIGHT REAL DESI 1�������� ����#��#�����

BRWWEIGHT REAL DESI 1�����#��#�����

BSELECTOR TEXT(3) DESI 1� ��� �����

BSFNAME TEXT(73) PADD 1������������ � �

BSPECIFICATION REFERENCE CATA 1� ��������������

BSRF REFERENCE PADD 1���������������

BSRFARRAY REF(500) PADD �-������������� ����

BSTATUS INTEGER DESI 1�����������������������*�%��*�

BTEXT TEXT(120) PADD ���������>��������

BTHKNESS TEXT(1000) CATA 1� ����������

BTLST WORD(50) DESI 1�������,�� ������ ����

BTOLERANCE REAL PROP 1����� ����

BTOTAL INTEGER DESI 1� ��"�������� �

BTYPE TEXT(1000) CATA 1� ������

BUFSIZE INTEGER SYST ���������������H�

BUILT LOGICAL DESI 1�� �9%��� ��� ���

BULGEFACTOR REAL DESI PADD

1� ���������

BUNITS WORD CATA 1��������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-6 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

BURF REFERENCE DESI *��������� �1�� ����� ��

BVISIBILITY LOGICAL CATA 1���� ������� ����� ���

CAREA TEXT(12) DESI &��-*�,��0� �������������

CASREFERENCE REFERENCE DESI PROP

0��������

CATMOD INTEGER DESI 0��� ������ ���� �������

CATREFERENCE REFERENCE CATA DESI

0��� ���������

CATTEXT TEXT' (725) DESI 0���������������� ������ ����� ��>���

CATYPE INTEGER PROP 0��������

CCENTRE INTEGER DESI 0��������

CCLASS INTEGER DESI 0����� ����

CCOLOUR INTEGER DESI 0� ����A��0��� ���B�

CCONNECTION WORD DESI 0����������A��������� ��@ �B�

CDETAIL REFERENCE CATA 0��� �������� �

CDPLIST WORD(100) DESI ���������� �����������������������

CDPROPERTY REAL DESI 0�������������������������

CDRG TEXT(24) DESI &��-*�,��0� �������������

CEND TEXT CDESI 0�������������������0���A.��������� B�

CERFARRAY REF(500) DESI ��������������������

CFDPROPERTY REFERENCE DESI 0�������������������������

CFFARRAY REF(500) DESI ��������������������

CFLOW TEXT(4) COMP 0�'��*���*�������������� �#�����������

CFRARRAY REF(10) DESI 0��������������������������������

CHAMFERS REAL(2) PADD 0�� ��� �����

CHARSET INTEGER SYST 0�����������

CHEIGHT REAL PADD 0��������������

CHOSHT REAL PADD 0�������������������

CHPEN INTEGER PADD 0������������

CIWEIGHT REAL PROP ���� ���� �����#�����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-7

Attribute Name Data Type DB Type

Description

CKEY WORD CATA &��-*�,���������������

CLAIMDB TEXT SYST -1�� �� �

CLFLAG LOGICAL CATA 0�� ��� ���

CLINE LOGICAL PADD 0�� ��� ���

CLKID INTEGER COMP 0�'��*���*���������� 9 ���������������� �������

CLLENGTH REAL DESI 1�������� �� ����

CLMID TEXT(120) ALL %�������������� �� ��� ��

CLMODE TEXT PADD 0�� �� �����3O0�����?�5O0����

CLNK REFERENCE COMP 0�'��*���*������������������� ���� ���

CLPEN INTEGER PADD 0�� ����

CLRF REFERENCE PADD ����� ������ ����� ���������

CMPREFERENCE REFERENCE CATA 0� ���������

CMPX TEXT(20) DESI 0�'��*���*9-��&/�@'���/�*�>� ������>�����������

CNAME TEXT(4) COMP 0�'��*���*��� ����������������

CNODE TEXT(4) COMP 0�'��*���*���������� ����������������������

CNUMBER TEXT(22) DESI &��-*�,��0� �������������

COMMENT TEXT(120) CATA 0� ��

COMMTYPE TEXT TRAN 0� ���� ���

COMUID REFERENCE TRAN �%�0�'���������� ��������

COMSTR TEXT TRAN 0� ����������������

CONDITION INTEGER(500) SYST ����������� � ����� ���������

COPIES INTEGER PADD �� ������������

CORALLOWANCE REAL PROP 0����������������

COUNT INTEGER PADD 0�����

COWNER REFERENCE COMP 0�'��*���*����������������#��

CPAID REFERENCE COMP 0�'��*���*��������������� ��

CPARAM REAL(100) DESI 0��� �������� ����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-8 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

CPEN INTEGER PADD ���������� ��� � ��

CPFARRAY REF(500) DESI ������������������������

CPLOT TEXT(120) DESI � ���A������ ���B�

CPOFFSET REAL(2) PADD ���� ��������������#����>��������

CPOSITION POSITION(3) DESI 0���������������������������� ����

CPROPERTY REAL PROP ������� �������������0�

CPULL REAL(3) PROP 0� ���� �@����� ����� �

CPUTWIST REAL(3) PROP 0� ���� �@��#����

CRCY INTEGER SYST 0��������

CREFERENCE REFERENCE DESI 0�����������

CRFARRAY REF(10) DESI 0�����������������

CRINFORMATION TEXT(150) ALL -1������������ �����

CRITERIA INTEGER(250) PADD � �������������A���������������N���$��� �B��

CRSF REFERENCE PADD 0������ ��������

CSESSDB TEXT(120) SYST �������� ��

CSFBREAK LOGICAL DESI ���� ��� �������������������� �����

CSIZE TEXT(120) COMP 0�'��*���*����H�������� ��

CSPACING REAL PADD 0����������������������

CSPC TEXT(6) DESI &��-*�,��0� �������������

CSPEC TEXT(120) COMP 0�'��*���*�����������������������������

CSTANDARD TEXT(120) DESI 0��� ������������

CSTREFERENCE REFERENCE DESI 0�������������

CTXT TEXT(120) PROP 0�����>��

CTYATTACHED WORD DESI CATA

�������������������

CTYEND WORD DESI ��������������

CTYOWNING WORD CATA �#��������������

CTYPE WORD(2) CATA 0����������

CTYSTART WORD DESI �����������������

CURDBS REF(300) SYST 0�����-1��

CURFIT TEXT PADD 0����������������3O���� �?�5O���������

CURLOCATION REFERENCE SYST ���������� �������

CURTYPE WORD DESI 0��������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-9

Attribute Name Data Type DB Type

Description

CUTBACK REAL DESI 0�������

CUTNAME TEXT(120) ALL ,� �� ���� �!��������������������� ����������������

CUTNMN TEXT(120) ALL ,� �� ���� �!�#������� ������ ���!��������������������� ����������������

CUTPLANE DIRECTION(3) DESI 0������� ���� � �

CWEIGHT REAL PROP ���� ��� ����#�����

DACCESS TEXT SYST -�������������

DACCLA LOGICAL ALL �������-�0�� �#�� �������� �� ��

DACCRE LOGICAL ALL �������-�0�� �#�� �������������

DACDEL LOGICAL ALL �������-�0�� �#�� �������� ���

DACDRO LOGICAL ALL �������-�0�� �#�� ��������������

DACISS LOGICAL ALL �������-�0�� �#�� �������������

DACMOD LOGICAL ALL �������-�0�� �#�������������� ������� �������

DAREF REFERENCE DESI *����������������������������

DARREF REFERENCE PADD -�������������

DATE TEXT(12) MANY -���

DATEAKNOWLEDGED DATE TRAN -����� �������# ����

DATECM DATE TRAN -����� ����� � ���

DATECREATED DATE TRAN -����� ���������

DATEFORMAT TEXT PADD -������ ���

DATEND DATE TRAN -����� ����������

DATERD DATE TRAN -����� ����������

DATERK DATE TRAN -����� ����� ������# ����

DATERN DATE TRAN -����� ����������

DATERP DATE TRAN -����� ����� ���

DATESL DATE TRAN -����� ��� ������� ��

DATESNT DATE TRAN -����� ������

DBACCESS TEXT ALL -1�������

DBALLOCATION REF(8000) GLOB ��������-1��� ��������� �������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-10 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

DBCLAIM TEXT ALL -1�� �� �

DBCNTL LOGICAL ALL ������� �������������� �-1�

DBDEPTH INTEGER ALL -������������#��������������

DBEXNO INTEGER ALL -1�>������� ���

DBF REFERENCE SYST -���������������������

DBFILENAME TEXT ALL -1��� � �

DBFNUMBER INTEGER ALL -1��� �� ���

DBLC REF(1000) GLOB ����������0��� ����������-1�

DBLS REF(1000) SYST ��������-1��� ��������'-1�

DBNAME TEXT ALL -1�� �

DBNUMBER INTEGER ALL -1�� ���

DBOTTOM REAL DESI PADD

1���� ���� ���

DBREFERENCE REFERENCE ALL -1������

DBSESSION INTEGER ALL �����-1�������

DBSHIERARCHY REF(5000) SYST -����������������#�������-����

DBSLEVEL REF(5000) SYST -��������������������� � �#�������-����

DBSLIST REF(5000) SYST -��������#�������-����

DBSSTP REF (8000) SYST -1��������� ��

DBSTF REFERENCE SYST -���������������

DBTYPE WORD ALL -1�����A-��&!�0������$B�

DBVARIANT LOGICAL ALL ������� ����������������-1�

DBWRITE LOGICAL ALL ������� ���������#����� �-1�

DCLAIM TEXT SYST -�������� �� � ���

DCODE TEXT PADD -�����������

DCONNECTION WORD DESI -�����@����������������

DCSTYF REFERENCE PADD -������������ ������

DDDFAULT TEXT(1000) CATA -��� �������������� ��

DDEFAULTS REAL(3) DESI ������������� >��� �������� ���

DDEGREES REAL PADD -� ���� ���� �

DDESPARAMETERS REAL(100) DESI -�������� ��������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-11

Attribute Name Data Type DB Type

Description

DDIRECTION DIRECTION(3) DESI -�����@������������ ���������

DDNAME REFERENCE PADD -���� �������

DDNMXCOORD REAL PADD --�'�E@��������

DDNMXYCOORD REAL (2) PADD --�'�E+@��������

DDNMYCOORD REAL PADD --�'�+@��������

DDNX TEXT(120) PADD -���� ������>��A��--�� B�

DDPROPERTY TEXT(1000) CATA -������������������� ��A��-���B�

DDRFARRAY REF(10) DESI ������������� ���������������A����� � ��B�

DEALAL LOGICAL GLOB &�������� �-1����� ������� ��� ���������� ������A-1���� �B�

DEALDB REF ARRAY GLOB &������������� ��������#��������������� ������A-1��0� �B�

DECPLACES INTEGER CATA -�� � �� ����

DEFAULT REAL CATA -��� ��

DELDSG WORD DESI - ��������������� ���

DELPE REAL DESI ����������� ��@��������A����*%0B�

DELPN REAL DESI ������������ ��@��������A����*%0B�

DELPOSITION POSITION(3) DESI - ��@��������A����*%0B�

DELPU REAL DESI %��������� ��@��������A����*%0B�

DENSITY REAL PROP ������� �����������

DEPCOUNT INTEGER TRAN �� ������������������ �� ����

DEPDEFAULT TEXT(250) DESI -��� ���� ����� ��� ��������������

DEPEND REF (10) TRAN 0� ������#������������������

DEPLIST WORD(100) DESI �������� ��� ���������������

DEPROPERTY TEXT(250) DESI ���� ���������������� ��

DEPTYPE REF (10) TRAN 0� ������#������������������

DERCUT REAL DESI -��������� ����

DERLEN REAL DESI -����� ����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-12 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

DESCRIPTION TEXT(120) MANY -���������

DESGEO REF(5000) CATA -������ ����� ��������

DESLOCATION TEXT (3) TRAN -�������� ���������������� ���

DESPARAMETERS REAL(100) DESI -�������� ����

DETAIL LOGICAL DESI` -��� �� ���

DETREFERENCE REFERENCE DESI CATA

-��� ����>�������

DFFLEXIBILITY REAL(6) PROP -��� �� �������� >��� ����

DFLAG TEXT PADD *���� ��� ��������� ���

DFLFACTORS REAL(3) PROP ���� ����� ��������� ���

DFLT TEXT(120) DICT -��� ��

DFLTA TEXT(120) PADD -��� �����������3�������������� ����������

DFLTB TEXT(120) PADD -��� �����������5�������������� ����������

DFLTC TEXT(120) PADD -��� �����������:�������������� ����������

DFNM TEXT(120) DESI -��� ���� � �

DFONT INTEGER PADD -� �����>������

DFUNITS REFERENCE CATA -��� ������

DIAMETER REAL MANY -�� ���

DIMENSION LOGICAL PADD -*�,�����@������� �� ��� ����� ���

DIMPOSITION POSITION(3) PADD -�����:-��� ������������

DIRECTION DIRECTION(3) PADD -�������

DISPLACEMENT REAL(3) PROP ���� ��������� �� ���

DKEY WORD CATA -�������

DLEVEL INTEGER PADD -��#��� � �

DLFG TEXT PADD ����9��� ����� ���� ��� ���

DLIMIT REAL(6) PROP -��� �� �� � ���

DLPEN INTEGER PADD -� ���� ����

DMFARRAY REF(2) DESI &��-*�,��������� �������������

DMFLEXIBILITY REAL(9) PROP -��� �� �� � ��� >��� ����

DMSPACING REAL PADD ��#�� � ���������������#����� ��� �����

DMTXT TEXT(120) PADD -� �����>��

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-13

Attribute Name Data Type DB Type

Description

DMTYPE WORD(2) DESI &��-*�,��������� �������������

DNSTY REAL DESI -�����

DOCREF REFERENCE DESI -��� �������

DOCXRF REF(500) DESI *������������ �-��&/�� �����-�0&�'� ��

DOFFSET REAL PADD -� ���� ��������

DOWN REAL DESI PADD

-�#��������������

DPBORE REAL DESI -�������������

DPCONNECTION WORD DESI -��������������������

DPCOUNT INTEGER DESI �� �������� ��������������

DPDIRECTION DIRECTION(3) DESI -�����������������

DPFNAME TEXT(120) DESI &��-*�,����� ������� �� ���� �� �

DPGRADIENT REAL DESI -����������������

DPGRIDREF INTEGER DESI &��-*�,����� ������� �����������

DPLST INTEGER(100) DESI ���������� ��������������

DPOSITION POSITION(2) PADD -� ���� �9������������

DPPS POSITION(3) DESI -�����������������

DPROPERTY TEXT(1000) CATA ���� ��������������>�������A���� �B�

DPSF REFERENCE DESI -�����@������������

DPVISIBILITY INTEGER(100) DESI ������������� ������������

DRADIUS TEXT(1000) CATA *���� �������

DREVAY REF(50) PADD -*)/��������������

DRGPRIORITY INTEGER DESI -��#������������A�������#�������#��0��B�

DRNEND DIRECTION(3) DESI � ���� � ����������0��9/����0�

DRNSTART DIRECTION(3) DESI � ���� � ��������������0��9/����0��

DRPS POSITION(3) DESI -�������������A�� #���B�

DRPSE REAL DESI ������������������������

DRPSN REAL DESI �������������������������

DRPSU REAL DESI %����������������������

DRRF REFERENCE DESI � ��������*����#��������

DRTITLE TEXT(120) PADD -��#������ �

Appendix D: PDMS Attributes and Pseudo-Attributes

D-14 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

DSCODE TEXT(120) DESI -��������

DSESSDB TEXT(120) SYST -������������

DSETFLAG LOGICAL(3) DESI -��� �� �� � �������� ����������� ������,� ��

DSPLDG REF(100) ISOD %������� ������ ��#�����������

DSTYLE TEXT PADD *���� ��� ������� �� ���

DTANGLE TEXT PADD -� �����>���� �� ���

DTCHEIGHT REAL PADD -� �����>�����������������

DTERMINATORS TEXT PADD -� ������ ����������

DTFLAG TEXT PADD -� �����>���������� ����

DTITLE TEXT(32) CATA -������� �

DTLHEIGHT REAL PADD -� �����>�� ����������

DTOFFSET REAL(2) PADD -� �����>��������

DTOP REAL DESI PADD

������� ���

DTPEN INTEGER PADD -� �����>����

DTRADIUS REAL PADD -� �����>���������

DTREFERENCE REFERENCE CATA -�����������

DTULINE TEXT PADD -� �����>����� ����� ���

DTXRTEXT TEXT(120) DESI *��E��������� ����>��

DTXSTEXT TEXT(120) DESI ���E��������� ����>��

DTXTTEXT TEXT(120) DESI ���E��������� ����>��

DUNION INTEGER CATA DESI

-*�,�� ���������� �� ���

DUNITS WORD CATA -�����������

DUTY TEXT(120) DESI -����

DVFLAG LOGICAL PADD �-������ ���#��� ���

DVSCLIST REAL(500) PADD �-������ ���#��� �#�� ���� � ����

DVTHRESHOLD REAL PADD �-������ ���#�������� ��

DWIDTH TEXT(1000) CATA )�����������

DX TEXT(1000) CATA 0�������E�������

DXL TEXT(1000) CATA &�� �� �E� ����

DY TEXT(1000) CATA 0�������+�������

DYL TEXT(1000) CATA &�� �� �+� ����

ECCENTRICITY POSITION(3) DESI �����������A�� #���B�

ECCJOINT POSITION(3) DESI ��������������"�����A�� #���B�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-15

Attribute Name Data Type DB Type

Description

ECLASS WORD(100) SYST ����������� � ��� ����

EFACTOR REAL PROP �@�������

EFORCE REAL(3) DESI ���������������� �����

ELECRC LOGICAL ALL ������������������� �����������

ELECRE LOGICAL ALL ���������������������������

ELEDEC LOGICAL ALL �������� ��������� �����������

ELEDEL LOGICAL ALL �������� �����������������

ELELIST WORD(200) DICT � �� ����

ELEMOC LOGICAL ALL ������� ������������� �����������

ELEMODIFIED LOGICAL ALL ������� �� ���������������������

EMOMENT REAL(3) DESI ��� � ���� �����

ENDANGLE REAL DESI ����� �

ENDTIM DATE TRAN -����� ����������

ERECTION INTEGER DESI �������� ����

ERELEASE INTEGER DESI ���� ����A�����B�

ETEXT TEXT(120) PADD �>� � ��>��

EVOLUME REAL(6) DESI �� �������>��� � ��� ��� �����������

EXBTEXT TEXT(180) PADD �>��������������>��

EXCLFR LOGICAL ALL ������� ��� �� ����� ������>������

EXCLHI REF(5000) ALL � ����� �#������������ �� ����������>������

EXCLTO LOGICAL ALL ������� ��� �� ����������>������

EXDMTXT TEXT(180) PADD �>������� �����>��

EXECA TEXT(120) SYST �>���� ������-1������������

EXECB TEXT(120) SYST �>���� ������-1������������

EXFILE INTEGER PADD �>�������� �� ���

EXMOC LOGICAL ALL ������� ��� �� � ��������������>������

EXMOD LOGICAL ALL ������� �� ��������������>������

EXNCLH REF(5000) ALL � ����� �#��������������� �� ����������>������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-16 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

EXPANSION REAL PROP ������� �����>���������������

EXPLTXT TEXT(180) PADD �>��������"����� ���>��

EXPMOC LOGICAL ALL ������� ������@��� ������������� �� @ ��������������>������

EXPMOD LOGICAL ALL ������� ������@��� ������������ ��������������>������

EXTALS REF(8191) SYST �>��������������

EXTCLS REF(8191) SYST �>��������� ���

EXTDESCENDANTS REF(8191) SYST �>��������������

EXTFAMILY REF(8191) SYST �>�������� � ��

EXTHIGH INTEGER GLOB ��������>������� ������!������ � ���

EXTIME INTEGER (3) TRAN �� ����>������������ ���

EXTLOW INTEGER GLOB ��������>������� ������!� �#� � ���

EXTMASTER REFERENCE SYST �>������ �����

EXTNO INTEGER SYST �>������� ���

EXTOWNER REFERENCE SYST �>�������#��

EXTRCLAIM TEXT(120) ALL �>������� �� ��� ��

EZDISTANCE REAL DESI ��� �����������������

FAANGLE INTEGER SYST ��#��� ����������� �

FAREA TEXT(5) DESI ,��������������������

FCODE TEXT PADD ,�������

FCOEFFICIENT REAL(3) PROP ,����������������

FCPYREF REFERENCE SYST ,��#��������������

FDEPDEFAULT TEXT(250) DESI ,�� ����� ��� ������������������ ���� ��

FDEPROPERTY TEXT(250) DESI ,�� ����� ��� ���������������� ��

FDRAWING TEXT(32) DESI ,�������� ��������#���� ���

FFPEN INTEGER PADD ,���@������

FGRF REF(500) DESI *��������������������

FILENAME TEXT SYST -1��� � �

FILL LOGICAL PADD -*�,�����@������� �� ��� �� ���

FINO INTEGER SYST ,� �� ���

FINPUTBY TEXT(120) CATA ���������$�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-17

Attribute Name Data Type DB Type

Description

FIRESISTANCE REAL DESI ,�����������

FISSUE TEXT(15) CATA 0�������������������������$�

FIXITY TEXT(12) DESI ��������� ���>����

FLENAME TEXT(73) PADD �>��� ��� � �

FLIMIT REAL(3) PROP ,���� � ���

FLNN TEXT(120) ALL ,� �� ���� �!�#������� ������ ����

FLOWDIRECTION WORD DESI , �#���������

FLUREFERENCE REFERENCE CATA DESI

, ���������

FLWARROW LOGICAL PADD -*�,�����@������� �� ��� �#�����#�

FNAME TEXT(32) SYST ,� � �

FNMA TEXT(32) SYST �������������� �� �

FNMB TEXT(32) SYST 1� �������� �� �

FNTDIRECTORY TEXT(32) SYST ,������������

FONT INTEGER PADD �>������

FORCE REAL(3) PROP ,����������

FOREIGN TEXT SYST -1������9 ��� �

FPEN INTEGER PADD ,� ���

FPLINE TEXT(32) DESI ,������������ ��� ���

FPONUMBER INTEGER DESI ,�� ������� ���

FPRDEFAULT TEXT(250) DESI ,�� ����������������� ��

FPROPERTY TEXT(250) DESI ,�� ��������������� ����� ��������

FRADIUS REAL DESI PADD

,� ���������

FRDRAWING TEXT(32) DESI ,�������������#����

FREFERENCE REFERENCE DESI ,�����������

FREVISION TEXT(4) DESI ,�������� ��������#����������

FRPOSITION POSITION(3) PADD ��������

FRSTWORLD REFERENCE ALL *�������������)�� ���������-1�������������'-1�

FSTATUS TEXT(15) DESI

CATA

ISOD

���������������������*'����������

FTCDDEFAULT TEXT(250) DESI ,�� ���������������������������� ���� ��

Appendix D: PDMS Attributes and Pseudo-Attributes

D-18 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

FTCDPROPERTY TEXT(250) DESI ,�� �������������������������� ��

FTERMINATORS TEXT PADD ,������� ������ ����������

FULLNAME TEXT(120) ALL ,� �� ���� ��

FULLTYPE TEXT ALL ,� �������� ��

FUNCTION TEXT(120) MANY ,������

FUNIT INTEGER SYST ,%�&��

GAPS REAL(30) PADD ���"����� ������������

GBOX REAL PADD 1�>�����

GCOFG POSITION(3) DESI /��������������������

GEODEP REF(5000) CATA -������� ����� ��������

GEOM INTEGER DESI /� ���� �������

GFILE TEXT(120) COMP 0�'��*���*���� � �������������������������

GLBVERSION TEXT(120) GLOB /��1���������������

GMOFI REAL(9) DESI /����� � ������������

GMREFERENCE REFERENCE CATA /� ������������

GPICT INTEGER COMP 0�'��*���*���������� ����������������

GRADE REAL DESI �� ������

GRADIENT REAL DESI /���������� � �������

GRPRF REFERENCE GLOB *�������������A�#����� ������B�

GSRFAREA REAL DESI /����������������

GSTREFERENCE REFERENCE CATA ��������� ��� ������������

GTXT TEXT(120) DESI �>����������� ���������&�����������

GTYPE WORD MANY /��������

GVOLUME REAL DESI /������� � �

GWEIGHT REAL DESI /�����#�����

HARDTYPE WORD ALL .�������������� ��

HBORE REAL DESI .�������

HCONNECTION WORD DESI .��������������

HDIRECTION DIRECTION(3) DESI .�����������

HDMFARRAY REF(2) DESI &��-*�,��������� �������������

HDMTYPE WORD(2) DESI &��-*�,��������� �������������

HEAD ���� ����.*�,���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-19

Attribute Name Data Type DB Type

Description

HEIDEFAULT REAL DESI -��� ��������A��-��&/�B�

HEIFACTOR REAL DESI .����������������������

HEIGHT REAL DESI PADD

.�����

HEILIMITS REAL(2) DESI .����� � ����A �9 �>B�

HEISETFLAG LOGICAL DESI .��������� ����������������� ������,� ��

HEND TEXT DESI 0�������������������.���A���������� B�

HHBOP POSITION(3) DESI 1���� �������������

HHBORE REAL DESI .������������

HHCONNECTION WORD DESI .�������������������

HHDIRECTION DIRECTION(3) DESI .����������������

HHGRADIENT REAL DESI .���������������

HHOD REAL DESI .������������������ ���

HHPOSITION POSITION(3) DESI .����������������

HHTOP POSITION(3) DESI ����������������

HIERARCHY REF(5000) DESI ��������� ���������

HISTORY INTEGER(120) ALL .�������������������#����� ������������#�� ����

HLISTTYPES WORD(200) ALL ��������� ������� ���������#������������

HMAVERAGE REAL DESI �������� ������

HMMAXIMUM REAL DESI '�>� � ��� ������

HMMINIMUM REAL DESI '�� � ��� ������

HPOSITION POSITION(3) DESI .�����������

HPOSE REAL DESI ����������������������

HPOSN REAL DESI �����������������������

HPOSU REAL DESI %��������������������

HPREFERENCE REFERENCE DESI .�������������

HREFERENCE REFERENCE DESI .��������

HRELATIVE LOGICAL DESI 1����� �������� ������ ��!��������*�%��*�

HRSF REFERENCE PADD .������� ��������

HSPECIFICATION REFERENCE DESI .����������������

HSROD REFERENCE DESI .�������������������

HSTUBE REFERENCE DESI .�������������������

HSTYF REFERENCE PADD .�������� ������

HTBOP POSITION(3) DESI 1���� ������������ �

Appendix D: PDMS Attributes and Pseudo-Attributes

D-20 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

HTBORE REAL DESI .������� �����

HTCONNECTION WORD DESI .������� ������������

HTDIRECTION DIRECTION(3) DESI .������� ���������

HTGRADIENT REAL DESI .������� ��������

HTOD REAL DESI .������� ����������� ���

HTPOSITION POSITION(3) DESI .������� ���������

HTTOP POSITION(3) DESI ��������������� �

HTYPE WORD DESI .��������

HUBRF REFERENCE GLOB *����������� �������

HWRF REFERENCE DESI .���#����������!��������*�%��*�

ICATREFERENCE REFERENCE DESI &�� ��������� ���������

ICON TEXT(120) CATA &���

ICONN INTEGER GLOB 0� ��������������6O� �?�3O��� ��

IDETAIL REFERENCE DESI &�� ��������� ��>�������

IDLNAME REFERENCE PADD -��# ����� ������

IDLX TEXT(120) PADD -��# ����� �����>��A��&-��� B�

IDNAME REFERENCE PADD -���������������� ������ ����� �

IDNX TEXT(120) PADD -���������������� ������ ����� �����>��A��&-��B�

IDRTEXT TEXT(120) DESI &�� ��������� �*��E��

IDSTEXT TEXT(120) DESI &�� ��������� ����E��

IDTTEXT TEXT(120) DESI &�� ��������� ����E��

IMATREF REFERENCE DESI &�� ����� ����� ��>�������

IMXTEXT TEXT(120) DESI &�� ����� ����� �E��E��

IMYTEXT TEXT(120) DESI &�� �����'����� �+��E��

IMZTEXT TEXT(120) DESI &�� �����'����� �S��E��

INARCOUNT INTEGER TRAN �� ������������������ �� ����

INBY TEXT(32) COMP 0�'��*���*������#���� ��������������� �

INCO TEXT(2000) DESI �������������������*�%��*����� �������

INCSTATE INTEGER TRAN &������ ����������

INDATE TEXT(32) COMP 0�'��*���*���������� �����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-21

Attribute Name Data Type DB Type

Description

INFA TEXT(119) SYST 0 �����������"���� �

INFB TEXT(119) SYST 0� ������"��� �����

INREFERENCE REFERENCE DESI &�� ����������

INRFARRAY REFERENCE DESI ������������������ ��

INSCHEDULE TEXT(120) DESI &������������ �

INSL LOGICAL PADD -*�,�����@������� �� �&�� ������ ����

INSULATION LOGICAL PADD &�� ������ ���

INTARGUMENTS INT (10000) TRAN ���� ��������� ���

INTHICKNESS REAL DESI &�� �������������

INTYPE WORD DESI &�������� �����

INVFARRAY REF(500) DESI ������������������ ��

INVISIBLE LOGICAL DESI ������ ���������

IPARAM REAL(30) DESI ���� ������������� ��������� ������ ����

IPRESSURE REAL PROP &��� ��������

IRNO TEXT SYST &��@&*�� ���

ISEXAP LOGICAL SYST �������>������������������� �������

ISEXCP LOGICAL SYST �������� �>��������� ��������� �������

ISEXMP LOGICAL SYST �������>������ ����������� �������

ISEXOP LOGICAL SYST �������>�������#�������� �������

ISNAMED LOGICAL ALL ������� ������ ��

ISOLT LOGICAL COMM ����������� ������ ���

ISPECIFICATION REFERENCE DESI &�� ����������������������

ISPREF REFERENCE DESI &�� ������������������� ���������

ISPRIMARY LOGICAL SYST ��������������������� ������������ �������

ISSUED LOGICAL ISOD ������ �� ���@�����������#���������������

ISWORKINGEXTRACT LOGICAL SYST ���������#������>������

ITLENGTH REAL DESI ��������� � �������

ITLN REFERENCE COMP 0�'��*���*��A���B ���������� �

ITMTBL INTEG(2000) ISOD ��� � ������&��'�� �������������� �����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-22 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

ITOWNER REFERENCE COMP 0�'��*���*���#���������� �

ITPD REFERENCE COMP 0�'��*���*������������������#����� ��� ����

ITPOSITION POSITION(3) DESI ������������ � �������

ITREV TEXT(120) COMP 0�'��*���*������������������������ �

ITSIZE TEXT(120) COMP 0�'��*���*����H��������� �

ITSPEC TEXT(120) COMP 0�'��*���*���������������������� �

ITTYPE TEXT(120) COMP 0�'��*���*��A���B ��������������

IWDOWNERS INTEGER(8) ISOD ��� � �����&)��-� �������������� �����

JFREE LOGICAL DESI ����������������������� ��������������

JLINE WORD DESI =����� ��

JLNEND WORD DESI =����� ����

JLNSTART WORD DESI =����� ��������

JMAXIMUM INTEGER DESI '�>� � �"����� ��������������� ����#���

JNTNUMBER INTEGER ISOD =����� ���

JNTOWNERS INTEGER(8) ISOD ��� � �����&=�&��� �������������� �����

JNTREF REFERENCE DESI *������������ ��@��������&=�&��� ��

JNUMBER INTEGER(2) DESI � ��������*�"����� ���

JOIEND REFERENCE DESI ���"�����

JOIPREFIX WORD(2) DESI � ��������*�"����� �������>�

JOISTART REFERENCE DESI ������"����

JUSLINE WORD DESI =�������������@ ��

JUSTIFICATION TEXT PADD =������������

LACR LOGICAL SYST ����������� ��9�����#�����

LASTMODIFIED TEXT(120) ALL -������ ���� �����������

LAXES ORIENT(3) DESI ���� ��>��

LBOP POSITION(3) DESI 1���� ���� �������

LBORE REAL DESI ��������

LCASE INTEGER DESI ���������� ���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-23

Attribute Name Data Type DB Type

Description

LCHAIN LOGICAL PADD 0����� ���

LCLAIM LOGICAL SYST ����������� �� �� �� ���

LCLM LOGICAL ALL ������� ������ �� ��

LCLMH LOGICAL ALL ������� ������������������ �� ��

LCNFARRAY REF(500) DESI � ���#���� ��� �� ����������� � ���

LCONNECTION WORD DESI ���������������

LCTROLLED LOGICAL SYST 0���� ��-1�� ���

LDIRECTION DIRECTION(3) DESI ������������

LDISP LOGICAL DESI -��� ������������ ���������������������������

LDPROPERTY REAL DESI ���� ���������������������

LEAVE INTEGER DESI �����@�����

LEND LOGICAL DESI �����

LEVEL INTEGER(2) CATA DESI

-��#��� � �

LFDPROPERTY REFERENCE DESI ���� ���������������������

LFPEN INTEGER PADD ��� ���� ���

LFRAME LOGICAL PADD ,�� �� ���

LGRADIENT REAL DESI �����@������������

LHEAD LOGICAL DESI ������ ������ ���

LHEIGHT REAL PADD �����������

LHIDE LOGICAL CATA .������������ ����������� �������������������

LIMITS REAL(6) PADD �� � ����������

LINETYPE WORD CATA DESI

�������

LINIT LOGICAL GLOB ������������� �������� ���

LINKREF REFERENCE PADD ���������

LINKS REF(5000) DESI ����� ���

LINKSN INTEGER SYST �������������������>������

LINKXREF REF(1000) PADD *������ ���

LISSUE LOGICAL DESI ������ �� ���@�����������#���������������

LISTTYPES WORD(60) ALL ��������� ������� � ��������

LKIN REFERENCE COMP 0�'��*���*�������������� ����������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-24 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

LKLN REFERENCE COMP 0�'��*���*��A���B �����#����� ���� ����

LKOUT REFERENCE COMP 0�'��*���*��������������������������

LKSIZE TEXT(120) COMP 0�'��*���*����H���� ���

LKSPEC TEXT(120) COMP 0�'��*���*����������������� ���

LLCLEARANCE REAL PADD ����� ��� �����

LLEADERLINE LOGICAL PADD ����� ��� ���

LLISTTYPES WORD(500) ALL ��������� ������� �������� ������������

LLPEN INTEGER PADD ��� � ������

LMIRROR LOGICAL DESI ������� ���������2�����

LNAME TEXT(20) DESI ���� �� ������������� � ���

LNFARRAY REF(480) DESI .������������������� �����������

LNKRX REFERENCE GLOB *������������� ������������ ���

LNKRY REFERENCE GLOB *������������ ������������ ���

LNKWV REFERENCE GLOB ����#��������� ��

LNLST TEXT(1000) DESI �������� ��� �� ������������� � ���

LNSPC TEXT(120) COMP 0�'��*���*��A���B ��������������

LOCATION TEXT(120) PADD ��������

LOCID TEXT(3) GLOB ����������������

LOCK LOGICAL ALL ������� ����� �����

LOCRF REFERENCE SYST GLOB

�������������

LODIAM REAL DESI �����@��������������� ���

LOFFLINE LOGICAL DESI ��� ��� ���

LOGFN TEXT(32) SYST 0� �� ����� �� �

LOGLV INTEGER SYST 0� �� ����� � � �������� �

LOGMS LOGICAL SYST 0� �� ����� ������9�������� ���

LOHEIGHT REAL DESI � ����������@���� �������� �������#����� �

LOOSE LOGICAL DESI �����

LPOSITION POSITION(3) DESI ������������

LREFERENCE REFERENCE DESI ���������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-25

Attribute Name Data Type DB Type

Description

LSHAPE TEXT PADD ��������������

LSPACING REAL PADD �>�� ����������������

LSROD REFERENCE DESI ��������������������

LSTRESSED LOGICAL DESI ������� ���

LSTUBE REFERENCE DESI �������������

LTAIL LOGICAL DESI ������ ���� �� ���

LTERMINATORS TEXT PADD ��� ��� ����������

LTLENGTH REAL DESI �������� ���� � �������

LTOP POSITION(3) DESI ������� �������

LVARIANT LOGICAL SYST �������� ���

LVISIBILITY LOGICAL PADD ������ ����� ���

LVOLUME REAL(6) DESI �� �������>��� � ��� ��� �����������

MATREFERENCE REFERENCE CATA DESI

'����� ������

MATXT REFERENCE CATA '����� ��>��

MAXANSWER REAL CATA '�>� � ���#��

MAXBORE REAL DESI '�>� � �����

MAXDEPTH INTEGER ALL -1������������������ �#��� � ��� ������ ��

MAXMIN REAL(2) DESI '�>$���� �$��� �������������������

MAXTRY INTEGER TRAN '�>� � �� ������������

MAXUSERS INTEGER SYST '�>� � �� �����������

MBACK REF(10000) ALL ' ����������������

MCOUNT INTEGER ALL �� ������ �� �����������������

MDBCLS REF(1000) SYST ��������'-1����#�����-1����������

MDBLS REF(1000) SYST ��������'-1�����#�����-1�� ����

MEMBERS REF(10000) ALL ' ����

MEMLINE WORD DESI ' ��� �������0����

MESNUMBER INTEGER TRAN '������ ���

MESQUALIFIER INTEGER TRAN '������ ���

MESREF REFERENCE TRAN '���������������

MFARRAY WORD(50) DESI '�� ��������#����������

MFLG LOGICAL DESI '����� ���� ����� ������,� ��

MIDPOINT POSITION(3) DESI ������ �������A�� #���B�

MLIMIT REAL(3) PROP '� �� � ����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-26 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

MLNPEN INTEGER PADD ' ��� ����

MODATT LOGICAL ALL ������������������� ������� �������

MODDEL LOGICAL ALL ������� �������� ��$�

MODEDB TEXT SYST -������� ���

MODULE TEXT(120) DESI '��� �

MOFI POSITION DESI '� ������������

MOMENT REAL(3) PROP '� ��

MPEN INTEGER PADD '�������

MRGFLAG LOGICAL PADD �-�� ���� ���

MRGLEVEL WORD PADD �-�� ��� � �

MRKR WORD PROP :@)����� ���� �����

MSDTXT TEXT (120) TRAN '�����������>��

MSESSDB INTEGER SYST ������������ ���

MSSENT LOGICAL TRAN '������������ ��������

MSTEXT TEXT (120) TRAN '������>��

MSTYPE REFERENCE TRAN *��������%�0�'9���*����������������������

MTBEGREF REFERENCE DESI *������������� ������������ ����� �����

MTCLENGTH REAL DESI '����� �������� �� �����

MTENDREF REFERENCE DESI *������������� ���������� ����� �����

MTLENGTH REAL DESI '����� ����� ����

MTOCOMPONENT WORD DESI '����� � ��������� ������� �����A&��-*�,�B�

MTOHEAD WORD DESI '����� � ��������� �������������A&��-*�,�B�

MTOLENGTH REAL DESI '����� � �����>�� ����A&��-*�,�B�

MTOPARTNUMBERS INTEGER(20) DESI �������� ����� ����� ������� ����A&��-*�,�B�

MTOQUANTITY REAL DESI -�� ���������������� ����� ����@����2�������A&��-*�,�B�

MTOREFERENCE REF(20) DESI �>���� ����� � �����������$�A&��-*�,�B�

MTOTUBE WORD DESI '����� � ��������� ����� �������A&��-*�,�B�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-27

Attribute Name Data Type DB Type

Description

MTOXARRAY INTEGER(20) DESI � ��������*��������� ��� ��

MTXREFERENCE REFERENCE DESI '����� ��>�������

MTXXTEXT TEXT(120) DESI E��E����� ����� ��>��

MTXYTEXT TEXT(120) DESI +��E����� ����� ��>��

MTXZTEXT TEXT(120) DESI S��E����� ����� ��>��

MULTIPLIER REAL CATA '� ��� ����������@�������������A���-��-B�

MVERTEX REFERENCE DESI *������� ��������>�

NACKNOWLEDGED INTEGER TRAN �� �������� ������# ����

NAME TEXT(120) ALL �� ���� ��A����'�B�

NAMEDB TEXT SYST -1�� �

NAMESQ TEXT(120) ALL ���!��2���� ������� ���� ��

NAMETY TEXT(120) ALL �������� ���� ��

NAMN TEXT(120) ALL �� ���� ��#������� ������ ����A����'�B�

NAMTYP TEXT(120) ALL ��������� �� ���� ��

NAREFERENCE REFERENCE CATA *����������� ��>���

NCOFG POSITION(3) DESI �������������������

NCOLS INTEGER PADD �� �������� � ��

NGMREFERENCE REFERENCE CATA ��������� ������������

NLOAD REAL DESI �� �� � ����

NLPEN INTEGER PADD ���9��� �����

NMOFI REAL(9) DESI ���� � ������������

NODIMSFLAG LOGICAL CAT ����� ������ ���

NOFF INTEGER CATA �� �������

NOFG LOGICAL DESI ��������������������� ���

NORMAL DIRECTION(3) PADD � ���� � �

NPOSE REAL DESI ���������������������#��

NPOSITION POSITION(3) DESI �����������#��

NPOSN REAL DESI ����������������������#��

NPOSU REAL DESI %�������������������#��

NPPT INTEGER PADD �@������ ���

NRELEASE INTEGER DESI ���� �� ����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-28 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

NREPAK INTEGER TRAN �� �������� ���� ������# ����

NREPLY INTEGER TRAN �� �������� ���� ���

NRETRY INTEGER TRAN �� ������������

NROWS INTEGER PADD �� ��������#��

NSIZE REAL PADD �� �� ���H�

NSRFAREA REAL DESI ���������������

NSTDBLENGTH REFERENCE CATA ��@���������� �� ����A��$����-��1B�

NTEXT TEXT(12) PADD �� ��>��

NUMBDB INTEGER SYST -1�� ���

NUMBER INTEGER CATA DESI

�� ���

NVOLUME REAL DESI ������ � �

NWEIGHT REAL DESI ����#�����

NWELDS INTEGER DESI �� ��������������# ��������������� ����

NXTARLOCATION TEXT (3) TRAN �>�������� ���������������� ���

NXTDBN INTEGER SYST �>��-1�� ���

NXTEXN INTEGER SYST �>��-1�>������� ���

NXTFDB INTEGER SYST �>��-1��� ����-1�� ���

NXTFLN INTEGER SYST �>��-1��� �� ���

NXTHB REFERENCE GLOB *�������>��A�����B�����

OANGLE REAL PADD ��� ��������� �

OBPEN INTEGER PADD ��������������

OBSTFLAG LOGICAL PADD ������������ ���

OBSTRUCTIONS INTEGER CATA DESI

����������� � �

OCODE TEXT PADD .���������������

ODESPARAM REAL(100) DESI �#������������ ����

OFFLINE ���� ������,, ��

OHTYPE WORD ALL .������������#��

OKCLAIM LOGICAL ALL ������� �� ������ �� ��

OKCLHIERARCHY LOGICAL ALL ������� �������������� ������ �� ��

OKDROP LOGICAL ALL ������� �� ������������

OKDRPH REF(5000) ALL � ������������������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-29

Attribute Name Data Type DB Type

Description

OKRELEASE LOGICAL ALL ������� �� ������ ����

OKRLEH REF(5000) ALL � �������������������� ���

OKRLEX LOGICAL ALL ������� �� �����>������� ����

OKRLHIERARCHY LOGICAL ALL ������� �������������� ������ ����

OLDSPL REF (100) ISOD %������� ������ ��#����������

OLISTTYPES WORD(200) ALL ��������� ������� ��#�������

OLPEN INTEGER PADD ��� ����

OMITFLAG LOGICAL PADD � ������� ���

ONPJOINT POSITION(3) DESI �#������� ���������"����A�� #���B�

ONPOSITION REAL(2) PADD 8���8��������������������#��������

ONPSECTION POSITION(3) DESI �#������� ���������������A�� #���B�

OPARAM REAL(100) DESI �#������� ����@����� ������ ����

OPCLAIM WORD SYST 0 �� ������������ ���������

OPCREATE WORD SYST 0��������������� ���������

OPDELETE WORD SYST - ������������� ���������

OPDIRECTION DIRECTION(3) DESI ������� ����������

OPDROP WORD SYST -��������������� ���������

OPISSUE WORD SYST &��������������� ���������

OPMODIFY WORD SYST '����������������� ���������

OPOSITION POSITION(2) PADD ��� ���������������

OPSTATE INTEGER TRAN ���������������

OPTYPE TEXT TRAN ��������� ���

ORDER INTEGER ALL �2������������� ��� ����

ORIANGLE REAL(3) DESI �������������� ��

ORIENTATION ORI(3) DESI ���������

ORIFLAG LOGICAL DESI ���������� ���

ORILOCATION TEXT (3) TRAN ������ � �������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-30 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

ORIN WORD PADD -*�,�����@������� �� ����������

ORNA TEXT(120) PADD �����������>��

ORRF REFERENCE DESI �����������A����� � ���B�

OSET LOGICAL PADD ������9��#���������� ���

OSFNAME TEXT(73) PADD ��� ��������� �� �

OSLVISIBILITY REAL(12) PADD ��� ���������#� ���������� �

OSRF REFERENCE PADD ��� ������������

OSTYPE WORD ALL �������������#��

OUDATE TEXT(32) COMP -���#�����������������#����� ����

OUTBY TEXT(32) COMP %���#��������������������� �

OUTDIAMETER REAL PROP ���������� ���

OUTSTATE TEXT TRAN ��������� ����������

OVERSHOOT REAL PADD ���������

OWNCONNECTION WORD DESI �#��������������

OWNER REFERENCE ALL �#��

OWNLST REF(100) ALL �#������������

PAAXIS INTEGER(2) CATA -�����������>�����

PACKF REFERENCE GLOB ������������

PALIGNMENT REAL DESI �� �� �� ��

PANGLE TEXT(1000) CATA �� ��������

PARAMETERS REAL(100) CATA PADD

���� ����

PAREA TEXT(40) COMP 0�'��*���*��� ��������

PARENT REFERENCE ALL *��������#��� ��������������������2�� �����

PARTNUMBER INTEGER DESI ������ ���������� ���� ������� �������

PASSWORD TEXT(7) SYST ����#����

PAXIS INTEGER(2) CATA �>�� ���������

PBAXIS INTEGER(2) CATA -�������

PBBTLENGTH TEXT(1000) CATA 1���� �1� ����

PBDIAMETER TEXT(1000) CATA ���������� ���� ���

PBDISTANCE TEXT(1000) CATA -�������������� ��������

PBENDNUMBER INTEGER DESI ���� ����� ������ ���

PBOFFSET TEXT(1000) CATA 1�������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-31

Attribute Name Data Type DB Type

Description

PBOP POSITION(3) DESI 1���� ��������

PBORE TEXT(1000) CATA 1���

PBTPLENGTH TEXT(1000) CATA ����1� ����

PCAXIS INTEGER(2) CATA -����������0�������

PCBTLENGTH TEXT(1000) CATA 1���� �0� ����

PCODANGLES INTEGER PADD ������������@��� ��

PCODE INTEGER PADD ������������

PCODFRACTIONS INTEGER PADD ������������@����������

PCODIMPERIAL INTEGER PADD ������������@�� ���� �

PCODMETRIC INTEGER PADD ������������@� �����

PCOFFSET TEXT(1000) CATA 0�������

PCONNECTION TEXT(1000) PCON 0����������

PCREFERENCE INTEGER(4) DESI �@������������������������������ ����

PCTPLENGTH TEXT(1000) CATA ����0� ����

PDEFINITION TEXT PADD ��� �������������

PDIAMETER TEXT(1000) CATA -�� ������� ���

PDIRECTION DIRECTION(3) CATA �@�������������

PDISTANCE TEXT(1000) CATA -���������� ���

PERSPECTIVE REAL PADD ����������� �

PFONT INTEGER PADD ���"����� ���>������

PFREFERENCE REFERENCE DESI ���������������������������

PFREQD LOGICAL PADD ��������� ��2������ ���

PGRADIENT REAL DESI �@������������

PHBOP POSITION(3) DESI 1���� ������������

PHBORE REAL DESI ������������

PHCONNECTION WORD DESI �������������������

PHDIRECTION DIRECTION(3) DESI ����������������

PHEIGHT TEXT(1000) CATA .�����

PHGRADIENT REAL DESI ���������������

PHOD REAL DESI ������������������ ���

PHPOSITION POSITION(3) DESI ����������������

PHTOP POSITION(3) DESI ���������������

PICFD LOGICAL GLOB ��������� �������������� ���

PICFILENAME TEXT(73) PADD ��������� � �

PICHTYPE WORD PADD .������������������

PICSTYPE WORD PADD �������������������

PIDREAL REAL COMP 0�'��*���*����/��%-������� �

Appendix D: PDMS Attributes and Pseudo-Attributes

D-32 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

PIDTEXT TEXT(250) COMP 0�'��*���*����/��%-������>��

PILREAL REAL(10) COMP 0�'��*���*����/�� ���%-������� �

PIPESYMBOLS LOGICAL PADD ���@���� �� �� ���

PJUSTIFICATION TEXT PADD ���"����� ���>��"������������

PKDISTANCE REAL PADD ���������� ��������� ����@ ��

PKEY WORD CATA PADD

�@ �������������

PLAXIS INTEGER(2) CATA 5-����������� �

PLCLEARANCE REAL PADD ���"����� ��� �����

PLCNFLAG LOGICAL DESI �@ ����� ��� ���

PLCONNECTION WORD DESI �@ ���������

PLDESCRIPTION TEXT(120) DESI �@ ������������

PLDIRECTION REAL(3) PADD ���"����� ����������

PLEDIRECTION DIRECTION(3) DESI � ��������������

PLENCUT POSITION(3) DESI �@ ���!�� �#���������������

PLEND POSITION(3) DESI �@ ����

PLINES LOGICAL PADD �@ ���� ���

PLLEVEL INTEGER(2) DESI �@ �� � �

PLLST WORD(100) DESI ���������� ����@ ���

PLNAMES WORD(100) DESI ������������ �� ��@ ��� ��

PLNPEN INTEGER PADD �@ ����

PLORIENTATION ORI(3) DESI �@ �����������

PLPEN INTEGER PADD ���"����� ����

PLPMETHOD WORD DESI � ������������� �����@���������#������

PLPPOSITION WORD DESI � ��������������������#���!��������*�%��*�

PLPURPOSE WORD DESI �@ ���������

PLRDIRECTION DIRECTION(3) DESI � �����������������

PLREFS REF(5000) DESI �@ ��������

PLRF REFERENCE PADD � �������

PLSPACING REAL PDD ���"����� ���>�� ���������

PLSTART POSITION(3) DESI �@ ��������

PLSTCUT POSITION(3) DESI �@ �������!�� �#���������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-33

Attribute Name Data Type DB Type

Description

PLTUFLAG LOGICAL DESI �@ ������� ���

PLTXT TEXT(120) PADD ���"����� ���>��

PLWWPOSITION WORD DESI � ��#� @��@#� ��������������!��������*�%��*�

PMAXIMUM INTEGER DESI ISOD

'�>� � ������� ��������������� ����#���

PMLFUNCTION TEXT(120) PADD �'���������

PMODE TEXT PADD � �� ���

PNAME TEXT(12) PROP ������������������

POBORE REAL DESI ���������

POCKET WORD DESI &������������ �������������\���

TOP FOR AIR LOCK �

BOTT FOR SUMP �

NONO FOR NO POCKET

POCONNECTION WORD DESI ������������

POD REAL DESI �@��������������� ���

PODIRECTION DIRECTION(3) DESI �������������

POEFLAG LOGICAL DESI ����@�� ������� ���

POFFSET TEXT(1000) CATA ������

POISSONS REAL PROP ������� �����������8��������

PONAME TEXT(120) DESI ������ �

POORIENTATION ORI(3) DESI ��������������

POPCODE INTEGER TRAN ����@������������

POPS POSITION(3) DESI �������������

POSEE REAL DESI �������������������������

POSEND POSITION(3) DESI �����������������

POSEU REAL DESI %�����������������������

POSFLAG LOGICAL DESI ����������� ���

POSLINE WORD DESI ���������� ��

POSN REAL DESI PADD

�������������������

POSSE REAL DESI �����������������������������

POSSN REAL DESI ������������������������������

POSSTART POSITION(3) DESI �������������������

POSSU REAL DESI %���������������������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-34 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

POSU REAL DESI PADD

%����������������

POTARGET REFERENCE DESI ����������������

PPBORE REAL DESI �@���������

PPCONNECTION WORD DESI �@����������������

PPCOUNT INTEGER DESI �� �������� ����@������

PPDESCRIPTION TEXT(120) DESI �@���������������

PPDIRECTION INTEGER PADD �@������ ���������������

PPEXST LOGICAL DESI ��������@�����>�����

PPLST INTEGER(100) DESI ���������� ����@������

PPNUMBER INTEGER DESI -�����@����9������ ���

PPOSITION POSITION(3) DESI �@�������������

PPROPERTY TEXT(1000) CATA ���� ��������������>�������

PPSKEY WORD DESI �@�������(�+�

PPURPOSE WORD DESI �@������������

PPVIFLAG INTEGER DESI �@����������� ����� ���

PPVISIBILITY INTEGER(100) DESI PADD

������������� ��@������

PQUALIFIER WORD PROP ��������2�� �����

PRADIUS TEXT(1000) CATA *������

PRAVERAGE REAL DESI �������������

PRDEFAULT TEXT(250) DESI ������������ ��

PREFLAG LOGICAL DESI ��@�� ������� ���

PREOPERATION REFERENCE TRAN *��������%�0�'9���*����������������������

PRESSURE REAL DESI PROP

�������

PRFACTOR REAL PROP ��������������

PRFL TEXT(120) DESI ����� �

PRIMDB TEXT SYST -1���� ���9��������

PRIMTYPE LOGICAL ALL ������� ���������� ����

PRJDESC TEXT(180) SYST ���"�������������

PRJLOCK LOGICAL SYST ���"��� ����

PRJNUMBER TEXT(17) SYST ���"���� ���

PRJSTATUS WORD SYST ����������� ����"����������

PRLST WORD(100) DESI ���������� ������������@����� ������������

PRMAXIMUM REAL DESI '�>� � ��������

PRMINIMUM REAL DESI '�� � ��������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-35

Attribute Name Data Type DB Type

Description

PRMLOCATION REFERENCE SYST ��� ���� �������

PRMMEM LOGICAL ALL ���������� ���� ��� �����������

PRMOWN REFERENCE ALL ��� �����#��� ��

PRMRF REFERENCE GLOB ��� ���� ������� ��

PRMVISIBILITY LOGICAL PADD -������������ ����������� ����

PROFILE LOGICAL PADD ����� �� ���

PROJID INTEGER(3) SYST ���"�������������-1� ��

PROPERTY TEXT(250) DESI ���������� ����� ����� ���9������������

PROPG LOGICAL GLOB -1������������� ���

PRPURPOSE WORD DESI ���������������

PRTITLE TEXT(120) DESI ����������� �

PRVLOCATION TEXT (3) TRAN �������� ������������ ���

PRVRF REFERENCE GLOB *����������������#�����-1�

PRVSES INTEGER ALL ������������������������������

PSATTS WORD (500) ALL �������������@����������

PSESSDB INTEGER SYST ��������������� ���

PSIZE REAL(2) DESI �� ���H�

PSKEY WORD CATA (������&��-*�,��

PSPECIFICATION REFERENCE DESI ����������������

PSPINDLE INTEGER CATA �@������ ������#������������������ �

PSTATUS INTEGER PADD � ���������

PSTF REFERENCE PADD ������������

PSTREFERENCE REFERENCE CATA ��������� ��@ ����������

PSYMBOLS LOGICAL PADD �������� ������ �� �� ���

PTANGLE TEXT PADD ���"����� ���>���� �� ���

PTBOP POSITION(3) DESI 1���� ����������� ��

PTBORE REAL DESI ������� �����

PTCDIRECTION INTEGER(250) CATA ���� ���������������

PTCHEIGHT REAL PADD ���"������>�����������������

PTCONNECT WORD DESI ������� ������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-36 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

PTCPOSITION TEXT(250) CATA ���� ��������������

PTDIAMETER TEXT(1000) CATA ������������ ����

PTDIRECTION DIRECTION(3) DESI ������� ���������

PTDISTANCE TEXT(1000) CATA -��������������������

PTEMPERATURE REAL PROP ���#����� �������

PTEPOSITION TEXT(250) CATA ���� ����������������

PTFARRAY REF(17) PADD �����������

PTGRADIENT REAL DESI ������� ��������

PTLHEIGHT REAL PADD ���"������>�� ����������

PTNBARRAY INTEGER(20) DESI � ��������*��� ���� ������� ����

PTNHEAD INTEGER DESI � ��������*��������������� ���

PTNO INTEGER DESI � ��������*��� ���������� ���

PTNTUBE INTEGER DESI � ��������*����������� ���

PTOD REAL DESI ������� ����������� ���

PTOFFSET REAL(2) PADD ���"����� ���>��������

PTOP POSITION(3) DESI �����������

PTPEN INTEGER PADD ���"������>����

PTPOSITION POSITION(3) DESI ������� ���������

PTREFERENCE REFERENCE CATA �������������

PTRF REFERENCE PADD ����������

PTS INTEGER(6) CATA ����������������������� ����

PTSPECIFICATION TEXT(120) DESI �����������������

PTSPOSITION TEXT(250) CATA ���� ��������������������

PTTOP POSITION(3) DESI �������������� �

PTYPE WORD DESI CATA

������������

PUNITS TEXT(32) CATA -�����������������

PURPOSE WORD MANY -�������������#����

PVIFILTER INTEGER CATA �@����������� ������ ���

PVNO INTEGER PADD �������������� ���

PWASTAGE REAL PROP �������#�������������

PWIDTH TEXT(1000) CATA )��������#� ���������

PX TEXT(1000) CATA 0�������E���������

PXBSHEAR TEXT(1000) CATA &� �������������� ����������� ��� �E��>���

PXLENGTH TEXT(1000) CATA E� ����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-37

Attribute Name Data Type DB Type

Description

PXTSHEAR TEXT(1000) CATA &� ����������������������� ��� �E��>���

PY TEXT(1000) CATA 0�������+���������

PYBSHEAR TEXT(1000) CATA &� �������������� ����������� ��� �+��>���

PYLENGTH TEXT(1000) CATA +� ����

PYTSHEAR TEXT(1000) CATA &� ����������������������� ��� �+��>���

PZ TEXT(1000) CATA 0�������S���������

PZLENGTH TEXT(1000) CATA S� ����

QUALIFIER INTEGER CATA C�� �����

QUANTITY INTEGER ALL C�������A� #�����PB�

QUESTION WORD CATA C������

RADDEFAULT REAL DESI *���������� ���� ��

RADFACTOR REAL DESI *�����������������������

RADIUS REAL DESI PADD

*������

RADLIMITS REAL(2) DESI *������ � ����A �9 �>B�

RADSETFLAG LOGICAL DESI *���������� ���@��������������� �������� ��

RATING REAL CATA �������������

RCODE TEXT PADD -��������������������� �������

RCOUNT INTEGER ALL �� �������� ���� ��

RDEFAULTS REAL(3) DESI �������������� >��� �������� ���

RDEPROP ���� �����-�*������

REFATT WORD DESI *�������������������������

REFERENCE REFERENCE ALL *���������� ��

REFINDEX INTEGER DESI *������������>�

REFLIST WORD(200) DICT *�������� ����

REFNO ���� ����*�,���

REGN REAL(4) PADD ��#������

RESOLUTION REAL DESI '�� ���� �����A������B�

REVDATE TEXT(12) PADD -�������������

REVISION INTEGER DESI *������

REVTIME TEXT(120) PADD �� �����������

RFLFACTORS REAL(3) PROP *������� ��������� ���

RHOST TEXT(120) GLOB .����� ����&������������� ��� �����

RINERTIA REAL(3) PROP *������� �������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-38 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

RINSIDE REAL DESI &�����������

RLACTION INTEGER(500) DESI *� �������������

RLEXCLUDE REF(20) DESI ����������������������� �>� ������� ��

RLIMIT REAL(6) PROP *������� � ����

RLINCLUDE REF(20) DESI ����������������������� ��� ������� ��

RLIST WORD(200) ALL ���������� �����

RLLOGICAL INTEGER(500) DESI *� � ����� �������

RLOCK INTEGER DESI 1����� ��������������������!��������*�%��*�

RLSELECTION INTEGER(500) DESI *� �� �����������

RLSTORED TEXT(500) DESI ���������*�%��*�������� ��

RMFLEXIBILITY REAL(6) PROP *������� � � ��� >��� ����

RNAME TEXT(120) PADD *������� �

ROBBRULES REF(500) DESI *������� ����� ������������� ����� ����

ROLEREF REFERENCE SYST ����������� ��� ���������� ��0*�

ROTN REAL(3) PROP *�������

ROUTSIDE REAL DESI ��������������

RPEN INTEGER PADD ���������� ���#��

RPRESSURE REAL PROP *�����������

RPROPERTY REAL CATA 0��� �������������������

RPTXT TEXT(20) DICT *�����������>��

RRSF REFERENCE PADD *����������� ��������

RSEQARRAY INTEGER(500) DESI �2���� ���������� �>������

RSEQFARRAY REF(500) DESI *� ��2������������������ ��� �� ��

RSEQNUMBER INTEGER DESI �2���� ��������� �>������

RSETFLAG LOGICAL(3) DESI *������� � �������� ���@�������� ������,� ��

RTEMPERATURE REAL PROP *����� �������

RTEXT TEXT(120) CATA �>��������

RTYPE TEXT(12) PROP *�����������

RULEMOD LOGICAL ALL ��������� � ������������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-39

Attribute Name Data Type DB Type

Description

RULEMODC LOGICAL ALL ��������� � ������������� �����������

RULEMODLIST WORD (500) ALL ���������� �� ���������������������

RULMDC WORD (500) ALL ���������� �� ������������� �����������

RULSET WORD (200) ALL ��������%-������

RUSE INTEGER CATA *���� ���������������������� �����������

RVAUTHOR TEXT(28) PADD *�������������

RVOLUME REAL DESI *������������� � �

RVSNUMBER TEXT(120) PADD *������� ���

RWDOWNER REFERENCE ISOD *�����������������)��-����*)��-� ��

RWDTBL INTEGER(2) ISOD ��� � �����*)��-� �����������)��-� ���

SAFCLASS INTEGER DESI ������� ����

SBRARRAY REF(10) CATA �1����������

SBRP REFERENCE DESI �1,*����*��������� ��!��������*�%��*��

SCALE INTEGER PADD -��������@������� �� ���� ��������

SCALIST REAL (500) PADD �-�� �����#�� �#�� ���� �

SCODE TEXT(3) DESI &��-*�,��0� �������������

SCOPEREF REFERENCE SYST ����������� ��������������� ��0*�

SCOSEL INTEGER(500) SYST ����������� ������

SDOC TEXT(40) COMP 0�'��*���*����� ��

SDTHICKNESS REAL(3) PROP ���� ���������

SECURITY TEXT SYST %�����������

SENSE TEXT PADD *������� ����

SESSCAT INTEGER (600)

ALL -1������������� ����������� �������������� ���� ���

SESSCHIER INTEGER (600)

ALL -1�������������������� ���� ����������������

SESSCOMMENT TEXT(120) ALL �������� ��

SESSDATE TEXT(120) ALL ����������

SESSMODIFIED INTEGER ALL ���������� ���� �����������

SESSNO INTEGER ALL 0���������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-40 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

SESSUSER TEXT(120) ALL %����������������

SETDAT TEXT(120) SYST GLOB

�������

SFLIMIT WORD DESI ���� ��� � ����

SFORCE REAL(3) DESI ������������������� ����

SFREF REFERENCE DESI *������������ ��������� ������� �������������� ������ ��

SHAPEMODULUS REAL PROP ����� ��� ���

SHOCKLOAD REAL(3) PROP ������ ����������

SHOP LOGICAL DESI ����9����� ���

SIFACTOR REAL(3) PROP �������������������������

SIGFIGURES INTEGER CATA �����������������

SIGNIF LOGICAL ALL ������� ���������������

SIZE REAL(2) PADD ���9�������H�

SIZEDB INTEGER SYST ��H����-1�

SJUSTIFICATION WORD DESI �������"�������������������=��

SKEY TEXT(4) MANY �� �� ����

SKEYSCALE INTEGER MANY %����� ��(�+���� ��������

SMAXIMUM INTEGER DESI ISOD

'�>� � ����� �� ��������������� ����#���

SMNO INTEGER SYST �'�-%�� ���

SMODE TEXT PADD �������� ���

SMOMENT REAL(3) DESI ������ � ���� ����

SNAME TEXT(160) COMP 0�'��*���*�� ��� �� �������������������

SORF REFERENCE PADD �����������A�������� �������� ������B�

SOURCE TEXT(120) PADD ������ �����

SOUTH REAL DESI PADD

�������������������

SPINDLE TEXT(4) PADD -*�,�����@��������� ��� �� 9�(�+�� �

SPKBRK LOGICAL DESI ������ ������������������ � ��

SPLCHG LOGICAL ISOD %������� ������ ��#�����������

SPLH TEXT(120) DESI � ��������*������������� �� ���

SPLMEM REF(1500) ISOD ���� ������ ���������������� ����,� �� ���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-41

Attribute Name Data Type DB Type

Description

SPLN TEXT(120) DESI � ��������*��� �������� �� ���

SPLNUMBER INTEGER ISOD ���� �� ���

SPLPARENT REF(500) ISOD 1������������������� ���!����� ����,� ��

SPLPREFIX TEXT(120) DESI ISOD

���� �� �������>�

SPLT TEXT(120) DESI � ��������*��������� �� ���

SPLTBL INT(2000) ISOD ��� � ��������� ����,� �� �������������� �����

SPLVOLUME REAL(3) ISOD �� � ���������� � ��

SPMA REAL DESI �������������� � �>� � ���#��

SPOONUMBER TEXT(120) DESI ���� �� ����� ��������� �����>�

SPOWNER REFERENCE DESI *����������0��#�����0����������� ����

SPPURPOSE WORD PADD ����� ����������� ����������

SPRA REAL DESI �������������� ���#��

SPRB REAL DESI ������������������#��

SPREFERENCE REFERENCE DESI 0� ���������������������

SPSP TEXT(2) DESI � ��������*����� �����>�

SPWD TEXT DESI �������������>����#��

SREFERENCE TEXT(12) PROP �����������

SRELEASE INTEGER DESI ������� ����A�������B�

SREVAY REF(50) PADD ������������������

SRTPRIORITY INTEGER PADD ���������������������� ������

SSHEET TEXT(40) COMP 0�'��*���*��� ��������������������

STALENGTH REAL DESI ���������������������������

STANGLE REAL DESI �������� �

STEXT TEXT(120) MANY �>��������

STITLE TEXT(120) PADD ������� �

STLENGTH REAL DESI �������� ����������������

STLREF REFERENCE DESI �� ������

STLSF REFERENCE SYST -������������

STMF REFERENCE DESI � � ���� �����������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-42 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

STNO TEXT SYST ��� �� ���

STPDBS REF (5000) SYST ��� ��������������

STPSES INT (1500) SYST ���������������� ��������� ��

STRESS REAL PROP ������� �����������

STSESS INTEGER SYST -�������������� ���

STSPECIFICATION REFERENCE DESI ��������� �������������

STYF REFERENCE PADD *������������ ������

STYPE TEXT DESI SYST

���0�������2������

SUPREF REFERENCE DESI �������������

SURFACE TEXT(120) DESI �����������������

SVERSION TEXT(20) COMP 0�'��*���*������������

SYSIZE REAL PADD �� �� ���H�A����� ���� ��B�

SYSLOCATION TEXT (3) TRAN ���� � ������������ ���������

SZDISTANCE REAL DESI ������ �����������������

TAIL ���� �����*�,���

TANSWER TEXT(256) CATA �>����#�������>����+����������������

TARFLAG REFERENCE DESI ����������������

TBORE REAL DESI ��� �����

TCATREFERENCE REFERENCE DESI ��������� ���������

TCDDEFAULT TEXT(250) DESI 0���������������������� ���� ��

TCDPROPERTY TEXT(250) DESI 0�������������������� ��

TCODE TEXT PADD .���������������

TCONNECTION WORD DESI ��� ������������

TCTLENGTH REAL DESI �������� ����

TDEFAULT TEXT(256) CATA �>������ �������>����+����������������

TDETAIL REFERENCE DESI ��������� ��>�������

TDIRECTION DIRECTION(3) DESI ��� ���������

TDMFARRAY REF(2) DESI &��-*�,��������� �������������

TDMTYPE WORD(2) DESI &��-*�,��������� ��������������

TDPROPERTY REAL DESI � � �����������������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-43

Attribute Name Data Type DB Type

Description

TDRTEXT TEXT(120) DESI ��������� �*��E��

TDSTEXT TEXT(120) DESI �����-��� ����E��

TDTTEXT TEXT(120) DESI �����-��� ����E��

TEAMLS REF(1000) SYST ���������� �����#���������� ����

TEASTATUS WORD SYST ����������� ��� ��������

TEMF REFERENCE SYST �� ������

TEMPERATURE REAL DESI PROP

� �������

TEND TEXT DESI 0������������������������A.��9��� B�

TEXIST LOGICAL DESI ��������� ���������%1&�

TFDPROPERTY REFERENCE DESI � � �����������������������

TGRADIENT REAL PROP ���#����� ��������������

THPOSITION POSITION(3) PADD �������������������#���

TIMEE INTEGER SYST ����� ����0� ��#���#�

TIMEI INTEGER SYST 0� ��������� ������ �

TIMEO INTEGER SYST 0� �� �>� � �����������

TIMER TEXT(120) SYST ,�2�������-1������������

TIMES INTEGER SYST �������� ����0� ��#���#�

TITLE TEXT(120) PADD ��� �

TLINDICATOR LOGICAL PADD ���� �������������

TMATREF REFERENCE DESI ����� ����� ��>�������

TMAVERAGE REAL DESI ������� �������

TMMAXIMUM REAL DESI '�>� � �� �������

TMMINIMUM REAL DESI '�� � �� �������

TMPREFERENCE REFERENCE DESI CATA

� � ����������� ���0��

TMRF REFERENCE PADD � � ��������

TMXTEXT TEXT(120) DESI �����'����� �E��E��

TMYTEXT TEXT(120) DESI �����'����� �+��E��

TMZTEXT TEXT(120) DESI �����'����� �S��E��

TNAME TEXT(50) COMP /��1���� ��������#�� �������������

TNOTE TEXT(100) COMP �������������������������������������������

TPARAM DESI TPAR ��������� ������ �������� ����

Appendix D: PDMS Attributes and Pseudo-Attributes

D-44 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

TPEN INTEGER PADD �>����

TPONUMBER INTEGER DESI ��������� ���

TPOSE REAL DESI ������������� ���������

TPOSITION POSITION(3) DESI ��� ���������

TPOSN REAL DESI �������������� ���������

TPOSU REAL DESI %����������� ���������

TPREFERENCE REFERENCE DESI ��� �����������

TPROJ TEXT(48) COMP �� ����������"��������������������

TPVALUE TEXT(120) PADD -*�,����������� ����� ��A�����-�B�

TQUALIFIER TEXT(256) CATA �>��2�� ����������������������� �����

TQUESTION TEXT(256) CATA �>��2������������������������ �����

TRANSFORMATION REAL(12) DESI ���� �������� ����� ����>�

TRAREA INTEGER TRAN ����

TRCARGUMENTS TEXT (3) TRAN ���� ��2�� ������

TRCG LOGICAL PADD -��������@������� �� ������� ���

TRDACCESS TEXT TRAN -�������������

TRDBNO INTEGER TRAN -1�� ���

TRDBRF REFERENCE TRAN ����-1������

TREFERENCE REFERENCE DESI ��� ������

TREXTNO INTEGER TRAN �>������� ���

TRFINO INTEGER TRAN ������ �� ���

TRLOCL LOGICAL TRAN ��������� ��� ��� ���

TRMODU TEXT TRAN '��� ���#������� ���#�������

TRPASSED LOGICAL TRAN �������� ���� ��� ���

TRSETL LOGICAL TRAN ������� ��� ��� ������������������������

TRSF REFERENCE PADD ������ ��������

TRSTYPE TEXT TRAN ���0�������2������

TRUNCATION REAL PADD ����������� ��AM�B�����������A@�B�

TRVISI LOGICAL TRAN )���������� ����������� �

TSFBREAK LOGICAL DESI ���� ��� �������������������� �����

TSIZE REAL PADD �� ��������H�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-45

Attribute Name Data Type DB Type

Description

TSPECIFICATION REFERENCE DESI ������������������������

TSPREF REFERENCE DESI ������������������� ���������

TSYSTEM TEXT(20) COMP �� ����������� �#��������������������������������

TTEXT TEXT(120) CATA �>��������

TTNOTE TEXT(100) COMP ��������#����������� �#���������

TTYPE WORD DESI � � �������

TUBEFLAG LOGICAL PADD ������� ���

TUCLLENGTH REAL DESI ������� �� �������������

TUFLAG LOGICAL CATA ����� ���

TULENGTH REAL DESI ���� �������������

TVERSION TEXT(20) COMP 0�'��*���*��������� ���

TVISIBILITY LOGICAL CATA ���������� ����� ���

TWRF REFERENCE DESI ��� �#����������!��������*�%��*�

TYNAME WORD SYST .�������������������� ���

TYNUMBER INTEGER SYST �� �������

TYPE WORD ALL ���������� ��

TYPEDB TEXT SYST -1�����

TYSEQUENCE INTEGER ALL �����2���� ���

UBULGEFACTOR REAL DESI %����� �������������������� ����

UCODBORE INTEGER PADD %����������������

UCODDISTANCE INTEGER PADD %�������������������

UCODE INTEGER PADD %��������

UCURD REF (300) COMM %0%*-�

UCURTYPE WORD DESI %������������

UDACPY REFERENCE DICT %��@�������������������

UDASET WORD(200) ALL �����������@������������������

UDNAME TEXT(12) DICT %������������������ �

UIWEIGHT REAL PROP %������ �����#�����

UKEY INTEGER DICT %-�����@����� ���2������ ���������

ULENGTH INTEGER DICT �����������������>��

Appendix D: PDMS Attributes and Pseudo-Attributes

D-46 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

UNAME TEXT(12) PROP �� ��������

UNDERLINE LOGICAL PADD %�� ��� ���

UPDATECALLBACK TEXT(500) PADD �-���������� �����

URADIUS REAL DESI %��������������������� ����

UREFERENCE REFERENCE CATA %���������

USCLHI REF(5000) ALL � ����� �#������������ �� ���������������A��%��0�.B�

USERCLAIM TEXT(120) ALL %��� ��������� �� ��� ��

USERLS REF(1000) SYST �������������� ���������� �

USERMODIFIED TEXT(120) ALL %��� ����� ���� �����������

USERSTOPPED REFERENCE TRAN %���#������ ���� ���

USESSDB TEXT(120) SYST %����������������

USNCLH REF(5000) ALL � ����� �#��������������� �� ��������������A��%�0�.&B�

UTYPE WORD DICT %��@������������������

UUNITS TEXT(20) DICT �>�����������

UWEIGHT REAL PROP %�������#�����

VALIDVALUE TEXT(1000) DESI �� ����� ��>���������������%�� ���

VCOMPDATE TEXT (50) PADD ��#��� �����������

VCOMPSTAMP REFERENCE PADD ��#��� ���������� ��

VGAPLENGTH REAL PADD ��#����� ����

VIRFLAG LOGICAL DESI ������ �� ���

VLIMITS REAL(6) PADD ��#� � ����

VMARGIN REAL PADD �-����#� ������

VNREF REFERENCE PADD ����������!������ ������������������-��

VRATIO REAL(2) PADD ��#�������

VSCALE REAL PADD ��#������ �@���� �����"������#�

VTITLE TEXT(120) PADD ��#���� �

VTYPE TEXT PADD ��������������#�

VVOLUME REAL(6) PADD ��#��� � �

VWLIMITS REAL(6) PADD ��#� � ���!������ ������������������-��

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-47

Attribute Name Data Type DB Type

Description

VWREFARRAY REF(20) PADD ��#�����!������ ������������������-��

VXREFS REF (500) DESI ���>������������

WAITIME INTEGER TRAN �� ������ ���#�������

WAMAXIMUM REAL DESI '�>� � �#���� � �

WBORE REAL ISOD 1������&)��-9*)��-�

WDBNAME TEXT ALL )������-1�� �

WDESPARAM WORD(100) DESI -�������� �������#�����

WDIAMETER REAL PROP )������ ��� ��� ���

WEFACTOR REAL PROP )����� � ��� ��������������

WEIGHTING REAL(3) DESI )��������� ��

WEST REAL DESI PADD

)����������������

WIDTH REAL DESI )�����

WIFACTOR REAL PROP )��� � ��� ��������������

WJPOSITION POSITION(3) ISOD & � ���# ����������

WLDNUMBER INTEGER DESI ISOD

) ��� ���

WLDPREFIX TEXT(4) DESI ISOD

) ��� �������>�

WLDREF REFERENCE DESI *������������ ��@��������)��-����&)��-����*)��-�

WLDXRF REF (2) ISOD %������� ������ ��#�����������

WMAXIMUM INTEGER DESI ISOD

'�>� � �# ��� ��������������� ����#���A&��-*�,�B�

WORIENTATION ORI(3) DESI )�� �����������

WORPOSITION POSITION(3) DESI )�� ����������

WPARAMETERS WORD(100) CATA PADD

���� �������#�����

WPRESSURE REAL PROP )����������

WSHOP LOGICAL ISOD ) ������9����� �����&)��-9*)��-�

WSPECIFICATION REFERENCE ISOD ) ����������������&)��-9*)��-�

WTOLERANCE REAL PROP )� ����������� ����9�)������� ����

WTRANSFORMATION REAL(12) DESI ������� ����� ����>����)�� ��

WVOLUME REAL(6) DESI PADD

�� �������>��� � ���)�� ������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-48 PDMS Software Customisation Reference Manual

Attribute Name Data Type DB Type

Description

X REAL DESI PADD

������������������

XBOTTOM REAL DESI PADD

1���� �E� �����

XBSHEAR REAL DESI E������ ��������� �������������� �������� ��� �E��>���

XLENGTH REAL DESI PADD

E� ����

XOFFSET REAL DESI PADD

E�������

XTEXT TEXT(120) CATA E��>��

XTOP REAL DESI PADD

����E� ����

XTRALENGTH REAL CATA �>���� �����2��� �������� ���

XTSHEAR REAL DESI E������������� �������������������� ��� �E��>���

XYPOSITION POSITION(2) PADD 5-���������

XYSCALE REAL(2) PADD ��� �E+���H�

Y REAL DESI PADD

�������������������

YBOTTOM REAL DESI PADD

1���� �+� ����

YBSHEAR REAL DESI +������ ��������� �������������� �������� ��� �+��>���

YDIRECTION DIRECTION(3) DESI �������+��>�����������

YLENGTH REAL DESI PADD

+� ����

YOFFSET REAL DESI PADD

+�������

YOUNGS REAL PROP ������� �����+���8�� ��� ���

YTEXT TEXT(120) CATA +��>��

YTOP REAL DESI PADD

����+� ����

YTSHEAR REAL DESI +������������� �������������������� ��� �+��>���

Z REAL DESI PADD

%����������������

ZDIRECTION DIRECTION(3) DESI �������� ��>�����������

ZDISTANCE REAL DESI ����������������

ZLENGTH REAL DESI PADD

S� ����

ZTEXT TEXT(120) CATA S��>��������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-49

Attribute Name Data Type DB Type

Description

[CLAI] INTEGER SYST 0 �� � ���

[MIDBK] REF (5000) ALL *������������ ����������������

[MID] REF (5000) ALL *������������ ����

[ORIE] ���� �����*&������

[SECU] INTEGER SYST %�����������

[STAT] WORD COMM �������

Table D- 1 : PDMS Attributes

D.2. Pseudo-Attributes

������������������������������ �#�����������������������$�����������2������������� ��� �!������'�����������>�����������������$�

D.2.1. Pseudo-Attribute Syntax

��� � ���������>����������@������������������ �#���$���������� ���#��#���������2����$�

�� ����������������������������� �2�� �����!�$�$��@������ ��$����������� ���������2�� ���������

• &���$�

• ���������� $�

• ����� �A �����B$�

• )���$�

&������������������ �����#����2�� ���������2����$�

�������>�����2�� ���������I���������� D�!�����!�2�� ����!�$�$������3$�.�#��!�#�����������'����������>������������������$�,��������������>!�2�� ������������ ������� �#���

• �����������9#����2�� ��������������������������!�$�$�����2�������������������������������������!��������>�����PP�$����$���$�

• ��������2�� ������������2�����������!�$�$�PP�$����T3U$��

• ����2�� ����������������������Z�������� ����*�����>$�

D.2.2. Grouping of Pseudo-Attributes

��� ���������������#���������� �#�����������

� ��������� ��������All elements on all DBs

� �������� ���9�#��9���������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-50 PDMS Software Customisation Reference Manual

� ������������������

� ��������-1�

� ����������������������

� ��������� �� ��

� ��������>�������

� ������������������� �

� ���������� ��

'����-��&� ������$�

'����-��&� ������!�-���������������$�

-��&� ���#���������� ����������$���$��$���������� ���$�

���������������� ����$�

�%1&�

1*��0.� ���

�0���!�/����0��

=�����

������������� ��� ��

Design DBs.

�����

0��� ����-1��

��0�� ����

0��� ����-������� ���

���� ��-1��

���� �-1�

-1�� ��

-1����� ��

DRAFT DBs

��������������������� �-1�

D.2.3. All elements on All DBs

All Element Types – Relating to Name and Type

Pseudo-Attribute Type Comment

ISNAMED LOGICAL ������� ������ ��

‘NAMN’ OR NAM NOPREF

TEXT �� �#�����������>�A�������9B�

FLNM OR FULLNAME TEXT ��� ?�$�$�1�E�3��,�9�%'�3�

FLNN TEXT ���,��'�#���������� ������ ����

CUTNAM INT TEXT ���,��'����������������� ���

CUTNMN INT TEXT ���,�������������������� ���

NAMTYP TEXT ���,��'�#����������������� �

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-51

Pseudo-Attribute Type Comment

NAMESQ TEXT ����M��2���� ���M�� ��������

NAMETY TEXT ����M�� ��������

FULLTYPE WORD ����+��!����������������������������������

HARDTY WORD .���������������

PRIMTY LOGICAL ������������ ���� ��

Table D- 2: All Element Types – Relating to Name an d Type

Appendix D: PDMS Attributes and Pseudo-Attributes

D-52 PDMS Software Customisation Reference Manual

All Element Types – Relating to Members/Owners/Desc endants:

Member list position

Pseudo-Attribute Type Comment

SEQUENCE INTEGER ���������� ��� ��������#��

TYSEQU INTEGER ��������������� �������� �����

Valid owners/members/ascendants/descendants

Pseudo-Attribute Type Comment

LIST WORD(38) ������ �������� ��� ����

OLIST WORD(*) ������ ����������#��

HLIST WORD(*) ������ ���������

LLIS WORD(*) ������ ���������

Actual members/descendants

Pseudo-Attribute Type Comment

MEMBER NOUN REF(*) ' ����������������

MBACK REF(*) *������������ ��� ����

MCOUNT NOUN INTEGER 0������� �������� ���� ���$�&�������������!�������� � ��� �����������������$�

DDEPTH INTEGER -������������� �#�)�� ��A)�� �����6!��������3���$B�

MAXDEPTH INTEGER �� �#�������������������������A--��B�������� �#��� � ��� ��#�������������� ��

PRMMEM LOGICAL �������������������� ���� ������ �D����������

QUANTITY INTEGER �� ������ ��!������ ��� #����3�

Actual owners/ascendants

Pseudo-Attribute Type Comment

PARENT NOUN REFERENCE *�������������������������

OWNLST REF(*) ���������������������!���������� ����!�)�� ��A�#�� ���B�

AHLIST WORD(*) ��������� ��������� �������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-53

Pseudo-Attribute Type Comment

PRMOWN REFERENCE �#������ ���� ��A���� �������� ���B�

OHTYPE WORD .������������#��

OSTYPE WORD �������������#��

All Element Types – Relating to Attributes:

Pseudo-Attribute Type Comment

ATTLIS WORD(*) ������������������

UDASET WORD(*) ��������%-������

All Element Types – Relating to DB:

Pseudo-Attribute Type Comment

DBREF REFERENCE -1� �������� �-1����������-1�

DBNUMBER INTEGER -1�� ���

DBNAME TEXT(50) -1�� !�$�$�'����*9-��&�

DBFILE TEXT -1��� � !�$�$�^1��666^9���6:7�

DBFNUMBER INTEGER -1��� � ��!�$�$�:7�

DBTYPE WORD -1����!�$�$�-��&�

DBAC TEXT -1�����������Z�%�-�������'%��&)*&���

DBCL TEXT -1�� �� ������Z�&'��&0&������E��&0&��

CRINFO TEXT -1������������A#��9#��9���9�� 9�� ���� ����B�

DBSESS INTEGER ������������ �������-1�

DBWRIT LOGICAL ������� ���������#����� �-1�

DBEXNO INTEGER �>������� ������������-1�

DBCNTL LOGICAL 0���� �-1�������

DBVAR LOGICAL �������������

WDBNA TEXT )������-1�� �

Note: ���2���� ��������������2��������� ������� �� ��������-1� ����������� �-1$�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-54 PDMS Software Customisation Reference Manual

All Element Types – Relating to Session History:

Pseudo-Attribute Type Comment

LASTMOD TEXT -������ ���� �������������� ��

LASTMOD ATTNAME TEXT -������ ���� �����������������������

SESSMOD INTEGER ������� ������ ���� �����������

HISTORY INT(*) � ����������#����� �������

HISTORY ATTNAME INT(*) � ����������#��������������#��� �������

USERMOD TEXT ������������ ������ ��

LASTMOD HIER TEXT -������ ���� �������������� ������������������������

SESSMOD HIER TEXT ������� ������ ���� �������������� ������������������������

USERM HIER TEXT ������������ ������ ������������������������

SESSD INT TEXT -������������

SESSU INT TEXT %��� �����������

SESSC INT TEXT �������� ��

SESSNO INT INTEGER ����������

SESCLA INTEGER ��������#���������� ���� ��#���� �� ����������>�����$�*�����I���D������ ��������� �� ����������>�����$�

PRVSES INT INTEGER ������������������������������

SESSCA INT(*) *�����-1�� ������������� ������ ���� ���������������� � �������������� ����������� ����� ������ ��A$�$����� ����-1�������B�

SESSCH INT(*) �����������0�!������������ ���� ��������� ����� ���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-55

All Element Types – Relating to Claims:

Pseudo-Attribute Type Comment

USERC TEXT �-'������������ ��� �� ��

CLMID TEXT %�2������ �&-�������� ������ �� �A ������#������������B�

OKREL LOGICAL ������� �� ������ ����

OKRLH LOGICAL ������� ������������� ������ ����

OKCLA LOGICAL ������� �� ������ �� ��

OKCLH LOGICAL ������� ������������� ������ �� ��

LCLM LOGICAL &�� ��� �� �������������\�

LCLMH LOGICAL ��� ������ ���������� �� �������������\�

USCLHI REF(*) -�������� �� ��������������

USNCLH REF(*) -����������� �� ��������������

MODATT ATTNAME LOGICAL 0�������������� ����������0������-�09 ���9*��� �9� �� 9��$�

MODDEL ATTNAME LOGICAL 0�������������� ����� ��\�0������-�09 ���9*��� �9� �� 9��$�

All Element Types – Relating to Extracts:

Pseudo-Attribute Type Comment

EXCLT LOGICAL ������� ��� �� ����������>�����$�)� �� ���������������� ���� �?��$$����������� �����������IC�0��&'�&����E�*�0�D�

EXCLFR LOGICAL ������� ��� �� ����� ������>�����$�� ����������� ���� ��?��$$���������������� ��#�� ����������IC�0��&'�&����E�*�0����.�*D�

EXCLHI REFERENCE ����������� ���� ���� �#�������!������ �����������!�#������������ �� ��������>�����?��$$������� ��� ���� �

EXNCLH REFERENCE ����������� ���� ���� �#�������!������ �����������!�#��������������� �� ��������>�����?��$$������� ��� �� �� �

Appendix D: PDMS Attributes and Pseudo-Attributes

D-56 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

PRMOWN REFERENCE *������#������ ���� �!������� �!������� ����A�$$�#�������� �� 9� ��B�

EXMOD LOGICAL ������� �������� ���!���� ������������������ ��������?��$$���� ���������������#����������������� ��

EXPMOD LOGICAL ������� �������� ���!���� ������������������ ���������������I����� ���D���� ��?��$$���� ���������������#����������

EXMOC LOGICAL ����E'�-!����������������������� �� �������������� ��� �����

EXPMOC LOGICAL ����E�'�-!����������������������� �� �������������� ��� �����

OKDROP LOGICAL ������� ��������������A�� ��������� ������ ��� �B$�1����� ���E�'�-�����������������������E0�,*$�

OKRLEX LOGICAL �������>������� ������������ ?��$$���������!����� �� ������������$����������������E�'�0$�

OKRLEH REF(*) *����� ���������� ������ �����������������������>������� ���

OKDRPH REF(*) *������� ������� �����������������������������

EXTRC TEXT �>���������#������� ������ �� �$��1��&��%��*0������!�����E�*0�#� �� #����������������������>����������������������� �� ����� $�

EXTCON REF(*) � ���#���������������������������� ������ ������������������� �������>������

EXTCNN REF(*) ������������E�0��$��� ���� ���� ���#�������������� ������������>������A��������������������B$�

EXTCNC REF(*) ������������E�0��$��� ���� ���� ���#�������������� ������������>������A��������������������B$�

�E�0�0�M��E�0���#� ������E�0���

EXTRCO REF(*) ����E�0���������� ���������� ����������������

EXTRCN REF(*) ����E�0���������� ���������� ����������������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-57

Pseudo-Attribute Type Comment

EXHCON REF(*) ����E�0��������������������� �-�������

EXHCNN REF(*) ����E�0��������������������� �-�������

EXHCNC REF(*) ����E�0�0������������������� �-�������

EXHRCO REF(*) ����E�*0�������������������� �-�������

EXHRCN REF(*) ����E�*��������������������� �-�������

Note: �����������(-*�������������I�� ������D�������$��,���>� � !���������� �9,*�-����9��'����9��'����9,*�-�������� ��� �������������������$���������������������������������@���������$�

,����E�*0!�%��*0�������� �#� �� ����������� ������������>���������!���������������>������$��,���>� � !����������������'�����>�����!�������� �� ������������ ������������ �� ��������� �������� ��$��&������������������������� �� ������������ ��������������#�������������� ��>������$��&�� �������#�� �������������!���������� ������������������� �������� ����������$������������������ ������ ������������� �������������� �IC�0��&'�&���[D�

����� �#������������������������������ �I������D��0*�,!��*�,!�.*�,!�0*,�!��E*�,!�=�&�!�=�&�!�-�� ��� ���������� ��

Appendix D: PDMS Attributes and Pseudo-Attributes

D-58 PDMS Software Customisation Reference Manual

All Element Types – Relating to Access Control:

Pseudo-Attribute Type Comment

DACDRO LOGICAL -�������������� �� �#� �������������\�

DACMOD LOGICAL -�������������� �� �#� ������� ������\�

DACCRE LOGICAL -�������������� �� �#� ������������\�

DACCRE NOUN LOGICAL -�������������� �� �#� �����������������������\�

DACCLA LOGICAL -�������������� �� �#� �������� �� �\�

DACDEL LOGICAL -�������������� �� �#� �������� ��\�

DACISS LOGICAL -�������������� �� �#� ������������\�

DACERR ATTNAME TEXT *����-�0�������>�������#�� ����������������������#��� �������

DACERR CLAIM TEXT *����-�0�������>�������#�� �����������������E�*�0��0��&'�

DACERR DELETE TEXT *����-�0�������>�������#�� ������������� ��#���� ���

DACERR CREATE TEXT *����-�0�������>�������#�� ������������� ��#���������

DACERR NOUN TEXT *����-�0�������>�������#�� ������������� �������������#���������

All Element Types – Relating to Rules:

Pseudo-Attribute Type Comment

RCOUN INTEGER *� ������

RLIST WORD(200) ������������������#������ �����

NRULEE INTEGER �� �������� ��������� ��

RULEER INT TEXT *��������� ������

All Element Types – Relating to Sessions and Compar ison Date:

Pseudo-Attribute Type Comment

ATTMOD WORD LOGICAL .������������#������ ������������������

ATTMOC WORD LOGICAL .������������#������ ���������������� �����������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-59

Pseudo-Attribute Type Comment

ELEMOD LOGICAL .��� ���� �����������������������������

ELEMOC LOGICAL .��� ���� ���������������� �����������

ELECRE LOGICAL .��� ��������������������������������

ELECRC LOGICAL .��� ������������������� �����������

ELEDEL LOGICAL .��� ����� �������������������������

ELEDEC LOGICAL .��� ����� ������������ �����������

RULMOD LOGICAL .����� ��� ����������������������

RULMOC LOGICAL .����� ��� ���������������� �����������

ATTMDL WORD(*) ������������������ ������������������

ATTMDC WORD(*) ������������������ ���������������� �����������

RULMDL WORD(*) ���������� �� ������������������

RULMDC WORD(*) ���������� �� ���������������� �����������

Special Attributes For Use in the MODIFIED, CREATED and DELETED functions

Pseudo-Attribute Type Comment

GEOM LOGICAL .�������������������� ������� ���3�������

CATTEXT LOGICAL .������������������� ��������� ���� ����� ��>�������$�

CATMOD LOGICAL .������� �5���������� ����������

3����� ������� ����� ������� ����� ������� ����� ������� ��������������������

• ����� ������������ ���������������

• ����@�����������

• ���9�*&�������

��� � ����� ��������������� ������� ����#� �����������������REPRE MASS��� ��$����REPRE MASS��� ���������� �� ���&��-*�,�$�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-60 PDMS Software Customisation Reference Manual

5�* �������� �����������������������

• ��*�,�

• ��0�� ���

• 0�'�� ���

• ����!�/'��!������!��� ���� ���

• ����������� ���

• -��E�!'��E�� ���

���������������������� ����������#�CATMOD�������������#������� ����������$����CATTEXT ���GEOM���#�����#����������� ������� ��$������������������ ����������� ���� �������������������GEOM���#������������ �!�$�$���%-���� �� ������������!���������������������������� ������� ���$����CATMOD���#�������������������#� ���������������������$�

���CATMOD���#���� �������������� �$�&��#� ������I�� �D������� ���������������SPREF����CATREF������������������������ �����������$�&��#� ������I���D������� ��������SPREF����CATREF �����������������A�B��������������������������� ������������ �����A�B�������� ���� ����������!����������� ���� ���#������������������������� �!����������� ����������� �!����������������#��$��

���>�������������� ����������������%-����������� ����!�� ������������ ��������%-����� ����������$������������������ ���%-����������������������#� ���������������!��������� ����� ��������������������!���������#� ��������$�-����-1��

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-61

Most DESI Element Types:

Pseudo-Attribute Type Comment

EAST OR X REAL ����9E��� ���������������

WEST REAL )����� ���������������

NORTH OR Y REAL �����9+��� ���������������

SOUTH REAL �������� ���������������

UP OR Z REAL %�9S��� ���������������

DOWN REAL -�#��� ���������������

DDESPARAM REAL(100) *���������� ��������������!����������� ��� ������

WDESPARAM WORD(100) *���������� ��������#����

WVOL REAL(6) )�� ���� � �

LVOL REAL(6) ���� ��� � �A���� ������� ���������#�B�C�)��������� ����C������)*��9R�

ORIA REAL(3) ������������������ ��

CONNCH REFERENCE /������������������� ������ �������������>�������� � ���&��!�S���!���*%0�!��%1�!�,*')!�����%1,$�

Most Design Elements – Dataset Properties:

Pseudo-Attribute Type Comment

PROPERTY WORD TEXT -���������������� ������#����

PRPU WORD TEXT C�������������������

PRTI WORD TEXT C��������������� �

PRDES WORD TEXT C����������������������

PRLS WORD(100) ���������������������������� ��

DEPLIST WORD(100) �������� ��� ������������������

CDPLIST WORD(100) �������������������������������

DEPROP TEXT ���� ���������������� ��������� �����>��

DEPDEF TEXT ���� ���������� ������������ ��A�� �����>�B�

RDEPROP REAL ���� ���������������� ��������� �

TCDPROP TEXT 0�������������������� ��A�� �����>�B�

TCDDEF TEXT 0�������������� ������������ ��A�� �����>�B�

CDPROP REAL 0�������������������� ��������� �

Appendix D: PDMS Attributes and Pseudo-Attributes

D-62 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

CFDP REFERENCE 0�����������������������

LFDP REFERENCE ���� �������������������

TFDP REFERENCE � � ���������������������

RSEQFA REF(*) &� ��#���� ��� �� ������ ��2��������

FPROP TEXT ,�� ��������� ���������������������� ��

FPRDE TEXT ,�� ��������� ������������������������ ��

FTCDP TEXT ,�� �������������������������� ��

FTCDD TEXT ,�� ���������������������������� ���� ��

FDEPR TEXT ,�� ����� ��� ���������������� ��

FDEPD TEXT ,�� ����� ��� ������������������ ���� ��

������������� ����������#����������������������� ��$�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-63

Design Elements with a Catalogue or SpecRef (e.g. p iping components):

Pseudo-Attribute Type Comment

STYPE WORD ��������������#��������+���2������

SPWD WORD WORD )������#���������0�2������

SPRB WORD REAL 1�����#���������0�2������

SPRA WORD REAL -� ��� �����#���������0�2������

SPMA WORD REAL -� ��� ��� �>���#������2������

SPOW REFERENCE �������������#�����0����������� ���

CATREFERENCE REFERENCE 0��� ���������

SPREFERENCE REFERENCE �����������������

PARAM REAL(100) ���� �������������� ������ ����

WPARAM TEXT ���� �������>�!�$�$������������

IPARAM REAL(100) ���� ������������� ��������� ������ ����

TPARAM REAL(100) ���� ��������������������� ������ ����

INTHICKNESS REAL &�� �������������

PTREFERENCE REFERENCE �������������

GMREFERENCE REFERENCE /� ������������

DTREFERENCE REFERENCE -�����������

NGMREFERENCE REFERENCE *��������������� �������

MTXREFERENCE REFERENCE '����� ��>�������

MTXX TEXT '����� �E��E��

MTYX TEXT '����� �+��E��

MTZX TEXT '����� �S��E��

DETREFERENCE REFERENCE -��� ��>�������

DTXR TEXT -��� �*��E��

DTXS TEXT -��� ����E��

DTXT TEXT -��� ����E��

ISPRE REFERENCE &�� ������������������� ���������

ICATREFERENCE REFERENCE &�� ��������� ������ ���������

IDETAIL REFERENCE &�� ��������� ��>�������

IDRT TEXT &�� ��������� �*��E��

Appendix D: PDMS Attributes and Pseudo-Attributes

D-64 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

IDST TEXT &�� ��������� ����E��

IDTT TEXT &�� ��������� ����E��

IMAT REFERENCE &�� ����� ����� ��>�������

IMXT TEXT &�� ����� ����� �E��E��

IMYT TEXT &�� ����� ����� �+��E��

IMZT TEXT &�� ����� ����� �S��E��

TSPRE REFERENCE ��������������������� ���������

TCATREFERENCE REFERENCE ����������� ������ ���������

TDETAIL REFERENCE ����������� ��>�������

TDRT TEXT ����������� �*��E��

TDST TEXT ����������� ����E��

TDTT TEXT ����������� ����E��

TMAT REFERENCE ������� ����� ��>�������

TMXT TEXT ������� ����� �E��E��

TMYT TEXT ������� ����� �+��E��

TMZT TEXT ������� ����� �S��E��

MAXBORE REAL '�>� � ���������� ��@������

PPOINT N BORE OR PPBORE N

REAL 1�������@������

PPOINT N CONNECTION OR PPCONN N

WORD 0��������������@������

PPOINT N POSITION OR PPOSITION N

POSITION ������������@������

PPOINT N DIRECTION OR PDIRECTION N

DIRECTION -�����������@������

PPOINT N GRADIENT OR PGRAD N

REAL /����������@������

PPOINT N BOP OR PBOP N

POSITION ���������������� ������������@������

PPOINT N TOP OR PTOP N

POSITION ��������������������������@������

PPOINT N OD OR POD N

REAL ���������� �������@������

PPLS INT(100) ���������� ����@������ ����

PPOINT N PSKEY OR PPSKEY N

WORD ����������@������

PPOINT N BOLT JOINT WORD 1� ��"���������@������

PPOINT N BOLT WORD 1� ������ ������@������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-65

Pseudo-Attribute Type Comment

TOTAL

P N PURP OR PPURP N

WORD ������������@������

P N DESC OR PDESC N

TEXT -��������������@������

PPCOU INTEGER �� �������@������

DPCOU INTEGER �� �����������������

PPVIF N INTEGER ������ �������@������

PPEXST N LOGICAL ��������@�����>�����

PPREF N REFERENCE *����������� �����@�����

SPRB WORD REAL �������������� ���#�������������

SPRA WORD REAL �������������� ���#�����������

SPMA WORD REAL �������������� � �>���#�����������

Note: ,�����*1!���*�!���'�����#����2�� �����������2�����!�$�$��1�*�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-66 PDMS Software Customisation Reference Manual

Piping and Hanger Components

Pseudo-Attribute Type Comment

ATLE REAL ���������� ����

TEXIST LOGICAL ��������%1&�>�����

LTLE REAL �������� ����

GRDE OR GRADIENT REAL /���������� � �������

ITPS POSITION ��������A���B����� � �������

MTCL REAL 0�� �� ������������� ����� �����A�� �������@ ���� �������������B�

MTBE REFERENCE *������������ ���������� ����� �����

MTEN REFERENCE *������������� �������� ����� �����

Note: ������������ ������� �� �������1*��� �$�

/������������������ �����A�� B������������������H��� �������$����� �>� � 9 �� � ��� ������������3�<!�−3�<$�'����� ���������������������������� ���������%1&�������������� ���������#�� ������,,�������������������,� �!���������������,,����������A>� ����������B!��$$���� ���������� � ������� ��� �������� ����� ����$�����'�0���� �� ����������� ������� ��!��������� ���������� ���� ����������������$�

,���>� � !���1��-3−�%1&−1��-5��� �������#�� ���������'�0���������� ���� ���!�2����� ��������������� ����$�����'�1��#�� ����1��-3!����'����#�� ����1��-5$�

'����������� �� ����%1&��������� � ������'�0�!�����������������>���������� � ������$��'������������ ������� ���������!������� ������'��������� ��%1&�#� ������������������� ����� �����2����$�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-67

Pseudo-Attribute Type Comment

STLE REAL ��������� ������� ������!��$$���� �1�!�*��!��� �!���$�

STAP REAL ��������� ����������������!��$$���� �1�!�*��!��� �!���$�

PARRIVE BORE OR ABOR

REAL ����������

PARRIVE CONNECTION OR ACON

WORD �����������������

PARRIVE POSITION OR APOS

POSITION ��������������

PARRIVE DIRECTION OR ADIR

DIRECTION ��������������

PARRIVE GRADIENT OR AGRD

REAL �������������

PARRIVE BOP OR ABOP

POSITION ���������������� ��������������

PARRIVE TOP OR ATOP

POSITION ����������������������������

PARRIVE OD OR AOD REAL -�� ����������������

PLEAVE BORE OR LBOR

REAL ��������

PLEAVE CONNECTION OR ACON

WORD ���������������

PLEAVE POSITION OR LPOS

POSITION ������������

PLEAVE DIRECTION OR LDIR

DIRECTION ������������

PLEAVEGRADIENT OR LGRD

REAL �����������

PLEAVE BOP OR LBOP

POSITION ���������������� ���� �������

PLEAVE TOP OR LTOP

POSITION ������������������ �������

PLEAVE OD OR LOD REAL -�� ������ �������

POCK TEXT &������������ �������������\���#��������������� ����1���������� �������������������

BRCON REF(*) 0������� �������������A��� � ���������#��� B�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-68 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

BRLEG REF(*) 0������� ��������� � ��A���������������������������#��� B�

TUBI:

Pseudo-Attribute Type Comment

ITLE REAL ��������� � �������

MTLE REAL ������������� �������� �#������ ���� ����������>�� ��������%1&�

Branch:

Pseudo-Attribute Type Comment

TULEN REAL 1��������� ����A���� ����B�

CLLENGTH REAL 1��������� �� ����A�� ������ ��� ����B�

TUCLLEN REAL 1����� ����� ����� ���!��$$�� � �������� ���� ���� �����A��,,�� ������B�

TEND WORD ������������������*�,!�$�$����*�!���-!�.��-������&��

HEND WORD �����������������.*�,�

PHEAD BORE OR PHBO

REAL .�������

PHEAD CONNECTION OR PHCO

WORD .��������������

PHEAD POSITION OR PHPO

POSITION .�����������

PHEAD DIRECTION OR PHDR

DIRECTION .�����������

PHEAD GRADIENT OR PHGR

REAL ���������������

PHEAD BOP OR PHBP POSITION ������������� �

PHEAD TOP OR PHTP POSITION ������������

PHEAD OD OR PHD REAL ������������������ ���

PTAIL BORE OR PTBO REAL ��� �����

PTAIL CONNECTION OR PTCO

WORD ��� ������������

PTAIL POSITION OR PTPO

POSITION ��� ���������

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-69

Pseudo-Attribute Type Comment

PTAIL DIRECTION OR PTDR

DIRECTION ��� ���������

PTAIL GRADIENT OR PTGR

REAL ������� ��������

PTAIL BOP OR PTBP POSITION ������� ������ �

PTAIL TOP OR PTTP POSITION ������� �����

PTAIL OD OR PTOD REAL ������� ����������� ���

HHEAD BORE OR HHBO

REAL .������������

HHEAD CONNECTION OR HHCO

WORD .�������������������

HHEAD POSITION OR HHPO

POSITION .����������������

HHEAD DIRECTION OR HHDR

DIRECTION .����������������

HHEAD GRADIENT OR HHGR

REAL .���������������

HHEAD BOP OR HHBP POSITION .������������� �

HHEAD TOP OR HHTP POSITION .������������

HHEAD OD OR HHOD REAL .������������������ ���

HTAIL BORE OR HTBO REAL .������� �����

HTAIL CONNECTION OR HTCO

WORD .������� ������������

HTAIL POSITION OR HTPO

POSITION .������� ���������

HTAIL DIRECTION OR HTDR

DIRECTION .������� ���������

HTAIL GRADIENT OR HTGR

REAL .������� ��������

HTAIL BOP OR HTBP POSITION .������� ������ �

HTAIL TOP OR HTTP POSITION .������� �����

HTAIL OD OR HTOD REAL .������� ����������� ���

BRWEIG REAL 1�����#�����

BRIWEI REAL 1�������� ����#�����

BRWWEI REAL 1�����#��#�����

BRWIWE REAL 1�������� ����#��#�����

BRCOG POSITION 1��������������������

BRICOG POSITION 1�������� �������������������

BRWCOG POSITION 1�����#�����������������

BRWICO POSITION 1�����#����� �������������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-70 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

BRIARE/A REAL 1��������� ����$�A/�����-������%�����2����B$�

BREARE/A REAL 1�����>��� ����$�A/�����-������%�����2����B$�

RANANG/LE REAL ARRAY *���������� �� ��� �$������� �������� �$�

RANRAD/II REAL ARRAY *���������� �� ������$������� �������� �$�A/�����-������%���B�

AQANG REAL �� ���#����������� ��������������������� ���$�0� �� ������ ���#����������������������� ���#���������������#���������������������������$���(1*(�,���������������������

LQANG REAL �� ���#����������� �����������>���� ���$�0� �� ������ ���#����������������������� ���#���������������#���������������������������$���(1*(�,���������������������

AQOFF REAL �����������#����������� ��������������������� ���$�*������������������$���(1*(�,�������������������$�A/�����-������%���B$�

LQOFF REAL �����������#����������� �����������>���� ���$�*������������������$���(1*(�,�������������������$�A/�����-������%���B$�

AQCON LOGICAL *�����������������������#����������� ��������������������� �������������$�&��� ����� ���#��0������%1&$�

LQCON LOGICAL *�����������������������#����������� �����������>���� �������������$�&��� ����� ���#��0������%1&$�

AQBORE LOGICAL *��������������������#����������� ��������������������� ������������ $�-��������������%1&$�

LQBORE LOGICAL *��������������������#����������� �����������>���� ������������ $�-��������������%1&$�

PQANG <INT> REAL �� ���#���������������������������� �������������"������ ���$�0� �� ������ ���#�

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-71

Pseudo-Attribute Type Comment

���������������������� ���#���������������#���������������������������$���(1*(�,���������������������������������� �������1�����$�,��������� ���!�� �����������N� ��������������� ��$��

PQOFF <INT> REAL ������������#���������������������������� �������������"������ ���$�*���������������������(1*(�,���������������������������������� �������1�����$�,��������� ���!�� �����������N� ��������������� ��$�A/�����-������%���B$�

PQCON <INT> LOGICAL �*�����������������������#����������� �������������"������ �������������$�&��� ����� ���#��0������%1&$��������������� �������1�����$�,��������� ���!�� �����������N� ��������������� ��$��

PQBORE <INT> LOGICAL *��������������������#����������� �������������"������ ������������ $�-��������������%1&$��������������� �������1�����$�,��������� ���!�� �����������N� ��������������� ��$��

Sections, Gensecs:

Pseudo-Attribute Type Comment

PSTREFERENCE REFERENCE ��������� ��@ ����������

GSTREFERENCE REFERENCE ��������� ��� ������������

ORIENTATION ORIENTATION

���������

POSITION POSITION ��������

DRPS POSITION -������������!�� �#�������"�������������

MIDPOINT POSITION '�������

LENGTH REAL �����

CUTLENGTH REAL 0��� ����

TCTLENGTH REAL ���0%�����������������������������

ANPS POSITION ������������ ���������������

ONPS POSITION �#������� ���������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-72 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

MIDP POSITION '�������

UBULG REAL %����� ����������� ��

URADI REAL %������������������� ��

AANGXZ REAL �� �������������0�����ES�� �����"����

AANGYZ REAL �� �������������0�����+S�� �����"����

YDIR DIRECTION +����������������������*�,�A���0��9/����0B�

ZDIR DIRECTION S���������A���0��9/����0B�

DRNS DIRECTION � ���� � ��������������0��9/����0�

DRNE DIRECTION � ���� � ����������0��9/����0�

ECCENTRICITY POSITION �����������

PLNAMES WORD(*) ,��� ��������� ����@ ���

PLREF WORD REFERENCE *����� ���������� �����@ ��

PLST WORD OR PPLINE WORD START

POSITION �@ ��������

PLEN WORD OR PPLINE WORD END

POSITION �@ ����

PLOR WORD OR PPLINE WORD ORI

ORIENTATION

�@� �����������

PLLE WORD OR PPLINE WORD LEVEL

REAL(2) �@ �� � �

PLCN WORD OR PPLINE WORD CLFL

LOGICAL �@ ����� ��� ���

PLTU WORD OR PPLINE WORD TUFL

LOGICAL �@ ������� ���

PLCONN WORD OR PPLINE WORD CONN

WORD �@ ���������

PLPURP WORD OR PPLINE WORD PURP

WORD �@ ���������

PLDESC WORD OR PPLINE WORD DESC

TEXT �@ ������������

Joints:

Pseudo-Attribute Type Comment

ECCJ POSITION ��������������"����

ANPJ POSITION ������������ ���������"����

ONPJ POSITION �#������� ���������"����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-73

Pseudo-Attribute Type Comment

ACTLENGTH REAL ����� �# �� ���!���� ���������=!�����!����=!������

Most Structural Elements:

Pseudo-Attribute Type Comment

OPARAM REAL(100) �#������� ����������� ������ ����

APARAM REAL(100) ������������ ����������� ������ ����

ODESPARAM REAL(100) �#������������ �������������� ����

ADESPARAM REAL(100) ����������������� �������������� ����

NWEI REAL ���#�����

GWEI REAL /�����#�����

NSRF REAL ��������������

GSRF REAL /����������������

DNST REAL -�����

NCOF POSITION ������������������

GCOF POSITION /��������������������

NVOL REAL ����� � �

GVOL REAL /������� � �

RVOL REAL *������������� � �

NMOF REAL(9) ��� � ������������

GMOF REAL(9) /����� � ������������

Panel Components:

Pseudo-Attribute Type Comment

LINKS REFERENCE � ��� ��������������������

PSIZE REAL(2) �� ���H�

PALIG REAL �� �� �� ��Z����������� �

Others in Design DB :

Pseudo-Attribute Type Comment

CEND WORD �����������������0*�,!�$�$�.��-!���&�!����*�!���-�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-74 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

NCONNE INTEGER �� ��������������������� ��

CONNER INT TEXT ��������������� �����

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-75

D.2.4. Draft Database

Pseudo-Attribute Type Comment

LHEIGHT REAL �����������

DTLHEIGHT REAL -� �����>�� ����������

PTLHEIGHT REAL ���"������>�� ����������

PRMVISIBILITY LOGICAL -���������� ����������� ����

VREGION REAL (4) 5-����������������#� � ����

VLIMITS REAL (6) :-����������������#� � ����

VVOLUME REAL (6) :-����������������#��� � �

WVOL REAL (6) )�� ���� � ����&-�����A���-��&/���� B�

DREVAY REF (50) ��������*��&���#�����������-��#���

SREVAY REF (50) ��������*��&���#���������������

UCODDISTANCE TEXT %��������Z�������������

UCODBORE TEXT %��������Z����������

PCODMETRIC TEXT ������������Z� ����������

PCODIMPERIAL TEXT ������������Z�� ���� ������

PCODFRACTIONS TEXT ������������Z���������������

PCODANGLES TEXT ������������Z��� �������

PICFILENAME TEXT �������,� �� �

EXBTEXT TEXT �>��������������1��E�

EXDMTXT TEXT �>��������������-'�E�

EXPLTXT TEXT �>�����������������E�

DRTITLE TEXT ��� ����������-��#��������������

STITLE TEXT ��� �������������������������

VTITLE TEXT ��� ������������#������������

DIMPOS REAL (3) :-��������������� ���������

PSTATUS INTEGER ��������� ���� ����������

AKEYLIST WORD (20) ����������� ����A����*-&'�B�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-76 PDMS Software Customisation Reference Manual

D.2.5. Catalogue DB

SPCO Elements:

Pseudo-Attribute Type Comment

WDANSWER WORD ��#�������#����

WDMAXAN WORD '�>� � ���#�������#����

Dataset Pseudo-Attributes:

Pseudo-Attribute Type Comment

RPROP REAL ���������� ��������� �

VALIDV TEXT �� ����� ��>�����������--�������--����

Elements Pointed to by Design Elements:

Pseudo-Attribute Type Comment

GEODEP REF(*) 0��� ������������ ���#����������������� ������ ��

DESGEO REF(*) -���� ������������� ����������� �������������� �!�$�$�#��������� ��������/'����

Note: /��-������-��/���������� ������ ��������� �����-����-1�$�

D.2.6. Spooling DB

Pseudo-Attribute Type Comment

SFREF REFERENCE *���������������������,&��-� ��

WLDREF REFERENCE *������������&)��-����*)��-� ��

JNTREF REFERENCE *������������&=�&��� ��

AWDREF REFERENCE *�������������)��-� ���

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-77

D.2.7. System DB

DB Element:

Pseudo-Attribute Type Comment

MSESS INTEGER ������������ �������-1�

PSESS INT INTEGER ��������������� ��������������

EXTMAS REFERENCE '�����-1����������>�������� � ��

EXTALS REF(*) �>��������������

EXTCLS REF(*) �>��������� ���

EXTFAM REF(*) � �-1����>�������� � ��

EXTDES REF(*) � �>��������������A��� ������� �#B�

SIZEDB SESSIONNO INTEGER -1���H������������������������A���������5��� �����B$�

ISDBFR LOGICAL &���������������\�

ISEXOP LOGICAL &��>�������������� ������\�

ISEXMP LOGICAL &��>������ �������� ������\�

ISEXAP LOGICAL ���� �>����������������� ������\�

ISEXCP LOGICAL ���� �>����������������� ������\�

ISPRIM LOGICAL &����� ������������ ������\�

ISWORK LOGICAL ���������#������>������

PRMLOC REFERENCE ��� ���� �������A���-1������0B�

MDBLS REF(*) '-1�����#�����-1�� ����

MDBCLS REF(*) '-1����#�����-1����������

LINKSN INTEGER ������������ ����������>������

NAMEDB TEXT -1�� �

TYPEDB TEXT -1����!�$�$�-��&�

FOREIGN TEXT ,������������ �

FILENAME TEXT -1��� � �

ACCESSDB TEXT -1������!�$�$�%�-����

CLAIMDB TEXT & � ���������>� ����!�������

PRIMDB TEXT -1���� ���9���������������

USESS INT TEXT %��� ���������������

DSESS INT TEXT -����������������

CSESS INT TEXT �������� ���������������

Appendix D: PDMS Attributes and Pseudo-Attributes

D-78 PDMS Software Customisation Reference Manual

Pseudo-Attribute Type Comment

STPSES INT(*) ������������������������ ��������� ��

STPDBS REF(*) ����������� ����������������-1�

Note: ����������������������������������������������� ��� ��A-��&/�!�-*�,����$B��������-1*�,���������$������� ��������� ��������������� ����$�

DBSET Element:

Pseudo-Attribute Type Comment

DBALL REF(*) -1��� ����������0� ��

DBSLIS REF(*) �����������������#�������-1����

DBSLEV REF(*) ����������������������������� � �#�������-1����

DBSHIE REF(*) ��������������������#����������

Other Attributes in System DB:

Pseudo-Attribute Type Comment

DBLS REF(*) -1��� ��������'-1�

TEAMLS REF(*) �� �����#�����%���� ����

USERLS REF(*) %����� ���������� �

ACRLIS REF(*) *����� ��������0*��#��������0*����

PASS TEXT %�������#����A� ���� �������,������B�

SECU TEXT %�����������

DBSSTP REF(*) ��������-1��������� ��

Appendix D: PDMS Attributes and Pseudo-Attributes

PDMS Software Customisation Reference Manual D-79

D.2.8. Full List of Attributes on TUBI

�%1&�>������������������ �#�����������

• ������������**&������>���� �������K�3 �

���

• ��� ���� ��������#������ �� �������K�3 $�

Note: ����� ���������������������#� ���8������������**&������>���@������� �������K�3 8�

����� �#������������������� ������� �����%1&��

• ��*�!�0��*!�/'*�!���*�!�-�*�!�&��*!���*��A�������%��������9���� ������ ��B�

• '�E*�

• ���!��*&�A������������� ��������%1&B�

• &����@����� ����

• '����@�'����� ����� ����

• �1�*�!��1�*!��1�*�@��������������

• �+���@��������%1&�

• ��'�!���'��!�,��'!�,����

• �)���@�������1*���

������� ���2�����#� ���������� ��� �������������������� �����

• *�,!���0(!�--��!�C%��!���&�!�.�&�!�)���!�/*-�!�&���!�'���!�'�0�!�'�1�!�'���!�-���!�--���!�)-���!������

���8�� ���������8��� ��A��������-��&/�B�������������� ������%1&�>����������$�

Appendix D: PDMS Attributes and Pseudo-Attributes

D-80 PDMS Software Customisation Reference Manual

Index

PDMS Software Customisation Reference Manual index-i

Index

�1�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3:��0�� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3:��-- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$33��,��*$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:3����/$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$37!�3<���- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$7��*����� ���A�-'��-�������-*�,�B $$$$$$$$$$$$$$$$$$$$$$$$$$$$ 5@3;3!�5@3;:�

������#������ $$$$$$$$$$$$$$$$$ 5@3;3!�5@3;:�������#������ �� $$$$$$$$$ 5@3;3!�5@3;:��**�+$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$37��**�+�&S� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$37��**�+)&-�.$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3;���&� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3:�����$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3:������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3:��%�����-��� �� $$$$$$$$$$$$$$$$$$$$$$$$$$5�1�-*�,$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$<�BATCH command $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$7�1�,�*�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:3�1�� ����������1�� ����������1�� ����������1�� ���������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:�0�'��$�$�$��, $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3;�0� ����������������0� ����������������0� ����������������0� ���������������� $$$$$$$$$$$$$$$$$$$$$$$$$$$:�0� ������������������>������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$73�

0����0���� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3�0��&��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3;�0*����- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$L�-�,&��-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$<�-�����- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$L�-&�0����0���� ��$$$$$$$$$$$$$$$$$$$$$$$5�-&����0�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:3��-'����� �� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:5�%����� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:5�

-&�&-�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$33�-���/�.$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3<�-'��0.$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3<�-�%1��*&�/�=�������������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:L�

�0.���� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$;��'��+ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$L��C%�� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$7��>������������������ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$5Q���� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$5�&-��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$56� ����� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:� ����� ������ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$36�

���� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :�� ���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 36����������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 53�������������� �������� $$$$$$$$$$$$$$$$$$$$$$$$ 73��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 36��� ������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 56��>�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :6����� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3�

,*�'$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 57�,������� ����� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ <�� ���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 35��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 35��>�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :6�

/� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;�/�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;�&-����>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 56�&�� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3<������� ���������>������� $$$$$$$$$$$$$$ 4������� ����������>�������$$$$$$$$$$$ 34����������������>������� $$$$$$$$$$$$$ :Q��������� ��������>������� $$$$$$$$$$ :4���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;����/�.$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3<��&����� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;������� ��������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ <���)0��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ::��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;�'��0.$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3<�'��0.)&�- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ L�'�E $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3L�'&� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3L�'�-&,&�- $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ Q�'%��&��+ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 33���/��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3L���C%��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 7��&�� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3L����$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;��%'1�*�A*���B$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3Q��� ����>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 36��� ������������ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 33��00%*$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3L���������� ����� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :�� ���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 33������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 5��>�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :6�

�* $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ;���*�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ::�

Index

Index-ii PDMS Software Customisation Reference Manual

�-'��������������>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:4�

�-'����� ���������� $$$$$$$$$$$$$$$$$$$$$$$:5���/���� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3������������ �����$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$5L�

��)�*$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3Q�C������������ �����>������� $$$$$$$$$$$$$$$$$$$$$$$$:4�

*�)��� ��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 7�*��� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3Q�*� ����������>������� $$$$$$$$$$$$$$$$$$$56�*� �>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$36�*�0����0���� ��$$$$$$$$$$$$$$$$$$$$$$$ 5�* ����� ���������* ����� ���������* ����� ���������* ����� ��������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :�*����0�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:7�*��&�)��� �� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3����-��� �� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 5��&�� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3;��C*� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$3Q����*�*�0�*-&�/��� ��$$$$$$$$$$$$ 5���*&�/ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:<��%1��*&�/ $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$:L�

�%1�*�0�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 33�

���/���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 3;��>��������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :6��>���������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :6��*&' $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :L�%�-�,&��-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$<�%������� �����>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 73�

%������>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :4�

%����$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$4�%����� �����>�������$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 75�

%�0���$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ ::�%����� ���������� $$$$$$$$$$$$$$$$$$$$$$$$$$$$ :5������� ����/�� ������������$$$$$$$$$$$$$$$$$$$$$$$$$$$ 5�

���/&0��$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$4����E�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ :Q�����%� $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 34�)*�$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$ 55�

Index

PDMS Software Customisation Reference Manual Index-iii

������������������� ���� ���� ���