Piping

The following computed attributes and methods are in the PipingLayout Knowledgeware dictionary. Not all methods take input parameters, and for those that do, the parameters are described in the Description column.

Whether you can see the value returned by the method depends upon how you are using it in Knowledgeware. For example, if you write a Knowledgeware rule or check causing a component to display differently based on the outcome of that rule or check, you won't see the calculated value; just the result of the calculated value.

You can see the value returned by a computed attribute in:

NOTE: The NLS names below are the default names provided by the application. You can change them as required.

 

Object Type/NLS Name Attribute/Method Name Description
ArrRun/
Run
WeightDry The weight corresponding to the material of the run.
ArrRun/
Run
WeightWet The dry weight plus the weight corresponding to the fluid carried by the run.
ArrRun/
Run
cgx The x coordinate of the center of gravity of the run.
ArrRun/
Run
cgy The y coordinate of the center of gravity of the run.
ArrRun/
Run
cgz The z coordinate of the center of gravity of the run.
MLDWeld/
Weld
NodeX Absolute X coordinate of the weld.
MLDWeld/
Weld
NodeY Absolute Y coordinate of the weld.
MLDWeld/
Weld
NodeZ Absolute Z coordinate of the weld.
PipingBendablePipe/
Pipe with bends
CumulativeLength Total length of a "Pipe with bends" object. This includes the computation for all bends.
PipingBendablePipe/
Pipe with bends
IsBendRadiusConsistent() Compares the pipe's bend radius (at each segment) with the bend rule radius. The bend rule radius is derived from the values for the pipe's nominal size, material category and schedule.
PipingBendablePipe/
Pipe with bends
IsMinimumGripLengthConsistent() Compares the bending rule mini grip length with the length of each bendable segment. Bending rule mini grip length is derived from the values for the pipe's nominal size, material category and schedule.
PipingBendablePipe/
Pipe with bends
LinePartSpecStatus When the physical part specification is:
  •  empty, the attribute shows NonSpec
  •  equal to the line specification, the attribute shows InSpec
  •  not equal to the line specification, the attribute shows OutSpec
PipingBendablePipe/
Pipe with bends
NodeBendAngle Bend angle of a specific node of a run.
PipingBendablePipe/
Pipe with bends
NodeBendRadius Bend radius of a specific node of a run.
PipingBendablePipe/
Pipe with bends
NodeNumber Node number that is generated automatically during route definition.
PipingBendablePipe/
Pipe with bends
NodeRotationAngle Rotation angle for a specific node on a run.
PipingBendablePipe/
Pipe with bends
NodeSlopeAngle Slope angle for a specific node on a run.
PipingBendablePipe/
Pipe with bends
NodeX Absolute X Coordinate for a specific node on a run.
PipingBendablePipe/
Pipe with bends
NodeX_LocalAxis The axis where X is defined by the first two segments (node 1 and node 2) of a bendable. The Y and Z axes are rotated and transformed relative to X.
PipingBendablePipe/
Pipe with bends
NodeY Absolute Y Coordinate for a specific node on a run.
PipingBendablePipe/
Pipe with bends
NodeY_LocalAxis The axis where Y is defined by the first two segments (node 1 and node 2) of a bendable. The X and Z axes are rotated and transformed relative to Y.
PipingBendablePipe/
Pipe with bends
NodeZ Absolute Z Coordinate for a specific node on a run.
PipingBendablePipe/
Pipe with bends
NodeZ_LocalAxis The axis where Z is defined by the first two segments (node 1 and node 2) of a bendable. The X and Y axes are rotated and transformed relative to Z.
PipingBendablePipe/
Pipe with bends
SegmentLength The length between 2 nodes on a run
PipingGasket/
Gasket
HexBoltCount Total number of hex bolts
PipingGasket/
Gasket
HexBoltDiameter Diameter of each hex bolts
PipingGasket/
Gasket
HexBoltLength Length of each hex bolt
PipingGasket/
Gasket
LinePartSpecStatus When the physical part specification is:
  •  empty, the attribute shows NonSpec
  •  equal to the line specification, the attribute shows InSpec
  •  not equal to the line specification, the attribute shows OutSpec
PipingGasket/
Gasket
StudBoltCount Total number of stud bolts
PipingGasket/
Gasket
StudBoltDiameter Diameter of each stud bolts
PipingGasket/
Gasket
StudBoltLength Length of each stud bolt
PipingLine/
Piping Line
FromToTable Contains the names of the From and To equipment connected by a line.
PipingLine/
Piping Line
TotalDryWeight Total dry weight of an object. This is computed by multiplying the length with the dry weight per unit length.
PipingLine/
Piping Line
TotalWetWeight Total wet weight of an object. This is computed by multiplying the length with the Wet weight per unit length.
PipingPart/
Piping Part
ConnectorNames List of connector names separated by line feed.
PipingPart/
Piping Part
ConnectorTypes List of connector types separated by line feed.
PipingPart/
Piping Part
ConnectorXCoordList List of X coordinate and current unit (e.g. mm), separated by line feed.
PipingPart/
Piping Part
ConnectorYCoordList List of Y coordinate and current unit (e.g. mm), separated by line feed.
PipingPart/
Piping Part
ConnectorZCoordList List of Z coordinate and current unit (e.g. mm), separated by line feed.
PipingPart/
Piping Part
ConnectorAttributes List of attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <AttributeName> = <AttributeValue>
PipingPart/
Piping Part
ConnectorInternalNameAttributes List of internal attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <InternalAttributeName> = <AttributeValue>
PipingPart/
Piping Part
ConnectorFlowDirections List of connector flow directions.
PipingPart/
Piping Part
ConnectedObjectNames List of connected object instance names separated by line feed.
PipingPart/
Piping Part
ConnectedObjectPartNumbers List of connected object part numbers.
PipingPart/
Piping Part
ConnectedConnectorNames List of connected connector names.
PipingPart/
Piping Part
LinePartSpecStatus When the physical part specification is:
  •  empty, the attribute shows NonSpec
  •  equal to the line specification, the attribute shows InSpec
  •  not equal to the line specification, the attribute shows OutSpec
PipingPart/
Piping Part
ParentPipingLineName Returns the name of the piping line to which the object belongs.
PipingPart/
Piping Part
ParentPipingLineObject Returns a pointer to the piping line to which the object belongs.
PipingPart/
Piping Part
ParentPipingSpoolName Returns the name of the spool to which the object belongs.
PipingPartFunc/
Piping Part Function
ConnectorNames List of connector names separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectorTypes List of connector types separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectorXCoordList List of X coordinate and current unit (e.g. mm), separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectorYCoordList List of Y coordinate and current unit (e.g. mm), separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectorZCoordList List of Z coordinate and current unit (e.g. mm), separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectorAttributes List of attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <AttributeName> = <AttributeValue>
PipingPartFunc/
Piping Part Function
ConnectorInternalNameAttributes List of internal attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <InternalAttributeName> = <AttributeValue>
PipingPartFunc/
Piping Part Function
ConnectorFlowDirections List of connector flow directions.
PipingPartFunc/
Piping Part Function
ConnectedObjectNames List of connected object instance names separated by line feed.
PipingPartFunc/
Piping Part Function
ConnectedObjectPartNumbers List of connected object part numbers.
PipingPartFunc/
Piping Part Function
ConnectedConnectorNames List of connected connector names.
PipingPartFunc/
Piping Part Function
IsInPipeSpec() Checks if the pipe specification attribute of the input piping part function is "in spec." (That is, its pipe specification value is derived from its piping line.)
PipingPartFunc/
Piping Part Function
IsNominalSizeConsistent() Checks if the input object has the same nominal size as anything connected to it.
PipingPartFunc/
Piping Part Function
IsPipeSpecConsistent() Checks if the input object has the same pipe specification as anything connected to it.
PipingPartFunc/
Piping Part Function
ParentPipingLineName Returns the name of the piping line to which the object belongs.
PipingPartFunc/
Piping Part Function
ParentPipingLineObject Returns a pointer to the piping line to which the object belongs.
PipingPartFunc/
Piping Part Function
PhysicalEndStyle Returns a string describing the endstyle type: threaded, butt-weld, plain-end, raised-face.
PipingPartFunc/
Piping Part Function
PhysicalMaterialCategory Material used to create the part: carbon steel, stainless steel, copper, aluminum.
PipingPartFunc/
Piping Part Function
PhysicalMaterialCode Industry standard code that identifies the material used to create the part.
PipingPartFunc/
Piping Part Function
PhysicalOutsideDiameter The outside diameter of the pipe.
PipingPartFunc/
Piping Part Function
PhysicalPartCode Industry standard code that identifies the part.
PipingPartFunc/
Piping Part Function
PhysicalPartName User-assigned name for the part.
PipingPartFunc/
Piping Part Function
PhysicalRating Industry standard code that describes how much pressure the material can withstand.
PipingPartFunc/
Piping Part Function
PhysicalSchedule Industry standard code that describes the wall thickness of the pipe.
PipingPartFunc/
Piping Part Function
PhysicalStandard Industry standard for the part. For example: ASTL, Iron, PVC.
PipingPartFunc/
Piping Part Function
PhysicalWallThickness Thickness of the material used to create the part.
PipingPartFunc/
Piping Part Function
PhysicalWeightDry Dry weight of an object.
PipingPartFunc/
Piping Part Function
PhysicalWeightWet Wet weight of an object.
PipingPartFunc/
Piping Part Function
ParentICLoopName Returns the name of the instrumentation and control loop to which the object belongs.
PipingPartFunc/
Piping Part Function
ParentICLoopObject Returns a pointer to the instrumentation and control loop to which the object belongs.
PipingPipe/
Pipes
BottomElevation Defines the bottom Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
PipingPipe/
Pipes
IsTotalLengthConsistent() Compares the actual pipe length with the maximum design length, which is derived from the values for nominal size and material category.
PipingPipe/
Pipes
LinePartSpecStatus When the physical part specification is:
  •  empty, the attribute shows NonSpec
  •  equal to the line specification, the attribute shows InSpec
  •  not equal to the line specification, the attribute shows OutSpec
PipingPipe/
Pipes
TopElevation Defines the top Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
PipingPipeFunc/
Pipe Function
ConnectorNames List of connector names separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectorTypes List of connector types separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectorXCoordList List of X coordinate and current unit (e.g. mm), separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectorYCoordList List of Y coordinate and current unit (e.g. mm), separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectorZCoordList List of Z coordinate and current unit (e.g. mm), separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectorAttributes List of attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <AttributeName> = <AttributeValue>
PipingPipeFunc/
Pipe Function
ConnectorInternalNameAttributes List of internal attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <InternalAttributeName> = <AttributeValue>
PipingPipeFunc/
Pipe Function
ConnectorFlowDirections List of connector flow directions.
PipingPipeFunc/
Pipe Function
ConnectedObjectNames List of connected object instance names separated by line feed.
PipingPipeFunc/
Pipe Function
ConnectedObjectPartNumbers List of connected object part numbers.
PipingPipeFunc/
Pipe Function
ConnectedConnectorNames List of connected connector names.
PipingPipeFunc/
Pipe Function
IsNominalSizeConsistent() Returns true if the input object has the same nominal size as anything connected to it.
PipingPipeFunc/
Pipe Function
IsPipeSpecConsistent() Returns true if the input object has the same pipe specification as anything is connected to it.
PipingPipeFunc/
Pipe Function
ParentPipingLineName Returns the name of the piping line to which the object belongs.
PipingPipeFunc/
Pipe Function
ParentPipingLineObject Returns a pointer to the piping line to which the object belongs.
PipingSpool/
Piping Spool
ParentPipingLineName Returns the name of the piping line to which the object belongs.
PipingSpool/
Piping Spool
ParentPipingLineObject Returns a pointer to the piping line to which the object belongs.
PipingSpool/
Piping Spool
TotalDryWeight Total dry weight of an object. This is computed by multiplying the length with the dry weight per unit length.
PipingSpool/
Piping Spool
TotalWetWeight Total wet weight of an object. This is computed by multiplying the length with the wet weight per unit length.
PipingStraightPipe/
Pipe
NodeNumber Node number that is generated automatically during route definition.
PipingStraightPipe/
Pipe
NodeX Absolute X coordinate for a specific node of the pipe.
PipingStraightPipe/
Pipe
NodeY Absolute Y coordinate for a specific node of the pipe.
PipingStraightPipe/
Pipe
NodeZ Absolute Z coordinate for a specific node of the pipe.