Attribute Presentation Notation
- Last UpdatedDec 01, 2022
- 3 minute read
Through the Attribute Presentation format notation, attribute information can be collected from the DB element that corresponds to the shape as well as from hierarchically superior elements and referenced elements. It can also be combined with literals in an arbitrary way.
The notation uses square brackets for attribute references that should be evaluated before presentation. All characters outside the brackets are considered as literals and will be presented as-is. Referenced attributes can be referred by a dot notation (reference.attribute). References can be in several steps, in that case the reference chain will be followed to resolve the expression and find the attribute value. An arbitrary number of literals and attribute references can be combined to form advanced attribute presentation and annotation strings.
Attributes that are of a particular dimension will have units associated with their current value. Using the name of the attribute will result in presenting the value of the attribute in the current units without the actual unit label. If the units identifier is desired a ‘.withunit’ suffix can be added to the attribute. For example if the current session units for bores are inch the [scplin.bore] will produce a value of "12", while [scplin.bore.withunit] will produce "12in". Another example is [scplin.press.withunit] will produce "23psi" if the current session units are psi, while using the [scplin.press] will produce "23".
For changing current session units settings use Admin Tab > Configuration > Units. for further information refer to User Guide Design / Design Common Functionality / Current Sessions Units.
The notation can also be a result of a pml1 expression. Refer to Software customization Reference Manual, chapter PML 1 Expression. PML1 expressions should be enclosed with curly braces { }. The usage of native square bracketed attribute references within PML1 expressions is supported. In such case the square bracketed attribute references are resolved first, and then the PML1 expression is parsed.
The attribute presentation notation can be applied to the following:
-
Attribute Presentation Setup (In Diagrams Options and in Import Shape Wizard)
-
Shape Text attribute
-
Label annotation fields
Here follows a few examples using native syntax:
|
Syntax |
Description |
|
[scplin.bore] |
Will fetch the default bore attribute from the pipeline element that owns the current hierarchically subordinate element, for example a valve. |
|
[owner.owner |
Will provide the same result as above for a valve. The owner of a valve is the SCSEG element, the owner.owner is the SCBRAN element, and the owner.owner.owner is the SCPLIN element. |
|
[name]-[spref |
Will display the name of the current element, a literal (in this case a "-"), and the name of the related catalogue element. |
Following are some examples using PML1 expressions:
|
Syntax |
Description |
|
{str(abor)} |
Provides the arrival bore value. |
|
{subst(name,2)} |
This uses the substring function to provide the part of the name of the element starting at the 2nd character. |
|
ERED[\n]{str(para1)} |
Equivalent to ERED[\n][spre.catr.para(1)]*[spre.catr.para(2)] |
|
{str(para[arrive] of catr of spre)}/{str(para[leave] of catr of spre)} |
When using the spec-driven mode, labelling of a reducer with the larger diameter first. |
For further information about PML1 expression syntax, see PML 1 Expressions in the Software customization Reference Manual.
To get a particular element from an attribute of array type, use a (num) notation. Example: Owner.Diaref(1). The enumeration of elements is 1-based. The (0) string will give all elements.
Using square brackets to reference an element in an array in PML1 expressions is not supported, as it interferes with the native syntax. To reference an array element use the attribute name followed directly by a number.
For example "ppbo[2]"is not supported - instead use "ppbo2"to refer to the 2nd value in the ppbo attribute array.