Class functions

CLOSESTCLASSMATCHINGEXTENSION

String

Returns closest class matching the specified extension

CLOSESTCLASSNOTMATCHINGEXTENSION

String

Returns closest class not matching the specified extension

GETCLASS

String

Looks up a class by ID

'pump'.GetClass

GETCLASSANNOTATION / GETCLASSEXTENSION

String

Returns an annotation from a class after factoring in inheritance

'pump'.GetClassAnnotation('HideInOps')

GETCLASSATTRIBUTE / GETPERMISSIBLEATTRIBUTE

ArtefactAttribute (String)

Returns a requested class attribute after factoring in inheritance, or null if not assigned

'pump'.GetClassAttribute('design pressure max')

GETCLASSATTRIBUTEANNOTATION / GETCLASSATTRIBUTEEXTENSION

String[]

Returns the annotations on a class attribute, factoring in inheritance

'pump'.GetClassAttributeAnnotation('height', '*:interesting')

GETCLASSATTRIBUTEANNOTATIONS / GETCLASSATTRIBUTEEXTENSIONS

—

Returns all annotations/extensions on a class attribute (v2.8)

$[this.class].getClassAttributeAnnotation(

$[attr.name],

'anet:consolidation/defaultToTag'

GETCLASSATTRIBUTES

String[]

Returns IDs of all attributes assigned to a class, factoring in inheritance

'PSV'.GetClassAttributes

GETCLASSATTRIBUTES MATCHINGANNOTATION / MATCHINGEXTENSION

String[]

Returns class attributes matching annotation/extension

GETCLASSATTRIBUTES WITHANNOTATION / WITHEXTENSION

String[]

Returns class attributes that have the annotation/extension (v2.8)

GETCLASSATTRIBUTESWITH EXTENSION / ANNOTATION

String[]

Returns all class attributes with the specified extension

$[this.class].getClassAttributesWithExtension('anet|aveva:consolidation/ValueExpression')

GETCLASSBYANNOTATION

String

Finds the first class matching an annotation, or null if not found

'pump'.GetClass('*:alias')

GETCLASSBYASPECT

String

Returns class by aspect (v2.9)

'Enumerations.CMMSCodes'.getEnumByAspect

GETCLASSCHILDCOUNT

Int

Returns the child count of a class (v2.8)

'pump'.getChildClassesCount

GETCLASSCHILDREN / GETCHILDCLASSES

String[]

Returns child classes (v2.8)

$[this.class].getChildClasses

GETCLASSDESCRIPTION

String

Returns the description of a class

'vessel'.GetClassDescription => 'big cylinder'

GETCLASSES

String[]

Returns all registered classes

GetClasses

GETCLASSESINHIERARCHY

String[]

Returns all class IDs within the specified hierarchy

'functional'.GetClasses

GETCLASSNAME

String

Returns the human readable name of a class

'pump'.GetClassName => 'thing that pumps'

GETCLASSPATH

String

Returns the path to a class

'centrifugal pump'.GetClassPath => 'TAGGED ITEM/EQUIPMENT/PUMP/CENTRIFUGAL PUMP'

GETMATCHINGCLASSATTRIBUTEANNOTATIONURIS / EXTENSIONURIS

String[]

Returns matching class attribute annotation/extension URIs (v2.8)

(Not explicitly provided)

GETPARENTCLASS

String

Gets the parent of a class

'pump'.getParentClass => 'equipment'

ISCLASSTYPEOF / ISCLASSORSUBCLASS / INHERITSCLASS

Bool

Indicates if a class is a match or subclass of another

'Pump'.InheritsClass('Tagged Item')

ISINHIERARCHY / ISCLASSCONCEPT

Bool

Indicates if a class is found within a particular hierarchy/concept

'Tagged Item'.IsInHierarchy('Functional')

ISLEAFCLASS

Boolean

Indicates if a class is a leaf (no children) (v2.8)

'pump'.isLeafClass

REMOVELESSSPECIFICCLASSES / GETSPECIFICCLASSES

String[]

Removes less specific classes, returning the most specific (v2.8)