Software Customisation Reference Manual.v11.4

7/23/2019 Software Customisation Reference Manual.v11.4

1/330

pdms1161/Software Customisation Reference Manual

VANTAGE Plant Design

PDMS Software Customisation ReferenceManual

Version 11.6SP1

Issue 280605


2/330

This page has intentionally been left blank


3/330

PLEASE NOTE:AVEVA Solutions has a policy of continuing product development: therefore, theinformation contained in this document may be subject to change without notice.

AVEVA SOLUTIONS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO

THIS DOCUMENT, INCLUDING BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULARPURPOSE.

While every effort has been made to verify the accuracy of this document, AVEVASolutions shall not be liable for errors contained herein or direct, indirect, special,incidental or consequential damages in connection with the furnishing, performance oruse of this material.

This manual provides documentation relating to products to which you may not haveaccess and which may not be licensed to you. For further information on which Products

are licensed to you please refer to your licence conditions.

Copyright 1991 through 2005 AVEVA Solutions LimitedAll rights reserved. No part of this document may be reproduced, stored in a retrievalsystem or transmitted, in any form or by any means, electronic, mechanical,photocopying, recording or otherwise, without prior written permission of AVEVASolutions.

The software programs described in this document are confidential information and

proprietary products of AVEVA Solutions or its licensors.For details of AVEVA's worldwide sales and support offices, see our website athttp://www.aveva.com.

AVEVA Solut ions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, UK.
http://www.aveva.com/http://www.aveva.com/http://www.aveva.com/


4/330



5/330

Revision History

revision history

PDMS Software Customisation Reference Manual - iVersion 11.6SP1

Revision History

Date Version Notes

April 2003 11.5 Definitions ofnoclaimattribute setting andprimary elementadded

June 2004 11.6 Updates for PDMS 11.6

May 2005 11.6.SP1 Added material for deprecated features and newenhancements for PDMS 11.6.SP1


6/330

Revision History

revision history


- ii PDMS Software Customisation Reference ManualVersion 11.6SP1


7/330

Contents

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

1 Introduct ion ...................................................................................1-1

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

PDMS Software Customisation Reference ManualVersion 11.6SP1

2.1 Object Classification..................................................................................2-12.2 Methods Available to All Objects...............................................................2-32.3 Forms and Menus Objects ........................................................................2-4

2.3.1 Members Contained by All Gadgets ......................................................2-42.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-72.4.2 Setting Up Gadget Anchoring: ...............................................2-82.4.3 Setting Up Gadget Docking: ...................................................2-82.4.4 Setting-Up the Gadgets Position: and .........................2-92.4.5 Setting Up the Gadgets Width and Height: ..........................2-102.4.6 Setting Up the Gadgets Tagwidth (TEXT, TOGGLE, OPTION, andRGROUP): ...........................................................................................2-112.4.7 Setting Up the Gadgets 2D Screen Position: .......................2-11

ALERT Object Forms and Menus .................................................................2-12ARC Object 3D Geometry.............................................................................2-13ARRAY Object PML Built-in Type..............................................................2-22BANNER Object PDMS ................................................................................2-26

BAR Object Forms and Menus.....................................................................2-27BLOCK Object PML Built-in Type..............................................................2-29BOOLEAN Object PML Built-in Type............................................................2-30BORE Object PDMS....................................................................................2-31BUTTON Object Forms and Menus .............................................................2-33COLLECTION Object Collection and Report.................................................2-36COLUMN Object Collection and Report........................................................2-38COLUMNFORMAT Object Collection and Report.........................................2-39DATEFORMAT Object Collection and Report...............................................2-40DATETIME Object PML Built-in Type............................................................2-41DB Object PDMS........................................................................................2-43DBREF Object PDMS ................................................................................2-45

DBSESS Object PDMS ................................................................................2-46DIRECTION Object PDMS ............................................................................2-47EXPRESSION Object Collection and Report ................................................2-49FILE Object PML Built-in Type......................................................................2-50FMSYS Object All ......................................................................................2-52FORM Object Forms and Menus .................................................................2-54FORMAT Object Formatting.........................................................................2-60FRAME Object Forms and Menus .............................................................2-62LINE Object 3D Geometry.............................................................................2-65LINEARGRID Object Construction Aids ........................................................2-72LIST Object Forms and Menus.....................................................................2-76LOCATION Object PDMS Global..................................................................2-81

MACRO Object PDMS ................................................................................2-83MDB Object PDMS........................................................................................2-84

contents - i


8/330

Contents

contents - ii PDMS Software Customisation Reference ManualVersion 11.6SP1

MENU Object Forms and Menus..................................................................2-86OBJ ECT All ..................................................................................................2-93OPTION Object Forms and Menus..............................................................2-94ORIENTATION Object PDMS........................................................................2-97PARAGRAPH Object Forms and Menus.......................................................2-98PLANE Object 3D Geometry...................................................................2-100PLANTGRID Object Construction Aids........................................................2-104POINTVECTOR Object 3D Geometry.........................................................2-105POSITION Object PDMS .............................................................................2-108POSTEVENTS Object PDMS ......................................................................2-112PROJ ECT Object PDMS .............................................................................2-113PROFILE Object 3D Geometry...................................................................2-115RADIALGRID Object Construction Aids.......................................................2-125REAL Object PML Built-in Type................................................................2-127REPORT Object Collection and Report......................................................2-129RGROUP Object (superseded) Forms and Menus......................................2-132RTOGGLE Object Forms and Menus..........................................................2-135

SELECTOR Object Forms and Menus ........................................................2-137SLIDER Object Forms and Menus............................................................2-140SESSION Object PDMS ..............................................................................2-143STRING Object PML Built-in Type............................................................2-145

TABLE Object Collection and Report..........................................................2-149TEAM Object PDMS ..................................................................................2-151TEXT Object Forms and Menus................................................................2-152TEXTPANE Object Forms and Menus.........................................................2-155TOGGLE Object Forms and Menus............................................................2-157UNDOABLE Object PDMS...........................................................................2-159 USER Object PDMS ..................................................................................2-160VIEW Objects: AREA View Forms and Menus............................................2-162

VIEW Object: PLOT View Forms and Menus ..............................................2-164VIEW Objects: VOLUME Views Forms and Menus.....................................2-166VIEW Object: ALPHA Views Forms and Menus..........................................2-169XYPosition Object 3D Geometry..................................................................2-1702.5 Deprecated Gadgets..............................................................................2-171

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

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

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

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

B.6.1. Engineering Data...................................................................................B-4

B.7. Using the Sample Application................................................................... B-5B.7.1. Progress Monitoring. .............................................................................B-6B.7.2. Engineering Data...................................................................................B-7B.7.3. Maintenance..........................................................................................B-8


9/330

Contents

PDMS Software Customisation Reference Manual - iiicontentsVersion 11.6SP1

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

B.9. The Application Files Supplied............................................................... B-14B.9.1. The ADMIN Directory.......................................................................... B-14

B.9.2. The ENGDATA Directory .................................................................... B-15B.9.3. The PROGRESS Directory................................................................. B-15B.9.4. The MAINTAIN Directory..................................................................... B-16B.9.5. The DATA Directory............................................................................ B-16

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

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

C.2. Logical Expressions .................................................................................C-3C.2.1. Logical Operators.................................................................................. C-3C.2.2. Logical Functions ..................................................................................C-6

C.2.3. Logical Array Expressions...................................................................C-10C.3. Numeric (Real) Expressions................................................................... C-10

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

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

C.5.1. Using Positions in Expressions...........................................................C-21C.5.2. WRT (PDMS Only).............................................................................. C-22C.5.3. FROM.................................................................................................. C-24

C.5.4. Comparing Positions ...........................................................................C-27C.5.5. POLAR ................................................................................................ C-28C.5.6. Direction..............................................................................................C-28C.5.7. Orientations ......................................................................................... C-29

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

C.7. Late Evaluation of Variables in expressions........................................... C-39C.8. PDMS Attributes in Expressions ............................................................C-39C.9. Querying Expressions ............................................................................ C-39C.10.Units in Expressions............................................................................... C-40C.11.Precision of Comparisons ......................................................................C-41

C.12.Undefined Values................................................................................... C-41C.13.Unset Values.......................................................................................... C-42

Appendix D. PDMS Att ributes and Pseudo-Attr ibutes................... D-1

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

D.2.1. Pseudo-Attribute Syntax......................................................................D-49D.2.2. Grouping of Pseudo-Attributes............................................................D-49D.2.3. All elements on All DBs.......................................................................D-50D.2.4. Draft Database ....................................................................................D-73D.2.5. Catalogue DB......................................................................................D-74D.2.6. Spooling DB ........................................................................................ D-74

D.2.7. System DB ..........................................................................................D-75D.2.8. Full List of Attributes on TUBI .............................................................D-77


10/330

Contents

contents - iv PDMS Software Customisation Reference ManualVersion 11.6SP1



11/330

1 Introduction

This manual is the Reference Manual for the AVEVA ProgrammingLanguage, PML.

It is intended for users who are already familiar with PML. Users who arestarting to use PML should refer to the PDMS Software CustomisationGuide, which should be used together with this manual.

There are two versions of PML, the older one, known as PML 1, and thenewer one, known as PML 2. PML 2 has been written specifically for creatingand customising the AVEVA GUI, and this manual is mainly concerned withPML 2.

However, PML 2 has not completely replaced PML 1, and there are sometasks which are carried out more efficiently using PML 1 facilities. Inparticular, this manual describes the PML 1 expressions package, which isused within PDMS; for example, for writing rules and defining reporttemplates.

If you need a full description of PML 1, for example if you are maintaining oldcode, you will need to refer to previous versions of the PDMS SoftwareCustomisation Guide. The last one to describe PML 1 fully was dated October1995.

This manual contains:

A list of PML 2 Objects, Members and Methods. For the Forms andMenus objects, the command syntax relating to the objects isincluded.

Note: Many properties of Forms and Gadgets that werepreviously set using commands should now be set usingthe Form or Gadget methods. In general, the onlycommands described are those which have not beenreplaced by methods. If you are maintaining old code, youmay need to refer to the edition of the AVEVA SoftwareCustomisation Guide dated October 1995, whichdescribes the old syntax in detail..

Information about using PML in PEGS.

Information about using PML in REVIEW.

A description of the PML 1 expressions package.

Lists of PDMS attributes and pseudo-attributes, with briefdescriptions.

PDMS Software Customisation Reference Manual 1-1Version 11.6SP1


12/330

Introduction


1-2 PDMS Software Customisation Reference ManualVersion 11.6SP1


13/330

2 A Summary of Objects, Members andMethods

2.1 Object Classification

The table below lists the object types and shows which classifications theybelong to.

Classifi cation 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

DBREFDBSESS

DIRECTION

MACRO

MDB

ORIENTATION

POSITION

POSTUNDO

PROJECT

SESSION

PDMS Objects

TEAM



14/330

A Summary of Objects, Members and Methods

Classifi cation Object Type

UNDOABLE

USER

ALERT

ALPHA

BAR

BUTTON

FMSYS

FORM

FRAME

LIST

MENU

OPTION

PARAGRAPH

RGROUP

SELECTOR

TEXT

TEXTPANE

TOGGLE

VIEW ALPHA

AREA

PLOTVOLUME

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



15/330


2.2 Methods Available to All Objects

The table following lists the methods available to all objects. The table givesthe name of each method and the type of result you get back from it.

The third column of the table describes what the method does.

Name Result Purpose

Attr ibute( 'Name' ) ANY To set or get a member of anobject, providing the membername as a STRING.

Attr ibutes() ARRAY OFSTRINGS

To get a list of the names ofthe members of an object as

an array ofSTRING.Delete() NO RESULT Destroy the object - make it

undefined

EQ(any) BOOLEAN Type-dependent comparison

LT(any) BOOLEAN Type-dependent comparison(converting first to STRING ifall else fails)

Max(any) ANY Return maximum of objectand second object

Min(any) ANY Return minimum of object and

second objectNEQ(any) BOOLEAN TRUE if objects do not have the

same value(s)

ObjectType() STRING Return the type of the objectas a string

Set() BOOLEAN TRUE if the object has beengiven a value(s)

String() STRING Convert the object to a STRING

Unset() BOOLEAN TRUE if the object does nothave a value

Table 2-2: Methods Available to Al l Objects



16/330


2.3 Forms and Menus Objects

2.3.1 Members Contained by All Gadgets

All gadgets contain the following members.

Name Type Purpose

visible BOOLEAN

Get/Set

You query this member todetermine if a gadget isvisible or invisible.

To make a gadget visible, setit to TRUE; to make the gadgetinvisible, set it to FALSE.

active BOOLEAN

Get/Set

You query this member todetermine if a gadget is activeor inactive (greyed-out).

To make a gadget active, set itto TRUE; to make the gadgetinactive, set it to FALSE.

callback STRING

Get/Set

Query or assign the gadgetscallback string

tag STRING

Get/Set

Query or assign a gadgets tagtext. This is not displayed for

all gadgets.Table 2-3: Members Contained by All Gadgets



17/330


2.3.2 Summary of Gadget-Specif ic Methods

The table below summarises the methods that different gadgets support.

Bar

Button

List

Option

Para

Rgroup

Slider

Text

Text-pane

Toggle

/Rtoggle

View2

D

ViewA

lpha

View3

D

Add X X X X

AddPixmap X X X

Background X X X X X

Clear X X X X XClearSelection X

CurPos X

Highlight X X

InsertAfter X

InsertBefore X

FieldProperty X

FullName X X X X X X X X X X X X X

GetPickedPopup X X X X X X X X X X X

Line XName X X X X X X X X X X X X X

Owner X X X X X X X X X X X X X

Refresh X X X X X X X X X X X X X

RemovePopup X X X X X X X X X X X

RestoreView X X

SaveView X X

Select X X X

Selection X X X

SetActive XSetCurPos X

SetEditable X X

SetFieldProperty X

SetFocus X X X X X X X X X X

SetLine X

SetPopup X X X X X X X X X X X

SetSize X X X

SetTooltip X X X X X X X

SetValue X



18/330


Bar

Button

List

Option

Para

Rgroup

Slider

Text

Text-pane

Toggle

/Rtoggle

View2

D

ViewA

lpha

View3

D

Shown X X X X X X X X X X X X X

Type X X X X X X X X X X X X X

ValidateCall X

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



19/330


2.4 Gadget Syntax Graphs

2.4.1 Rules for Presenting and Using Syntax graphs

The rules for syntax graphs are as follows:

i. Each graph represents a command (or part of a command) to PDMSto perform specified actions with specified data. The graph isentered at graph_name>-- or >--, and exited at -->. The allowedflow in a graph is top to bottom, and left to right, except whereindicated otherwise by a * or


20/330


2.4.2 Setting Up Gadget Anchoring:

TheANCHOR attribute allows you to control the position of an edge of thegadget relative to the corresponding edge of its container.

For exampleANCHOR RIGHT specifies that the right hand edge of the gadget willmaintain a fixed distance from the right hand edge of its owning container.

. - - - - - - - - - - - - - - - - +- - ANCHOR - - +- - +- Lef t - - - - . || +- Ri ght - - | || +- Top - - - - - | || - Bot t om -+- - - +- - - *| |+- - - - None - - - - | - - - - Al l - - - - - - - - >

Syntax Graph 2-1: Gadget Anchor ing

2.4.3 Setting Up Gadget Docking:

The DOCK attribute allows you to dock a gadget to the left, right, top, orbottom edge of its container, typically a form or a frame; or you can cause thegadget to dock to all edges, or to no edges.

>- - - - - - - - - - - - - +- - DOCK - - - - +- - - - - Lef t - - - - .+- - - - Ri ght - - |+- - - - Top - - - - - |+- - - - Bott om - |

+- - - - None - - - | - - - - Fi l l - - - - - >

Syntax Graph 2-2 Gadget Docki ng

Note: The DOCK andANCHOR attributes are mutually exclusive.

Setting the DOCK attribute resets theANCHOR to the default;setting theANCHOR attribute resets DOCK to none.

You can set these attributes only when you define the gadget:you cannot change it after the exit from form setup. Thus youare not allowed to the resize behaviour at run-time.



21/330


2.4.4 Setting-Up the Gadgets Position: and

You can use theAT syntax, shown below on the graph, to define theposition of a gadgets origin within a form.

You can specify the position absolutely (in form layout grid units) or relativeto the extremities of existing gadgets, or relative to the size of the form andthe gadget.

>- - - - AT - - +- val val - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .+- X val - - - - - - - - - - - - . |+- XMI N - . | |+- XCEN - | | |+- XMAX - +- - | | - - - - - - - - - - - - - - - - - - - +- Y val - - - - - - - - - - - - |

+- YMI N - . |

+- YCEN - | |+- YMAX - - |` - - - - - - - - - - - - - - - - - - - - - - >

Syntax Graph 2-3 Absolute Positioning

The subgraph , shown below, sets the gadget position relative toanother gadget or the forms extent. For example, you can use it to position agadget halfway across the width of a form.

>- - - - +- - .+- - FORM - - - | - - - - - - - - - - - +- * val - - - - - .

| |+- + val - - . |

+- - val - - - +- + val * SI ZE - - - .| +- - val * SI ZE - - - || +- + SI ZE - - - - - - - - - || +- - SI ZE - - - - - - - - - || ` - - - - - - - - - - - - - - - - - - |+- + SI ZE - - - - - - - - - - - - - - - - - - - - - - - |+- - SI ZE - - - - - - - - - - - - - - - - - - - - - - - |` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - >

Syntax Graph 2-4: Relative Position ing



22/330


Examples of Using the AT Syntax

AT 5 7.5 Puts gadget origin at form grid coordinates(5, 7.5).

AT X 5.5 Puts gadget origin at form grid coordinates(5.5, y) where y is calculated automaticallyfrom the y extremity of the last placedgadget and the current VDISTANCE setting.

AT YMAX+1 Positions new gadget at (x, y) where x iscalculated automatically from the xextremity of the last placed gadget and thecurrent HDISTANCE setting. y is at YMAX+1 ofthe last gadget.

AT XMIN.GAD1-2 YMAX.GAD2+1 Positions new gadget with respect to twoexisting gadgets. Gadget is offset by 2 gridunits to the left ofGAD1(X=XMIN-2)and 1 unitbelow .GAD2 (Y=YMAX+1).

AT XMAX FORM-SIZE YMAX FORM-SIZE XMAXFORMrefers to the current right handsize of the form at its current stage ofdefinition (not its final maximum extent).YMAX FORMrefers to the forms currentbottom extent. The -SIZEoption subtracts thesize of the gadget being positioned in theform. This example positions the gadget atthe extreme right-hand bottom edge of theform.

2.4.5 Setting Up the Gadgets Width and Height :

This operation allows you to set a gadgets width and height.

>- - - - +- - +- - - - - - - - - .| +- ASPect ( h/ w) - - || - - - - - - - - - - - - - - - - - - - >| - - - +- - - - - - - - - .

+- ASPect ( h/ w) - - | - - - - - - - - - - - - - - - - - - - >

Syntax Graph 2-5: Gadget Geometry

Note: h/w is the value of the Aspect Ratio (height/width).

The units for will have been preset to pixels or F&Mgrid units, appropriately.

The default width and height for will have been preset,so leaving the graph with only width or height set still realisesboth values.

All values may be given as integer or reals.



23/330


Setting the Height:

>- - - - WI Dt h - +- val - - - - - - .+- - - | - - - - - - - - - - - - - - >

Setting the Width:

>- - - - HEI ght - +- val - - - - - - .+- - - | - - - - - - - - - - - - - - >

2.4.6 Sett ing Up the Gadgets Tagwidth (TEXT, TOGGLE,OPTION, and RGROUP):

The TAGWIDTHspecifies the size of the gadgets tag field in grid width units

including any padding space, regardless of the actual tag string. Tagwidth isnot needed for gadgets with an explicit area specification (width and height,lines or length). FRAME, LIST, SELECTOR, TEXTPANE and PARAGRAPH can alwaysforce an explicit width.

The syntax graph defines the Tag specification

>- - - - +- TAGWI Dt h val - +- - - - - - - - - - - - - . - - - - - - - - - - - - - - - - - - t agt ext - - - >

Syntax Graph 2-6: Gadget Tagwidth

Note The graph supports both the simple tagtext settingand/or the specification of the maximum width of any tag.

If the tag width is not explicitly given then it is assumed to be thenumber of characters in the tagtext string multiplied by thehorizontal grid size (the notional character width for the font).

You can specify the tag width without specifying any tagtext atdefinition time; this can be added at run time.

2.4.7 Setting Up the Gadgets 2D Screen Position:

This shows how to set up a gadgets 2D screen position in normalized co-ordinates.

- - +- XR val - +- YR val - . - YR val - +- XR val - - >

Syntax Graph 2-7 Gadget's 2d Screen Posit ion

Note: Normalized co-ordinates represent a proportion of the full screensize.

0.0


24/330


ALERT Object Forms and Menus

Methods

Name Result Purpose

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

STRINGYES OR NO

Show a blocking CONFIRMALERT and retrieve theresponse. X and Y are optionalscreen positions.

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

STRINGYES

Show a blocking ERRORALERTand retrieve the response. Xand Y are optional screenpositions.

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

STRINGYES

Show a blocking MESSAGEALERT and retrieve the

response and retrieve theresponse. X and Y are optionalscreen positions.

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

STRINGYES, NO ORCANCEL

Show a blocking QUESTIONALERT and retrieve theresponse. X and Y are optionalscreen positions.

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

STRINGYES

Show a blocking WARNINGALERT and retrieve theresponse and retrieve theresponse. X and Y are optional

screen positions.!!Alert.Input( ! prompt i s STRING,!default is STRING) is STRING

STRING Show a blocking INPUTALERT.!prompt is the promptdisplayed to the user, and!default is the default value inthe text box.

!!Alert.Input( !prompt is STRING,!default i s STRING, xPos is REAL, yPosis REAL) is STRING

STRING Show a blocking INPUTALERT.!prompt is the promptdisplayed to the user, and!default is the default value inthe text box. xPos and yPos arethe coordinates of the top left-

hand corner of the alert box.

Table 2-5: Alert Object Methods



25/330


ARC Object 3D Geometry

Basic ARC Definit ion: Members

Name Type Purpose

Orientation ORIENTATION

Get/Set

Orientation of the arc.

Position POSITION

Get/Set

Origin/Centre of the arc.

Radius REAL

Get/Set

Radius of the arc

StartAngle REAL

Get/Set

Angle from X axes to start ofthe arc.

EndAngle REAL

Get/Set

Angle from X axes to end ofthe arc.

Sense BOOLEAN

Get/Set

Arc sense:

0 for clockwise

1 for anti-clockwise

Table 2-6: Basic ARC Defini tion Members

Basic ARC Definit ion: Methods

These methods do not modify the original object.

Name Result Purpose

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

ARC Creates an arc with the givenPosition, Orientation, StartAngle, End Angle, Radius. Ifthe last argument is TRUE, thearc is clockwise.

String() STRING Returns the arc as a string

Table 2-7: Basic ARC Defini tion Methods



26/330


ARC Methods that Return ARCs

None of these methods modifies the original object.

Name Result Purpose

StartPosition(POSITION) ARC Returns a new arc, based onthe original, where the startangle, if defined as the anglefrom the centre of the arcthrough the passed positionmapped onto the arc plane,forms the X axis.

EndPosition(POSITION) ARC As StartPosition , but for theEndAngle.

Through(POSITION) ARC Returns a new arc, where the

radius (of the full circle)passes through the passedposition when mapped ontothe arc plane.

ChordHeight(REAL) ARC Returns a new arc, based onthe original, where theEndAngle is in such a positionto produce the passed chordheight.

Chord height >Radius or Chordheight < 0 returnunset objects.

New arc should notproduce subtendedangle > 180.

Chord(REAL) ARC Returns a new arc,maintaining the originalStartAngle, so the EndAngle is atthe specified distance from theStart

Chord length >Radius * 2 or < 0

return an unsetobject.

Circle() ARC Returns a full circle definitionof the arc.

Circle(BOOLEAN) ARC Returns a full circle definitionof the arc. If True, the arc isanti-clock-wise

Complement() ARC Returns the complementaryarc of the arc definition (theremainder of the circle)

Table 2-8: ARC Methods that Return ARCs



27/330


StartPosition(POSITION)

EndPosition(POSITION)

Through(POSITION)

Complement()

Cord(REAL)

CordHeight(REAL)

Figure 2-A: ARCs Returned by ARC Methods

ARC Method that Returns POSITIONs

This method does not modify the original object.

Name Result Purpose

AnglePosi tion(REAL) POSITION Returns the position at thespecified angle on the arc.

Table 2-9: ARC Methods that Return POSITIONs

AnglePosition(REAL)

Figure 2-B: POSITIONs Returned by ARC Methods



28/330


ARC Methods that Return DIRECTIONs


Name Result Purpose

AngleDirec tion(REAL) DIRECTION Returns the direction from thecentre of the arc through apoint at the given angle fromthe X axis

StartTangent() DIRECTION Returns the direction out ofthe arc, tangential to the startangle line. The sense of thearc is used.

EndTangent() DIRECTION Returns the direction out ofthe arc, tangential to the end

angle line. The sense of thearc is used.

AngleTangent(REAL) DIRECTION Returns the direction,tangential to the angle passed.

Table 2-10: ARC Methods that Return DIRECTIONs

AngleDirection(REAL)

StartTangent()

EndTangent()

AngleTangent(REAL)

Figure 2-C: DIRECTIONs Returned by ARC Methods



29/330


ARC Methods that Return XYOffsets

This method does not modify the original object.

Name Result Purpose

XYOffset(POSITION) XYPOSITION Returns the position, mappedonto the arc plane, in term of anXY offset from the arc planeorigin

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 Returns the position, in termsof an angle from the X axis, atthe proportion from the startangle of the arc:Angle = (EndAngle -StartAngle) * +StartAngle

Angle() REAL Returns the subtended angle

of the arcNear(POSITION) REAL Returns the position, in terms

of an angle from the X axis, tothe position on the arc planeof the passed position

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



30/330


Proportion(REAL)

Near POSITION

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

Name Result Purpose

Chord() REAL Returns the chord lengthbetween the start and end ofthe arc definition

Length() REAL Returns the true length of thearc line

ChordHeight() REAL Returns the chord height ofthe arc line

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

Chord()

Length()

ChordHeight()

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



31/330


ARC Intersection Methods that Return REAL ARRAYs


Name Result Purpose

Intersections(LINE) REAL ARRAY Returns the intersectionpoints, in terms of angles fromthe X axis, of the passed line(mapped onto arc plane) withthe circle defined by the arc

Intersections(PLANE) REAL ARRAY Returns the intersectionpoints, in terms of angles fromthe X axis, of the passed planewith the circle defined by thearc

Intersections(ARC) REAL ARRAY Returns the intersectionpoints, in terms of angles fromthe X axis, of the circleimplied by the passed arc withthe circle defined by the arc

The Arcs must be in thesame plane, i.e. the anglebetween Z components ofthe direction must be 0 or180

Table 2-14: ARC Intersection Methods that Return REAL ARRAYs

Intersections LINE Intersections(PLANE)

Intersections(ARC)

Figure 2-G: REAL ARRAYs Returned by ARC Intersection Methods



32/330


ARC Tangent Methods Returning Real Arrays


Name Result Purpose

Tangents(POSITION) REAL ARRAY Returns the points oftangency on the arc circlefrom the passed position, interms of angles from the Xaxis,

Tangents(ARC) REAL ARRAY Returns the points oftangency on the arc circle forthe passed arc circle, in termsof angles from the X axis

Split() REAL ARRAY Splits the arc into a non-zero

number of segments

Pole() POSITION Returns the pole position ofthe arc

Table 2-15: ARC Tangent Methods that Return REAL ARRAYs

Tangents(POSITION)

Tangents(ARC)

Figure 2-H: REAL ARRAYs Returned from ARC Tangent Methods



33/330


ARC Methods that Return BOOLEANs

None of these methods modify the original object.

Name Result Purpose

On(POSITION) BOOLEAN Returns true if the passedposition lies on the arc line

OnProjected(POSITION) BOOLEAN Returns true if the passedposition, when projected ontothe arc line, lies within it

OnExended(POSITION) BOOLEAN Returns true if the passedposition, when mapped ontothe arc line, lies outside it

Table 2-16: ARC Methods that Return B OOLEANs

On(POSITION)9

On(POSITION)8



34/330


ARRAY Object PML Built-in Type

Methods

Name Result Purpose

Append(ANY value) NO RESULT Append value as a new elementat the end of array.

AppendArray(ARRAY values) NO RESULT Append array values as newelements at the end of array.

Clear() NO RESULT Remove all elements.

Compress() NO RESULT Removed all undefinedelements and re-indexremaining elements.

DeleteFrom( REAL index, REAL n) ARRAY Make undefined n elements

starting at index. Remainingelements are not re-indexed

Returns an array of thedeleted elements (which neednot be assigned if not wanted).

DeleteFrom( REAL index) ARRAY Make undefined elementsfrom index to end of array.

Returns an array of thedeleted elements.

Remaining elements not re-indexed.

DeleteTo(REAL index, REAL n) ARRAY Make undefined n elements upto index Returns an array ofthe deleted elementsRemaining elements not re-indexed.

DeleteTo(REAL index) ARRAY Make undefined elementsfrom start to index Returns anarray of the deleted elementsRemaining elements not re-indexed.

Difference(ARRAY two) ARRAY Return an array of thoseelements in the original arraynot present in array two.Duplicates will appear onlyonce

Empty() BOOLEAN TRUE if array is empty

Evaluate(BLOCK command) NEW ARRAY Evaluate code in command ateach element.

Find(ANY value) NEW ARRAY Search original array for valueand return an array of indexpositions at which it wasfound.



35/330


Name Result Purpose

FindFirst(ANY value) REAL Return index of firstoccurrence ofvalue. ReturnsUNSET if not found.

First() ANY Return value of first definedelement

From(REAL index, REAL n) ARRAY Copy sub array ofn elementsstarting at index.

From(REAL index) ARRAY Copy sub array starting atindex to end of array.

GetIndexed(REAL index) ANY ImplementsARRAY[index] (thisis an internal method).

Indices() NEW ARRAY Returns an array containingthe indices of the target arraythat have a value.

Insert(REAL index, ANY value) NO RESULT Insert value as a new elementat index.

Later elements are re-indexed

InsertArray(REAL index, ARRAY ANYvalues)

NO RESULT Insert values as new elementswith the first at index.

Later elements are re-indexed

Intersect(ARRAY two) NEW ARRAY Return array of elementspresent in both arrays.Duplicates will appear onlyonce.

Invert() NEW ARRAY Returns an inverted copy ofthe array.

Last() ANY Return last element value.

MaxIndex() REAL Subscript of last defined (non-empty) element.

MinIndex() REAL Subscript of first defined (non-empty) element.

Overlay(REAL index, ARRAY two) NEW ARRAY Replace array elements atindex with elements from thearray two. Returns an array ofthe elements which were

overwritten (which need notbe assigned if not required).

ReIndex(REAL ARRAY indices) NO RESULT Apply result ofSORTEDINDICESto re-order array elementsinto positions specified byindices.

Remove(REAL nth ) ANY Remove and Return nthelement (which need not beassigned if not required).

Remaining elements are re-indexed.



36/330


Name Result Purpose

RemoveFirst() ANY Remove and Return firstelement (which need not beassigned if not required).


RemoveFrom(REAL index, REAL n ) NEW ARRAY Remove and Return new arrayofn elements starting withindex (which need not beassigned if not required).


RemoveFrom(REAL index) NEW ARRAY Remove and Return new arrayof elements from index to endof array (which need not beassigned if not required).


RemoveLast() ANY Remove and Return lastelement (which need not beassigned if not required).


RemoveTo(REAL index, REAL n) NEW ARRAY Remove and Return nelements from start to index(which need not be assigned ifnot required).


RemoveTo(REAL index) NEW ARRAY Remove and return elementsfrom start to index (which neednot be assigned if notrequired).


Size() REAL Returns the number of definedelements.

Sort() NO RESULT Sort array into ascending

order.SortUnique() NEW ARRAY Returns a sorted copy of the

array with duplicatesremoved.

SortedIndices() NEW REALARRAY

Return new array of indicesrepresenting the sorted orderof elements in array.

The array itself is not sorted.

To(REAL index, REAL n) ARRAY Copy sub array ofn elementsfrom start to index.

To(REAL index) ARRAY Copy sub array from start of

array to index.



37/330


Name Result Purpose

Union(ARRAY two) NEW ARRAY Return array of elementspresent in either array(duplicates will appear onlyonce).

Unique() NO RESULT Discard duplicates and re-index remaining elements.

Width() REAL Return the maximum width ofstring elements (otherelement types are ignored).

Table 2-17: ARRAY Object Methods



38/330


BANNER Object PDMS

Members

Name Type Purpose

Company STRING Company name, up to 120characters.

Copyright STRING AVEVA copyright, up to 80characters.

Libraries ARRAY OFSTRINGS

Library names

Name STRING Title for main windows, up to13 characters

Short STRING Short form of company name

Status STRING PDMS release status

Table 2-18: BANNER Object Members

Command

!BANNVAR = BANNER! $ Returns a BANNER object



39/330


BAR Object Forms and Menus

Methods

Name Result Purpose

Add(STRING dText, STRING enu) NO RESULT Appends a barmenu field,which can show the specifiedmenu as a pulldown menu.

The name of the pulldownmenu is given in menu; theDTEXTof the field is given bydText.

Clear() NO RESULT Removes all barmenu fields.Using this method isdeprecated.Clear(STRING dText) NO RESULT Removes all barmenu fields

after and including the onewith DTEXTdText.Using this method isdeprecated.

FieldProperty(STRING field, STRINGproperty)

BOOLEAN Get the value of the propertynamed in property for the menufield named in field.

The allowed values for theproperty are ACTIVE orVISIBLE.

FullName() STRING Get the full name of thegadget, e.g.'!!Form.bar'.

InsertAfter(STRING field, STRING dText,STRING menu)

NO RESULT Inserts a new barmenu fieldimmediately after the oneidentified by field.

The name of the menu isgiven in menu; the DTEXTof thenew field is given by dText.

InsertBefore(STRING field, STRINGdText, STRING menu)

NO RESULT Inserts a new barmenu fieldimmediately before the oneidentified by field.

The name of the menu isgiven in menu; the DTEXTof themenu is given by dText.

Name() STRING Get the gadget's name, i.e.'bar'

Owner() FORM Get the owning form.

SetActive( STRING dText, BOOLEANstate)

NO RESULT Deactivate/Activate the menufield whose DTEXT is dText.Using this method isdeprecated.



40/330


Name Result Purpose

SetFieldProperty(STRING menu,STRING property, BOOLEAN state)

NO RESULT Set the value of the propertynamed in property with thevalue ofstate, for the menunamed in menu.

The allowed values for theproperty are ACTIVE orVISIBLE.

Shown() BOOLEAN Get shown status.

Type() STRING Get the GADGET type as aSTRING.

Table 2-19: BAR Object Methods

Command

The BAR command creates a bar menu within a form definition.

The recommended way to create menu fields on the bar is to use the bar'sAdd() method.

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

Note the use of the two special menu names Help, which adds a system helpmenu that calls the online help; and Window, which adds a system Windowmenu that lists all the displayed windows.



41/330


BLOCK Object PML Built-in Type

This object holds expressions that are evaluated later.

Methods

Name Result Purpose

Block( STRING expression) BLOCK Creates a block expression.

Evaluate() ANY Evaluate block expression onobject: check result is ofTYPEtype.

Evaluate() ANY Evaluate the expression andreturn the result

Evaluate(STRING type) ANY Evaluate expression and

return an error if the result isnot ofTYPEtype. Otherwisereturns the result.

Table 2-20: BLOCK Object Methods



42/330


BOOLEAN Object PML Bui lt-in Type

Methods


Name Result Purpose

BOOLEAN(REAL value) BOOLEAN Constructor that creates aboolean Object set to a non-zero value if boolean is TRUE; 0if boolean is FALSE

BOOLEAN(STRING value) BOOLEAN Constructor that creates aboolean Object set to:

'TRUE if boolean is T, TR, TRU,TRUE, Y, YEYES;

FALSE if boolean is F, FA, FAL,FALS, FALSE, N, NO.

BOOLEAN( STRING value, FORMATformat)

BOOLEAN As above. FORMATargumentrequired for consistency byForms and Menus.

AND() BOOLEAN TRUE if both values are TRUE

NOT() BOOLEAN TRUE ifFALSE; FALSE ifTRUE

OR(BOOLEAN value) BOOLEAN TRUE if either value is TRUE

Real() REAL 1 if boolean is TRUE; 0 ifboolean is FALSE

String() STRING TRUE if boolean is TRUE.FALSE if boolean is FALSE.

Table 2-21: BOOLEAN Object Methods



43/330


BORE Object PDMS

Member

Name Type Purpose

Size REAL

Get/Set

The BORE size

Table 2-22: BORE Object Members

Methods


Name Result Purpose

BORE(REAL value) BOOLEAN Constructor that creates aBOREobject with the givenvalue.

BORE(STRING valu e) BOOLEAN Constructor that creates aBOREobject with the givenvalue.

BORE(STRING value, FORMAT format) BOOLEAN Constructor that creates aBOREobject with the givenvalue, and in the formatspecified by format.

EQ(REAL value) BOOLEAN Comparison with theargument value dependent oncurrent BOREunits.

GEQ(BORE bore) BOOLEAN TRUE if this object is greaterthan or equal to the argumentbore.

GEQ(REAL value) BOOLEAN Comparison with theargument value dependent oncurrent BOREunits.

GT(BORE bore) BOOLEAN TRUE ifBOREgreater thanBORE

GT(REAL value) BOOLEAN Comparison with theargument value dependent oncurrent BOREunits

LEQ(BORE bore) BOOLEAN TRUE if this object is less thanor equal to the argument bore.

LEQ(REAL value) BOOLEAN Comparison with theargument value dependent oncurrent BOREunits

LT(BORE bore) BOOLEAN TRUE if this object is less thanbore.

LT(REAL value) BOOLEAN Comparison with theargument value dependent oncurrent BOREunits



44/330


Name Result Purpose

Real() REAL Convert BORE to a REAL value

String(FORMAT fo rmat) STRING Convert BORE to a STRINGusing the settings in the

global format object.Table 2-23: BORE Object Methods



45/330


BUTTON Object Forms and Menus

Members

Name Type Purpose

Background REAL

Set/Get

Set or get Background ColourNumber

Background STRING

Set Only

Set Background Colour Name

Val BOOLEAN TRUE when the button ispressedFALSE when it is not

Table 2-24: BUTTON Object Members

Methods

Name Result Purpose

AddPixmap(STRING fil e1, STRING fi le2,STRING fil e3 )

AddPixmap(STRING fi le1, STRING file2)

AddPixmap(STRING fi le )

NO RESULT Adds pixmaps to be used forthe unselected, selected andinactive states. The last twoare optional.

FullName() STRING Get the full gadget name,e.g.'!!Form.gadget'.

Name() STRING Get the gadget's name, e.g.'gadget'.

Owner() FORM Get owning form.

SetPopup(MENU menu) NO RESULT Links the given menu withthe gadget as a popup.

RemovePopup(MENU menu) NO RESULT Removes the given popupmenu from the gadget.

GetPickedPopup() MENU Returns the name of the menupicked from a popup.

Shown() BOOLEAN Get shown status.

SetFocus() NO RESULT Move keyboard focus to thisgadget.

Refresh() NO RESULT Refresh display of gadget.

Background() STRING Get Background ColourName.

Some gadgets do not supportthis property in allcircumstances, e.g. gadgetswhich are showing a pixmap.Gadgets whose colour has notbeen set explicitly, may nothave a colour with a known

colourname. In this case anerror is raised..



46/330


Name Result Purpose

SetToolTip(STRING) NO RESULT Sets the text of the Tooltip.

Type() STRING Get the gadget-type as aSTRING.

Table 2-25: BUTTON Object Methods



47/330


Command

The BUTTON command defines a button, and specifies its position, tag orpixmap, callback text and control attribute.

You can define the BUTTON to be either PML-controlled, or core-code controlledusing the gadget qualifier attribute control type, with values PML orCORE.

The files defining any pixmaps should be specified in the form's defaultconstructor method using the gadget's AddPixmap() method.

. - - - - - - - - - - - BUTTON gname - +- - t agt ext - - - - - - - - - - - - - |+- - PI XMAP - - - - - - |+- - - - - - - - - - - - - - - |+- - - - - - - - - - - - - - |+- - - - - - - - - - - - - - |

+- - CALLback t ext - - - - - - |+- - TOOLTI P t ext - - - - - - - - |+- - BACKGr ound - - |+- - TOGGLE - - - - - - - - - - - - - - |+- - CORE - - - - - - - - - - - - - - - - * Core managed gadget| . - - - - - -

Syntax Graph 2-8: Creating a BUTTON Object

Note: It is bad practice to place one gadget on top of another. This maylead to gadgets being obscured

Defaults: If no tag is specified, the tag defaults to the gadgets gname.

The control attribute is unset unless you specifically enter OK,APPLY,HELP, CANCEL or RESET. The default values for anchoring and docking

are DOCK = none, andANCHOR= Left + Top.



48/330


COLLECTION Object Collection and Report

The collection object is used to extract database elements from the systemusing a selection filter (an expression object), restrictive search elements andscope lists.

Methods

Name Result Purpose

Collection() Constructor (initialises all theobject settings).

Scope (COLLECTION) Empties the current scope listand makes the passedCOLLECTIONthe current scope.

Scope (DBREF) Empties the current scope listand makes the passed DBREFthe current scope.

AddScope Adds the passed DBREF to thecurrent scope list.

Scope (DBREF ARRAY) Replaces the current scope listwith the passed list ofDBREFs.

AppendScope (DBREF ARRAY) Appends the passed list ofDBREFs to the scope list.

ClearScope() Empties the current scope list.

Filter (EXPRESSION) Sets the filter to be applied to

the collection.ClearFilter () Empties the filter to be

applied to the collection.

Type (STRING) Empties the current scopetype list and adds the passedelement type.

AddType(STRING) Adds the passed element typeto the scope type list.

ClearTypes() Empties the types to beapplied to the collection.

Types (ARRAY elements) Replaces the scope elementtype list with the passed list,elements.

AppendTypes (ARRAY types) Appends the passed list, types,to the scope type list.

Initialise() Initialises an evaluate list, soall query actions re-evaluatethe collection rules. Sets indexposition to 1.

Filter() EXPRESSION Returns the expression usedto filter database elements.

Scope() DBREF ARRAY Returns the list of databaseelements to scan.



49/330


Name Result Purpose

Types() STRINGARRAY

Returns the list of databaseelement types to be collected.

Results() DBREF ARRAY Returns the whole collection.

Next(REAL n) DBREF ARRAY Returns sub array fromcollection ofn elementsstarting at current indexposition.

Index() REAL Returns the current index ofthe count being used by Next().

Size () REAL Returns the number ofelements in the collection.

Table 2-26: COLLECTION Object Methods



50/330


COLUMN Object Collection and Report

The column object defines the way in which a column of a table object ispopulated.

The formatting of a column should be separate from the column definitionitself and be held within the report object used to extract data from a tableobject. This will allow the same table to have many different reports producedfrom it, without the need to regenerate the table.

Methods

Name Result Purpose

Column() Constructor (initialises all theobject settings)

Column(EXPRESSION, BOOLEAN,BOOLEAN, STRING)

Constructor settingExpression, Sort, Ascending,Key

Key (STRING) Sets key and forces it to beuppercase

Expression (EXPRESSION) Defines the expression used topopulate the column

Sort() Switches on column sort

NoSort() Switches off column sort, thisis the default setting

Ascending() Sets column sort to ascendingorder

Descending() Sets column sort todescending order

Key() STRING Returns the key word for usewhen reporting

Expression() EXPRESSION Returns the expression usedto derive the content of thecolumn

IsSorted() BOOLEAN Returns TRUE if the columnis sorted

SortType() STRING Returns the column sortsetting, ascending, descendingor off

Table 2-27: COLUMN Object Methods



51/330


COLUMNFORMAT Object Collection and Report

The column object defines the way in which a column of a table object ispopulated.

The formatting of a column should be separate from the column definitionitself and be held within the report object used to extract data from a tableobject. This will allow the same table to have many different reports producedfrom it, without the need to regenerate the table.

Methods

Name Result Purpose

ColumnFormat() Constructor (initialises all theobject settings)

Format(FORMAT) Sets the format of the columnto the passed format

Format(DATEFORMAT) Sets the format of the columnto the passed date format

FORMAT('STRING') Unsets the format of thecolumn, i.e. the column

Width (REAL) Sets the column width

Widest() Sets the maximum columnwidth flag, setting a specificwidth value automatically setsthe flag to FALSE. Note that

this is the least efficientmethod for Width because acomplete scan has to be doneto determine the widest.

Indent(REAL, REAL) Sets left and right indents (i.e.spaces) in the column

Format() FORMAT Returns the format fornumeric values in a column

Width() REAL Returns the column width,strings greater than thecolumn width are wrapped on

to the next line, numericvalues greater than thecolumn width are output as acolumn of hashes.

GetWidest() BOOLEAN Returns TRUE if widest is set

Justification() STRING Returns the columnjustification

LeftIndent() REAL Returns the left indent setting

RightIndent() REAL Returns the right indentsetting

Table 2-28: COLUMNFORMAT Object Methods



52/330


DATEFORMAT Object Collection and Report

The DATEFORMAT object is used to allow date attributes to be sorted in dateorder.

Examples:

!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 = ob ject DATEFORMAT (D M)

!format.year(4)

!format.month(FULL) $ 5 November 2001

Methods

Name Result Purpose

DateFormat(STRING format) Constructor. Defines a format.

The input string, format, is inthe form 'T*D*M*Y', where T =time, D = day, M= month, Y =

year, and the order of theletters indicate the formatrequired.

T and D are optional. H couldbe used if only hours arerequired.

* is the separator character.

DateFormat() Sets default format (T M D Y,month = INTEGER, year = 2)

Month(STRING) Sets month format. 'INTEGER','BRIEF' or 'FULL'

Year(INT) Sets year format. 2 or 4 for

number of digits

String(DATETIME) STRING Input a date in DATETIMEformat and convert to thespecified format.

String(STRING) STRING Input a date in PDMS formatand convert to the specifiedformat.

Table 2-29: DATEFORMAT Object Methods



53/330


DATETIME Object PML Bui lt-in Type

Methods

Name Result Purpose

DateTime() DATETIME Create a DATETIME object withcurrent date and time in it.

DateTime(REAL year, REAL month,REAL date)

DATETIME Create a DATETIME set to thegiven year, month, date. Timedefaults to 00:00:00.

DateTime(REAL year,STRING month.REAL date)

DATETIME As above, but month is aSTRING at least threecharacters long representingmonth e.g. Jan, March,DECEM

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

DATETIME Create a DATETIME object set togiven year, month, date, hour,minute. Seconds default to 0.

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


DateTime(REAL year, REAL month,REAL date, REAL hour, REAL minu te,REAL second)

DATETIME Create a DATETIME object set togiven year, month, date, hour,minute, second.

DateTime(REAL year, STRING month,REAL date, REAL hour, REAL minu te,REAL second)


Date() REAL Return day of month for thisDATETIME object (1-31).

GEQ(DATETIME) BOOLEAN Test whether this DATETIME islater than or the same asargument DATETIME.

GT(DATETIME) BOOLEAN Test whether this date is later

than argument DATETIME.

HOUR() REAL Return hour as REAL for thisDATETIME object (0-23).

LEQ(DATETIME) BOOLEAN Test whether this DATETIME isearlier or the same asargument DATETIME

LT(DATETIME) BOOLEAN Test whether this DATETIME isearlier than argumentDATETIME.

Minute() REAL Return minutes as REAL forthis DATETIMEobject (0-59).



54/330


Name Result Purpose

Month() REAL Return month as REAL for thisDATETIME object (1-12).

MonthString() STRING Return month as STRING for

this DATETIMEobject(January,February, etc.)

Second() REAL Return number of seconds asREAL for this DATETIMEobject(0-59).

Year() REAL Return year as REAL(e.g. 1998)

Table 2-30: DATETIME Object Methods



55/330


DB Object PDMS

Members

Name Type Purpose

Name STRING The name of the database, upto 32 characters.

Description STRING The database description, upto 120 characters.

Access STRING Access type (UPDATE,MULTIWRITE, CONTROLLED).

Claim STRING Claim mode for multi-writedatabases (EXPLICIT, IMPLICIT).

File STRING Database filename, up to 17

characters.Foreign STRING FOREIGNor LOCAL

Number STRING Database number

Team TEAM Owning Team

Type STRING Database type, e.g. DESI

Refno STRING String containing Databasereference number

Primary STRING Identifies whether a databaseis PRIMARYor SECONDARYatthe current location in a global

project

Table 2-31: DB Object Members

Methods

Name Result Purpose

MDBList() ARRAY List ofMDBS which containthis DB.

Size() REAL File size in pages.

Sessions() ARRAY OFDBSESS

All sessions of the currentdatabase.

Lastsession() DBSESS Last session information fordatabase.

DB(DBREF) DB Returns a DB object, given aDBREF.

DB(STRING) DB Returns a DB object, given aname or reference number.

Table 2-32: DB Object Methods

These methods may be used in the following ways (in all cases !!CE is assumedto be a DB DATABASE element and !!CE.Name is a STRING object containing theelements name).



56/330


Examples:

!D = OBJECT DB(!!CE)

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

!D = !!CE.DB()

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

These methods should assist performance improvements to appware bymaking it easier to get from Database element to Object.

Command

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



57/330


DBREF Object PDMS

Methods

Name Result Purpose

Dbref( STRING ) DBREF Creates a DBREF object withvalue set to the givenSTRING.

Dbref( STRING, FORMAT ) DBREF As above. FORMAT argumentrequired for consistency byForms and Menus.

ANY Return the value of thenamed Attribute

Attr ibute(STRING Name)

Attr ibutes() ADBREF appears to have theattributes of whatever DBelements it is pointing to

ARRAY OFSTRING

BadRef() TRUE ifDBREF is not valid(cannot navigate to it)

BOOLEAN

Delete() NO RESULTT Deletes the PML DBREF (notthe database element it ispointing to)

REAL Count of number ofmembers of elementreferenced

MCount()

REAL Count of number ofmembers of elementreferenced of type specified

MCount(STRING type)

String(FORMAT) Convert to STRING usingsettings in global FORMATobject

STRING

LINE Returns the cut/uncut plineof a SCTN/GENSECelement as a bounded line

Line([CUT/UNCUT])

POSITION Returns the position of thespecified Ppoint of adatabase element.

PPosition(REAL)

DIRECTION Returns the direction of thespecified Ppoint of adatabase element.

PDirection(REAL)

Table 2-33: DB Object Methods



58/330


DBSESS Object PDMS

Members

Name Result Purpose

Number REAL Session number.

Date STRING Date when session started.

Author STRING Creator of session.

Comment STRING Session comment.

Table 2-34: DBSESS Object Members



59/330


DIRECTION Object PDMS

Members

Name Type Purpose

East REAL

Get/Set

UP component

North REAL

Get/Set

NORTHcomponent

Up REAL

Get/Set

UP component

Origin DBREF

Get/Set

DB element that is the origin

Table 2-35: DIRECTION Object Members

Methods


Name Result Purpose

Direction( STRING ) DIRECTION Creates a DIRECTIONwith thevalue given by STRING.

Direct ion ( STRING, FORMAT ) DIRECTION Creates a DIRECTIONwith the

value given by STRING, in theformat specified.

EQ(DIRECTION) BOOLEAN TRUE if two directions are thesame

LT(DIRECTION) BOOLEAN TRUE if direction is less thanargument

String(FORMAT) STRING Convert to STRING

WRT(DBREF) DIRECTION Convert to a new DIRECTIONwith respect to a givenelement.

Angle(DIRECTION) REAL Returns the angle between thetwo directions

Bisect(DIRECTION) DIRECTION Returns the direction which ishalf way between the twodirections

Cross(DIRECTION) DIRECTION Returns the cross product ofthe two directions

Dot(DIRECTION) REAL Returns the dot product of thetwo directions

IsParallel(DIRECTION) BOOLEAN Returns true if the supplieddirections are parallel, false

otherwise.Opposite() DIRECTION Returns the opposite direction



60/330


Name Result Purpose

Orthogonal(DIRECTION) DIRECTION Returns the directionorthogonal between the twodirections

Projected(PLANE) DIRECTION Returns a direction projectedonto the passed plane.

Table 2-36: DIRECTION Object Methods



61/330


EXPRESSION Object Collection and Report

This object is used to define a basic expression that can be applied against adatabase element or another object and return any data typed result,BOOLEAN, STRING, etc.

EXPRESSIONobjects may be used by COLLECTIONobjects to filter the results of thecollection.

Methods

Name Result Purpose

Expression Constructor (initialises all theobjects settings).

Expression (STRING) Constructs and defines the

expression. ('ATTRIBUTE----')should be used for attributesfor speed and efficiency.Other examples are ('PURP eqIPIPINGI') or ('XLEN +STRING(XLEN)').

Attr ibuteExpression (STRING) Makes the passed attribute anexpression.AttributeExpression('LENGTH')is the same asExpression('ATTRIBUTELENGTH').

String() STRING Returns the currentexpression as a string.

Evaluate(DBREF) ANY Evaluates the currentexpression against the passedobject

Table 2-37: EXPRESSION Object Methods



62/330


FILE Object PML Bui lt-in Type

Methods

Name Result Purpose

File(STRING) FILE Create a FILE object on a filewhose name is given inSTRING.

AccessMode() STRING Return access mode for thefile {CLOSED, READ, WRITE,OVERWRITE, APPEND}.

Close() NO RESULT Close file if open.

Copy(STRING) FILE Copies the file whosepathname is given in STRING.

Returns FILE object for copiedfile.

Copy(FILE) FILE Copies the file represented bythe FILE object. Returns FILEobject for copied file.

DeleteFile() NO RESULT Delete the file represented bythe file object if it exists.

Directory() FILE Returns a FILE objectcorresponding to owningdirectory.

DTM() DATETIME Returns a DATETIMEobject

holding the date and time thatthis file was last modified.

Entry() STRING Returns file name as string.

Exists() BOOLEAN Returns BOOLEAN indicatingwhether file exists or not.

Files() ARRAY OFFILES

Returns anARRAY ofFILEobjects corresponding to filesowned by this directory.

FullName() STRING Returns the name includingpath for this FILE object as aSTRING.

IsOpen() BOOLEAN Return BOOLEAN indicatingwhether file is open or not.

LineNumber() REAL Return line number of lineabout to be written.

Move(STRING) FILE Move this file to location givenin STRING. Return FILE objectfor moved file.

Move(FILE) FILE Move this file to locationrepresented by FILE object.

Name() STRING Return name of this FILE

object as STRING.



63/330


Name Result Purpose

Open(STRING) NO RESULT Opens this file in the modegiven by STRING{READ,WRITE,OVERWRITE,APPEND}

Owner() STRING Returns the IDof this FILESowner a STRING.

Path() ARRAY OFFILES

Returns anARRAY ofFILEscorresponding to the owningdirectories of this FILE object.

PathName() STRING Returns owning path as aSTRING.

ReadFile() ARRAY OFSTRING

Open, read contents and closefile. Data returned as anARRAY ofSTRINGscorresponding to the lines inthe file.

ReadFile(REAL) ARRAY OFSTRING

As above, but ensures that fileis no longer than number oflines given in REAL.

ReadRecord() STRING Reads a line from an open fileand returns it in a STRING.Returns an UNSETSTRING ifend of file is detected.

Set() BOOLEAN Returns a BOOLEAN indicatingwhether this FILE object hasa name set or not.

Size() REAL Returns size of file in bytes.

SubDirs() ARRAY OFFILE

Returns anARRAY ofFILEobjects corresponding todirectories owned by thisdirectory.

Type() STRING Returns a STRING indicatingwhether this object representsa FILE or a DIRECTORY.

WriteFile(STRING, ARRAY OF STRING) NO RESULT Opens file in mode given instring {WRITE, OVERWRITE,APPEND}, writes STRINGs inARRAY and closes file.

WriteRecord(STRING) NO RESULT Writes STRING to this FILEwhich must already be open.

Table 2-38: FILE Object Methods



64/330


FMSYS Object All

Methods


Name Result Purpose

SetMain(FORM) FORM Sets the main form for anApplication.

Main() FORM Query the current main form

Refresh() NO RESULT Refresh all VIEWgadgets

Checkrefs BOOLEAN By default, all references in aForm definition are checkedwhen a form is displayed.

Checking can be switched off,which may be recommended ifperformance problems areexperienced.

SetInterrupt(GADGET) NO RESULT Sets the Gadget which willinterrupt macro or functionprocessing.

Splashscreen(BOOLEAN) NO RESULT Removes the display of asplash screen after anabnormal exit.

Interrupt() BOOLEAN Set to TRUE if the interruptgadget has been selected.

FMINFO() ARRAY OFSTRINGS

Returns array of all FMINFOstrings.

DocsAtMaxScreen(BOOLEAN) NO RESULT Sets default placementposition for document forms tobe towards the maximum(rightmost) of the screen.Useful for wide screen ad twinscreen devices.

CurrentDocument() FORM This method returns thecurrent Document of theapplication framework as aFORMobject. If there is nocurrent document then thereturned form has value Unset.



65/330


Name Result Purpose

LoadForm(STRING formname) FORM Allows force loading of a formdefinition and/or the ability toget a reference to a form objectby name.

If the form exists then areference to the form object isreturned. If it doesnt exist,then an attempt is made toforce load its definition. If thisfails then an unset formreference is returned

Table 2-39: FMSYS Object Methods



66/330


FORM Object Forms and Menus

Members

Name Type Purpose

FormRevision STRING

Get/Set

Form Revision text.

FormTitle STRING

Get/Set

Form title.

IconTitle STRING

Get/Set

Icon title.

Initcall STRING

Get/Set

Callback executed when formis initialised.

Autocal l STRING

Get/Set

Callback executed when anyof the specified applicationattributes have changed.

Okcall STRING

Get/Set

Callback executed when OKbutton is pressed.

Cancelcall STRING

Get/Set

Callback executed whenCANCEL button is pressed.

KeyboardFocus GADGET

Get/Set

Gadget to have initialkeyboard focus on display ofthe form. One ofTEXTFIELD,TEXTPANE, BUTTON, TOGGLEor

ALPHAVIEW

.

Quitcall STRING

Get/Set

Callback executed wheneverthe user presses theQuit/Close icon (X) on the titlebar of forms and the mainapplication window.

For forms of type MAIN, theQUITCALL callback is executed,if present. This permits theuser to terminate theapplication, and so theassociated PML callback

should prompt the user forconfirmation.

For all other form types, theQUITCALL callback is executed,if present, and then the formand its children are hiddenunless the PML callbackreturns an error. When theform nest is hidden theCANCELCALL callback for eachform of the nest is executed(in reverse display order).



67/330


Name Type Purpose

Maximised BOOLEAN

Get/Set

Get/set forms maximisedstatus (on screen).

Active BOOLEAN

Get Only

Gives form's active/inactive

status.Popup MENU

Get/Set

Get/set forms current popupmenu.

Table 2-40: FORM Object Members

Methods

Name Result Purpose

Name() STRING Get name.

FullName() STRING Get the full form name(Including !!).

NewMenu(STRING menuname) MENU Adds a new named menu tothe form.

NewMenu(STRING menuname, STRINGtype)

MENU Adds a new named and typedmenu to the form. The firstargument is the name of thenew menu; the secondargument is the type of themenu, and must be eitherPOPUP or MAIN.

SetActive(BOOLEAN) NO RESULT SetActive(FALSE) greys-out allgadgets on the form, butdoesnt set their Active status,so that SetActive(TRUE) restoresthe form to the precise state itwas in before greying out, i.e.any inactive gadgets will stillbe inactive.

SetGadgetsActive(BOOLEAN) NO RESULT SetGadgetsActive(FALSE) greysout all gadgets on the formand sets their Active status toinactive, i.e. their previous

active state is lost. SimilarlySetGadgetsActive(TRUE) greys-inall gadgets and sets theirActive status to active.

SetPopup(MENU) NO RESULT Specifies the pop-up to bedisplayed when the right-handmouse button is released overthe form background.

RemovePopup(MENU) NO RESULT Removes a pop-up associatedwith a form.

GetPickedPopup() MENU Returns the last picked popup

menu for the form.



68/330


Name Result Purpose

Show('FREE') NO RESULT Show the form on the screenas a FREE form.

Show('AT', REAL X, REAL Y) NO RESULT Show the form as a FREE form

with the origin at the X,Yrelative screen position.

Show('CEN', REAL X, REAL Y) NO RESULT Show the form as a FREE formwith its centre at the X,Yrelative screen position.

Shown() BOOLEAN Get 'shown' status

Hide() NO RESULT Hides the form (removes itfrom the screen)

Owner() FORM Returns the form's parentform, or unset variable if theform is free-standing

Table 2-41: FORM Object Methods

Note: SetActive() and SetGadgetsActive() can be used in combination witheach other and with the Active property of individual gadgets

Commands

SETUP FORM

A form definition is introduced by the SETUP FORMcommand and terminatedby a corresponding EXIT command. Once in Form Setup mode you can call anycommands for defining the forms properties, creating a menu bar (see BARobject), main and popup m

Documents

Software Customisation Reference Manual.v11.4