Rule Group for SCEQUI example
- Last UpdatedNov 28, 2024
- 5 minute read
The following examples illustrate some Rules under a particular Rule Group defined for schematic equipment.
The Source Type here restricts this Rule Group to be applied only where the source type is SCEQUI.
Within this Rule Group there is one Create Action, this defines the type of object to be created during a Build operation, in this case EQUI. The Variant Count is 1, which means that the Compare operation will always check for an EQUI.
There are several Assign Actions. This one assigns a value to the attribute POS on the target object, taking that value from the POS attribute of the source object. The Build Action is set and the Compare Action is ignore. These options and their alternatives are described in more detail below.
The Assign Action has several properties:
|
Name |
Name attribute is optional |
|
Variants Count |
Previously described above. |
|
Attribute Name |
The name of the attribute to be set on the target. |
|
Attribute Value |
An expression to generate the value for the target attribute, and can contain references to source. For build rules it should not contain references to target as this will be undefined at build time. |
Assignee is the object that has the attribute whose value is being set or compared. Allowable entries are:
|
target |
The target object in 3D, this is the usual setting |
|
owner |
The owing ZONE in 3D, described below in the example for NAME |
|
root |
The owning SITE in 3D, described below in the example for NAME |
Build Action is the action carried out during a Build operation, allowable entries are:
|
Set |
Sets the value of the attribute |
|
Ignore |
Does not set the value of the attribute |
Compare Action is the action carried out during a Compare operation, allowable entries are:
|
match |
The value of the attribute must match the value generated by the rule |
|
matchorexceed |
The value of the attribute must be equal to or greater than the value generated by the rule |
|
matchornotexceed |
The value of the attribute must be equal to or less than the value generated by the rule |
|
matchaskeyattribute |
The value of the attribute will be used to find matching elements in 3D; where key attributes are defined in the rules for a particular type, all their values on a particular object must match the values generated by the rules, in order for the 3D object to be identified as a match for the source schematic object |
|
ignore |
The value of the attribute will not be compared |
Mismatch Severity determines how a mismatch is reported during a Compare operation. Allowable entries are:
|
critical error |
The mismatch will be reported as a critical error, indicated by a red blob icon in the compare report |
|
error |
The mismatch will be reported as an error, indicated by a red dot icon in the compare report |
|
warning |
The mismatch will be reported as a warning, indicated by a yellow triangle icon in the compare report |
|
information |
The mismatch will be reported as information, indicated by a blue "i" icon in the compare report |
Mismatch Report is an optional text that will be output as a line in the compare report following the line on which the mismatch itself is reported.
Another Assign Action sets the attribute NAME to be the same in 3D as on the diagram.
Note:
Name rules based on target are not well supported in Integrator as target is undefined until it is actually created. In some cases it defaults to the source
object for data if the target object is not available at that point. Consider an owner
rule for building a ZONE when source is SCPLIN and target is the PIPE. It would seem
reasonable to set the value of the ZONE name based on the SITE name plus a prefix,
for example: ”format(‘{0}-{1}’, owner of owner of target, LNTP of source)”. But the
ZONE is created before the target exists and so this rule will not give the desired
result.
In the same block there are two further Assign Actions for NAME. The first of these has Assignee set to owner and contains an expression to define the name of the ZONE.
The second has Assignee set to root and contains an expression to define the name of the SITE.
Note:
As Assign Name rule for SCPLIN can use the Integrator Limit Point text, so that pipes
can be built either side and be named accordingly. This is the pseudo attribute ILPBUA.
Although ILPBUA is not available directly on SCPLIN or SCBRAN, it can be used in the
Assign Name rule for SCPLIN (for pipe, zone and site names) and for SCBRAN (for branch
names). Integrator will derive the text according to the portion of the SCPLIN selected
to be built as a pipe.