Using the Methods of an Object

PML Customisation User Guide

Variables, Objects, Functions and Methods : Using the Methods of an Object

Note:

A method is a function that is specific to an object.

The Software Customisation Reference Manual contains a table of the object types supplied as part of PML 2. For each object type, there is a list of the associated methods and members.

For each object type, the table shows:

Name

The name of the method or member. For example, a REAL object has a method named Cosine.

If there are any arguments, they are indicated in the brackets () after the name.

For example, the REAL object has a method named BETWEEN which takes two REAL arguments.

Result or Type

For members, you use the heading Type; for methods, you use the heading Result.

The type of the member or the result describes what kind of object you are expecting to see as a member or result of the method.

For example, the result of the method Cosine is a REAL value.

Some methods do not return a value: these are shown as NO RESULT.

Status

Used to give other information about the method or member.

For methods, this column tells you whether the method modifies the state of the object.

For members, this column tells you whether the member is Mutable (by you) or Read Only.

Note:

For the system-defined AVEVA E3D™ object types, members correspond to AVEVA E3D™ attributes

Purpose

Informs you what the member or method does.