PlantWise Help

Structure Routing Definitions

Because of their dependant association with structures, structure pipeways, vertical pipeways, vertical chases, and floor penetrations are written to the model’s script file after the structure definitions.

Structure Pipeways

(dpar-gui-save-str-pw-section "<tag>" "<structure-tag>"
"<section-tag>" <section-floor> '<centerline-location-method> 
"<orientation>" <east-west-bay> <north-south-bay>
"<bay-alignment>" "<x-ordinate>" "<y-ordinate>" <section-number> 
"<bent-type>" "<column-shape>" "<beam-shape>" "<lateral-shape>" 
'<drop-zone> <edge-space> <pipeway-width> <number-of-bents>
<bent-spacing> <number-of-levels> <lowest-level-elevation>
"<level-elevations>" <accessway-as-obstacle>
"<section-alignment>")
where:
<tag> ::= <string>
  • A unique name.
<structure-tag> ::= <string>
  • The name of the structure where the pipeway is located.
<section-tag> ::= <string>
  • The name of the structure section where the pipeway is located.
<section-floor> ::= <integer>
  • The floor number of the structure section where the pipeway is located.
<centerline-location-method> ::= BY-BAY | BY-STRUCTURE-COORDS
  • The location of the pipeway’s centerline can be defined in relation to the structure section (BY-BAY) or by coordinates using the origin of the structure section as the reference point (BY-STRUCTURE-COORDS).
<orientation> ::= :N | :E | :S | :W
  • Pipeways may be oriented north, south, east, or west.
<east-west-bay> ::= <integer>
  • The east-west bay number the pipeway is located in. If the pipeway is being placed by structure coordinates, this value is left empty.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<north-south-bay> ::= <integer>
  • The north-south bay number the pipeway is located in. If the pipeway is being placed by structure coordinates, this value is left empty.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<bay-alignment> ::= NORTH | SOUTH | EAST | WEST
  • Placement of the pipeway in the bay direction perpendicular to the pipeway’s orientation: NORTH or SOUTH for pipeways oriented to the east or west; EAST or WEST for pipeways oriented to the north or south. If the pipeway is being placed by structure coordinates, this value is left empty.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<x-ordinate> ::= <real>
  • The x-value of the pipeway’s origin. If the pipeway is being placed by bay, this value is left empty.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<y-ordinate> ::= <real>
  • The y-value of the pipeway’s origin. If the pipeway is being placed by bay, this value is left empty.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<section-number> ::= <integer>
  • Pipeways may have multiple sections with differing parameters; they are placed end-to-end in the direction of the orientation. The first section is numbered 1 and additional sections are numbered sequentially – no gaps in section numbering are allowed.
<bent-type> ::= TRAPEZE | FLOOR-TO-CEILING
  • The type of bent used for the pipeway section.
<column-shape> ::= <string>
  • The designation of the column members. The designation must be in the project’s structural-member-properties table.
<beam-shape> ::= <string>
  • The designation of the beam members. The designation must be in the project’s structural-member-properties table.
<lateral-shape> ::= <string> | NO_BRACE
  • The designation of the lateral members. The designation must be in the project’s structural-member-properties table.
<drop-zone-location> ::= INSIDE | OUTSIDE
  • The pipeway edge vertical drop zone may be inside or outside the column line.
<edge-space> ::= <real>
  • Amount of space along inside of pipeway edges reserved for instrument, cable trays, or other non-pipeline components. May be zero.
<pipeway-width> ::= <real>
  • Center-to-center spacing between columns in the same bent across the pipeway.
<number-of-bents> ::= <integer>
  • The number of bents in the section (1 + spans).
<bent-spacing> ::= <real>
  • Center-to-center spacing between bents along the pipeway.
<number-of-levels> ::= <integer>
  • Number of routing levels along the pipeway.
<lowest-level-elevation> ::= <real>
  • Elevation of the lowest routing level (the others are computed).
<section-alignment> ::= :TOP | :CENTER | :BOTTOM
  • For additional pipeway sections, this is the alignment of the current section to the previous one. For the first section, this is :CENTER.
<level-elevations> ::= {<real>}* | NIL
  • For pipeways with variable level elevations, this is a list of real numbers providing the elevations of each approach and berthing level. For fixed elevations, quotation marks are not used around the NIL.
<accessway-as-obstacle> ::= T | :NIL
  • If the area under the pipeway is to be considered an obstacle to routing, then T, else :NIL.
@@@
  • www

Vertical Pipeways

(cpr-verify-and-add-new-vertical-pipeway "<structure-tag>"
"<section-tag>" "<tag>" "<section-number>" <placement-method>
<origin> "<face>" <reference-column> "<direction-from-column>"
<offset-method> <offset-from-column> "<offset-direction>"
<bottom-floor> <top-floor> <first-level-offset>
<second-level-offset> <width> '<beam-shape> '<leg-shape>)
where:
<structure-tag> ::= <string>
  • The unique name of the structure the vertical pipeway is placed on.
<section-tag> ::= <string>
  • The unique name of the structure section the vertical pipeway is placed on.
<tag> ::= <string>
  • The unique name of the vertical pipeway.
<section-number> ::= <integer>
  • Vertical pipeways may have multiple sections with differing parameters and are placed end-to-end. The first section is numbered 1 and additional sections are numbered sequentially – no gaps in section numbering are allowed.
<placement-method> ::= 0 | 1
  • If set to 0, the vertical pipeway is being placed relative to the structure section (On Section Face).
  • If set to 1, the vertical pipeway is being placed by section coordinates (By Coordinates).
<origin> ::= 0.0 0.0 0.0 | 0 <x-ordinate> <y-ordinate>
  • X, Y, and Z coordinates of the centerline of the starting end of the first section of the pipeway.
  • When the <placement-method> is set to 0, then the origin is: 0.0 0.0 0.0;
  • when the <placement-method> is set to 1, the origin is: 0 <x-ordinate> <y-ordinate> of the pipeway with the placement point of the structure section acting as the reference point.
<face> ::= :N | :S | :E | :W
  • The face of the structure section the vertical pipeway is placed on.
Note: this data is always written with respect to the structure section’s origin as if it has not been rotated.
<reference-column> ::= <integer>
  • The structure section column being used as reference for the placement of the vertical pipeway.
  • If the <placement-method> is set to 1, then the <reference-column> is 0.
<direction-from-column> ::= North | South | East | West | Center
  • The side of the <reference-column> the vertical pipeway is placed on.
  • If the <placement-method> is set to 1, then the <direction-from-column> is Center.
<offset-method> ::= 0 | 1
  • If the vertical pipeway is being placed relative to the structure section (<placement-method> is set to 0), and the pipeway is going to be aligned in the bay either, left, right, or center, then the <offset-method> is 1. In all other cases, the <offset-method> is 0.
<offset-from-column> ::= <real>
  • The distance of the offset from the <reference-column>. This value is 0.0 unless the <placement-method> and the <offset-method> are set to 0.
<offset-direction> ::= North | South | East | West | A
  • The direction of the offset from the <reference-column>.
  • If the <placement-method> is set to 1, then the <offset-from-column> is A.
<bottom-floor> ::= <integer>
  • The floor level of the structure section that is the bottom elevation of the vertical pipeway section.
<top-floor> ::= <integer>
  • The floor level of the structure section that is the top elevation of the vertical pipeway section.
<first-level-offset> ::= <real>
  • The depth of the vertical pipeway’s first level.
<second-level-offset> ::= <real>
  • The depth of the vertical pipeway’s second level. If the vertical pipeway only has one level, then this is set to 0.0.
<width> ::= <real>
  • The width of the vertical pipeway section.
<beam-shape> ::= <string>
  • The designation of the beam members. The designation must be in the project’s structural-member-properties table.
<leg-shape> ::= <string>
  • The designation of the lateral members. The designation must be in the project’s structural-member-properties table.

Vertical Chase

(cpr-verify-and-add-new-vert-chase "<structure-tag>"
"<section-tag>" "<tag>" "<x-ordinate>" "<y-ordinate>" "<depth>" 
"<width>" "<bottom-elevation>" "<top-elevation>" <orientation>)
where:
<structure-tag> ::= <string>
  • The unique name of the structure the vertical pipeway is placed on.
<section-tag> ::= <string>
  • The unique name of the structure section the vertical pipeway is placed on.
<tag> ::= <string>
  • The unique name of the vertical pipeway.
<x-ordinate> ::= <real>
  • The x-ordinate of the chase with the placement point of the structure section acting as the reference point.
<y-ordinate> ::= <real>
  • The y-ordinate of the chase with the placement point of the structure section acting as the reference point.
<depth> ::= <real>
  • The depth of the chase.
<width> ::= <real>
  • The width of the chase.
<top-elevation> ::= <real>
  • The elevation – in global coordinates – of the top of the chase.
<bottom-elevation> ::= <real>
  • The elevation – in global coordinates – of the bottom of the chase.
<orientation> ::= :N | :S | :E | :W
  • The orientation of the chase.

Floor Penetration

(cpr-verify-and-add-new-int-drop-zone "<structure-tag>"
"<section-tag>" <section-floor> "<tag>" "<x-ordinate>"
"<y-ordinate>" "<depth>" "<width>" "<orientation>")
where:
<structure-tag> ::= <string>
  • The unique name of the structure the floor penetration is placed on.
<section-tag> ::= <string>
  • The unique name of the structure section the floor penetration is placed on.
<section-floor> ::= <integer>
  • The floor number of the structure section where the floor penetration is located.
<tag> ::= <string>
  • The unique name of the floor penetration.
<x-ordinate> ::= <real>
  • The x-ordinate of the floor penetration with the placement point of the structure section acting as the reference point.
<y-ordinate> ::= <real>
  • The y-ordinate of the floor penetration with the placement point of the structure section acting as the reference point.
<depth> ::= <real>
  • The depth of the floor penetration.
<width> ::= <real>
  • The width of the floor penetration.
<orientation> ::= N | S | E | W
  • The orientation of the floor penetration.