Special Router Attributes
- Last UpdatedOct 27, 2023
- 3 minute read
There are a number of special attributes used by Pipe Router. These are described below.
RLOC
Attribute of branch members. Determines whether element is to be deleted or repositioned by Router.
|
RLOC = -1 |
Unset |
|---|---|
|
RLOC = 0 |
Non-deletable and positionable. |
|
RLOC = 1 |
Locked |
|
RLOC = 2 |
Deletable |
HREL
Attribute of branch members. Logical. Determines if component should be placed as near to Head as possible (TRUE) or as close to Tail as possible (FALSE). If a component is tail-relative it will force all components between it and the next locked component or constraint towards the Tail. The default is TRUE.
BRLO
Attribute of branch set and used by Pipe Router. Users should not normally set BRLO. If you are routing a branch which has already been positioned, it is better to unset BRLO and then set LHEAD and LTAIL as appropriate. Indicates whether the head and /or tail of branch is fixed or free. If the head / tail is connected to a nozzle or a piping component the value of BRLO is ignored.
If the HREF is unset then the head must be positioned (LHEAD true) and the head of the branch is fixed. Thus the head lock is only relevant when the head is connected to the tail of another branch. If the head is fixed the tail of the connected branch will be positioned where the head of this branch is, but if the head is not fixed the head of this branch will be positioned at the tail of the connected branch.
If TREF is unset the tail can be positioned and the tail of the branch fixed; or the tail can be free -when Router will calculate a position for it. When the tail is connected to the head of another branch it will be positioned where the head of that branch is unless the tail is fixed.
Note:
Pipe Router does not consider the possibility of branches connected head-to-head or
tail-to-tail).
|
BRLO = 0 |
unset; Router will use LHEAD / LTAIL to calculate BRLO if necessary |
|
BRLO = 4 |
free head and free tail |
|
BRLO = 5 |
fixed head and free tail |
|
BRLO = 6 |
free head and fixed tail |
|
BRLO = 7 |
fixed head and fixed tail |
If BRLO is not set before calling Router, then HREF, LHEAD, TREF and LTAIL attributes are used to set to a suitable value.
BRSTATUS
The setting of the BRSTATUS (Branch Status) attribute shows the routed status of the Branch. These values can be used in Autocolour rules so that Branches can be displayed in different colours according to whether they have been routed successfully or not. The values are as follows:
|
0 |
Not Routed |
|
1 |
Routed successfully |
|
2 |
All routes clash - Using default |
|
3 |
Clash using route |
|
4 |
Route breaks rule |
|
5 |
Routed ignoring invalid constraint list |
|
6 |
Cannot find required component - Datacon will fail |
|
7 |
System error - Unable to route branch |
|
8 |
Serious data error - Unable to route branch |
|
9 |
Error whilst routing branch |
|
10 |
Route violates minimum tube length |
PLPP
Attribute of RPLA. Shows where on a plane to place branches.
|
PLPP = ABOV |
place above the plane |
|
PLPP = BELO |
place below the plane |
|
PLPP = CENT |
place at the centre of the plane |
The default is CENT.
PURP - (RPLA)
For pipe racks, indicates which are entry/exit planes.
PURP = PREX - Entry/exit plane
If not set to PREX, then it is assumed to be a travel plane.
PURP - (GRUL)
The PURP attribute of a GRULE indicates the type of rule.