Naming and numbering functions

Function / Aliases

Returns

Description

Example

DISCOVERNUMBERSBYCLASS

String[]

Scans text for any matches to numbering templates associated to a list of classes

$[attr.value].expandNaming.discoverNumbersByClass('TAG'.lookupClass($[#nomenclature]), true, false)

DISCOVERNUMBERSBYTEMPLATE

String[]

Scans text for any matches to a list of numbering templates

$[attr.value].discoverNumbersByTemplate('NNT_2D_MV', true)

GETCLASSNUMBERINGTEMPLATES / GETCLASSNAMINGTEMPLATES

String[]

Returns list of numbering templates assigned to a class (factoring in inheritance)

'Centrifugal Pump'.GetNumberingTemplates

GETNUMBERINGELEMENT / GETNAMINGELEMENT / LOOKUPNAMINGELEMENT / LOOKUPNUMBERINGELEMENT

String

Returns the specified numbering element

'ELEMENT_01'.GetNumberingElementName

GETNUMBERINGELEMENTANNOTATION / EXTENSION / GETNAMINGELEMENTANNOTATION / EXTENSION

String

Returns an annotation from the specified numbering element

'ELEMENT_01'.GetNumberingElementExtension(':source')

GETNUMBERINGELEMENTDESCRIPTION / GETNAMINGELEMENTDESCRIPTION

String

Returns the description of the specified numbering element

'ELEMENT_01'.GetNumberingElementDescription

GETNUMBERINGELEMENTNAME / GETNAMINGELEMENTNAME

String

Returns the name of the specified numbering element

'ELEMENT_01'.GetNumberingElementName

GETNUMBERINGELEMENTS / GETNAMINGELEMENTS

String[]

Returns a list of numbering elements (bits that make up a template)

GetNamingElements

GETNUMBERINGTEMPLATE / GETNAMINGTEMPLATE / LOOKUPNAMINGTEMPLATE / LOOKUPNUMBERINGTEMPLATE

String

Returns the specified numbering template

'TEMPLATE_01'.GetNumberingTemplateName

GETNUMBERINGTEMPLATEANNOTATION / EXTENSION / GETNAMINGTEMPLATEANNOTATION / EXTENSION

String

Returns an annotation from the specified numbering template

'TEMPLATE_01'.GetNumberingTemplateExtension(':applicableFor')

GETNUMBERINGTEMPLATEDESCRIPTION / GETNAMINGTEMPLATE DESCRIPTION

String

Returns the description of the specified numbering template

'TEMPLATE_01'.GetNumberingTemplateDescription

GETNUMBERINGTEMPLATEELEMENT / GETNAMINGTEMPLATEELEMENT

String

Returns the specified element within a numbering template

'TEMPLATE_01'.GetNumberingTemplateElement('ELEMENT_01')

GETNUMBERINGTEMPLATEELEMENTS / GETNAMINGTEMPLATEELEMENTS

String[]

Returns ordered list of elements for a numbering template

'TEMPLATE_01'.GetNumberingTemplateElements

GETNUMBERINGTEMPLATEELEMENT ANNOTATION / EXTENSION / GETNAMINGTEMPLATEELEMENT ANNOTATION / EXTENSION

String

Returns annotation/extension from a template element

$[this.id].slice('::',1).getNamingTemplateElementExtension($[this.id].slice('::',-1), ':suffix')

GETNUMBERINGTEMPLATENAME / GETNAMINGTEMPLATENAME

String

Returns the name of the specified numbering template

'TEMPLATE_01'.GetNumberingTemplateName

GETNUMBERINGTEMPLATES / GETNAMINGTEMPLATES

String[]

Returns a list of numbering templates

getNamingTemplates

GETNUMBERTEMPLATEREGEX / GETNAMINGTEMPLATEREGEX

String

Returns a regex to scan for the given number template

'NNT_2D_MV'.getNamingTemplateRegex

GETREADABLENUMBERPATTERN / GETREADABLENAMINGPATTERN

String

Returns a human-readable pattern for the given number template

'NNT_2D_MV'.getReadableNamingPattern

MATCHNUMBERINGTEMPLATE / MATCHNAMINGTEMPLATE

String

True if some text matches a naming template

$[this.id].matchNumberingTemplate(false)

MATCHNUMBERINGTEMPLATEBYCLASS / MATCHNAMINGTEMPLATEBYCLASS

String

True if some text matches any naming template associated to the class

$[this.id].matchNumberingTemplateByClass('TAG'.lookupClass($[#nomenclature]))

RESOLVENUMBER / RESOLVENUMBERBYTEMPLATE / RESOLVENAMINGBYTEMPLATE

String

Resolves text to a naming template, or returns blank if not matched

@[TagNumber].resolveNumberByTemplate('NNT_2D_MV', true, true)

RESOLVENUMBERBYCLASS / RESOLVENAMINGBYCLASS

String

Resolves text to the first matching naming template, or blank

@[Tag].resolveNumberByClass('TAG'.lookupClass($[#nomenclature]), true, true)

TRYRESOLVENUMBERBYCLASS / TRYRESOLVENAMINGBYCLASS

String

Resolves to the first matching template, or the original text if not matched

@[Equipment].slice(' ',1).replace(/\s/,'').resolveNamingByClass(

'ENGINEERING TAG'.lookupClass($[#nomenclature]), true, true)

TRYRESOLVENUMBERBYTEMPLATE / TRYRESOLVENAMINGBYTEMPLATE

String

Resolves to a naming template, or returns original text if not matched

@[TagNumber].tryResolveNumberByTemplate('NNT_2D_MV', true, true)