The following computed attributes and methods are in the PlantShipLayout Knowledgeware dictionary, which contains higher-level object types whose attributes and methods are inherited by object types exposed in other knowledgeware dictionaries. 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:
| Object Type | Attribute/Method Name | Description |
| MldInsulationPart | ActiveStatus | Describes the show/no-show status of the insulation graphic representation. You can use this attribute while defining rules for interference management. |
| MldLoosePart | BasePartInstanceName | Returns the base part instance name. |
| MldLoosePart | BasePartNumber | Returns the base part number. |
| MldZone | AreZoneBoundariesValid() | This method returns a value of TRUE if all the input zone boundaries are valid. |
| PltShpCompFunction | FrameLocation | Returns a string representing the component function location relative to any frame/title block information associated with the schematic design document. For example: D3. |
| PltShpCompFunction | GetXViewCoord() | This method returns a double representing the
X coordinate location of the component function relative to a
user-specified view. If the view does not exist, or if the input parameter
is entered incorrectly, it returns 0.0. Input Parameters: ViewName the name of the view used to calculate the X coordinate location of the component function. Format: String |
| PltShpCompFunction | GetXYViewLocation() | This method returns a string describing the
XY location of the component function relative to a user-specified view.
The string returned is in the following format: (X, Y) CurrentUnit.
For example, (13.6, -25.8) in. If the view does not exist, or if the input parameter is entered incorrectly, it returns a null string. Input Parameters: ViewName: the name of the view used to calculate the XY coordinate location of the component function. Format: String |
| PltShpCompFunction | GetYViewCoord() | This method returns a double representing the
Y coordinate location of the component function relative to a
user-specified view. If the view does not exist, or if the input parameter
is entered incorrectly, it returns 0.0. Input Parameters: ViewName: the name of the view used to calculate the Y coordinate location of the component function. Format: String |
| PltShpCompFunction | IsPartNumberValid() | Returns true if the component function's part number is on its list of valid part numbers. Note: this method also returns true for component functions with no part number. |
| PltShpCompFunction | IsPartTypeValid() | Returns true if the component function's part type is on its list of valid part types. Note: this method also returns true for component functions with no part type. |
| PltShpCompFunction | PartType | Returns a string describing the object part type as set through the Part Selection command. Returns the null string ("") if the part type is not set. |
| PltShpCompFunction | PhysicalPartNumber | The 3D part number that corresponds to the schematic object that was set through the Part Selection command. Returns the null string ("") if the 3D part number is not set. |
| PltShpCompFunction | SwapGraphics() | Method to swap the graphics on the input
component function to a graphic representation name you specify. This
method performs the same function as the Swap Graphic command,
however you can use this method to swap graphics on multiple instances of
a component. Input Parameters: GRRName: the graphic representation name to which to swap the graphics. This is one of the names that appears in the Build Graphic panel when you build a graphic representation for a reference component. Sample call: SwapGraphics("Valve Closed") |
| PltShpCompFunction | XBackgroundCoord | Returns a double describing the X coordinate of the component function in a view named "Background View," if it exists. If the view does not exist, it returns 0.0. |
| PltShpCompFunction | XCoord | Returns a double describing the X coordinate of the XY location of the component function. |
| PltShpCompFunction | XYBackgroundLoc | Returns a string describing the XY location
of the component function in a view named "Background View," if it exists.
If the view does not exist, it returns 0.0. Format: (X, Y) CurrentUnit. For example, (13.6, -25.8) in. A null string is returned if there is no view named "Background View." |
| PltShpCompFunction | XYLocation | Returns a string describing the XY location
of the component function in the diagram. Format: (X, Y) CurrentUnit. For example, (645, 400) mm. |
| PltShpCompFunction | YBackgroundCoord | Returns a double describing the Y coordinate of the component function in a view named "Background View," if it exists. If the view does not exist, it returns 0.0. |
| PltShpCompFunction | YCoord | Returns a double describing the Y coordinate of the component function's XY location in the diagram. |
| PltShpFunction | ConnectorNames | List of connector names separated by line feed. |
| PltShpFunction | ConnectorTypes | List of connector types separated by line feed. |
| PltShpFunction | ConnectorXCoordList | List of X coordinate and current unit (e.g. mm), separated by line feed. |
| PltShpFunction | ConnectorYCoordList | List of Y coordinate and current unit (e.g. mm), separated by line feed. |
| PltShpFunction | ConnectorZCoordList | List of Z coordinate and current unit (e.g. mm), separated by line feed. |
| PltShpFunction | ConnectorAttributes | List of attribute names and values for each
connector in the ConnectorNames list, separated by line feed and
formatted as: <AttributeName> = <AttributeValue> |
| PltShpFunction | ConnectorInternalNameAttributes |
List of
internal attribute names and values for each connector in the
ConnectorNames list, separated by line feed and formatted as: <InternalAttributeName> = <AttributeValue> |
| PltShpFunction | ConnectorFlowDirections | List of connector flow directions. |
| PltShpFunction | ConnectedObjectNames | List of connected object instance names separated by line feed. |
| PltShpFunction | ConnectedObjectPartNumbers | List of connected object part numbers. |
| PltShpFunction | ConnectedConnectorNames | List of connected connector names. |
| PltShpFunction | AllCoincidentElementsConnected() | Returns true if all objects with coincident connectors have actually been connected using the Connect command. |
| PltShpFunction | ClassName | Returns the object class name as it appears in the Feature Dictionary. For example, Block Valve Function. |
| PltShpFunction | HasNoFlowDirectionConflicts() | Returns true if the input schematic object has no flow direction conflicts with any schematic objects connected to it. |
| PltShpFunction | IsElementConnected() | Returns true if the object is connected to another object. |
| PltShpFunction | IsNameConsistent() | Returns true if the name of the input object is the same as the ID schema generated name for that object class. |
| PltShpFunction | ParentZoneNames | Returns a comma-separated list of zones to
which the object belongs.
For example: FireZone1,WatertightZone3. |
| PltShpFunction | SetGraphicProperties() | Sets the color, line type, and thickness
graphic properties on the input schematic object. Input Parameters: Red: an integer defining the RGB red component that defines the object color. Range is 0-255. Blue: an integer defining the RGB blue component that defines the object color. Range is 0-255. Green: an integer defining the RGB green component that defines the object color. Range is 0-255. LineType: an integer defining the line type for the object. The number corresponds to the number shown in the line type pull-down combo of the Graphic Properties toolbar. Thickness: and integer defining the line thickness for the object. The number corresponds to the number shown in the Linetype pull-down in the Edit-Properties Graphics tab. Sample call: SetGraphicProperties(255, 0, 0, 2, 3) |
| PltShpGroup | ClassName | Returns the object class name as it appears in
the Feature Dictionary.
For example, Block Valve Function. |
| PltShpGroup | IsNameConsistent() | Returns true if the input object name is the same as the ID schema-generated name for that object class. |
| PltShpPhysical | AssociatedLooseParts | Returns the loose part numbers associated with the base parts, and the quantity of these loose parts. |
| PltShpPhysical | CatalogPartName | Returns catalog part name. |
| PltShpPhysical | ClassName | Returns the object class name as it appears in
the Feature Dictionary. For example: Block Valve Function. |
| PltShpPhysical | CompartmentNames | Returns a comma-separated list of the compartments enclosing the object. (Note: the compartments do not need to be in the session). |
| PltShpPhysical | IsElementConnected() | This method returns true if the object is connected to another object. |
| PltShpPhysical | IsNameConsistent() | Returns true if the input object name is the same as the ID schema-generated name for that object class. |
| PltShpPhysical | ParametricReferenceName | Name of the parametric reference used to generate a specific resolved reference. |
| PltShpPhysical | ParentAssemblyID | Returns immediate Equipment Assembly’s ID. |
| PltShpPhysical | ParentAssemblyPartNumber | Returns immediate Equipment Assembly’s part number. |
| PltShpPhysical | ParentZoneNames | Returns a comma-separated list of zones to
which the object belongs.
For example: FireZone1,WatertightZone3. |
| PltShpPhysical | TotalInsulationThickness | The sum of all insulation thickness values defined for a specific physical part (pipe, HVAC, etc.) |
| PltShpPhysical | XCoord | Returns a double describing the X coordinate of the 3D part's XYZ location. |
| PltShpPhysical | XYZLocation | Returns a string describing the XYZ location
of the 3D part. Format: (X, Y, Z) CurrentUnit. For example: (645, 400, -318) mm. |
| PltShpPhysical | YCoord | Returns a double describing the Y coordinate of the 3D part's XYZ location. |
| PltShpPhysical | ZCoord | Returns a double describing the Z coordinate of the 3D part's XYZ location. |
| PltShpStringFunction | GetRouteViewLength() | This method returns a double describing the
string function (route, pipeline, etc.) length relative to a
specified view name. If the view does not exist, this method returns 0.0.
Input Parameters: ViewName: the name of the view used to calculate the string function length. Format: string. |
| PltShpStringFunction | IsOnOffSheetConnected() | Returns true if all offsheet connectors of the string function are connected. |
| PltShpStringFunction | OnOffSheetDocLinkName | The name of the document to which an offsheet connector is linked if the document is in session. Returns the null string ("") otherwise. |
| PltShpStringFunction | OnOffSheetPublicationName | Returns the publication name through which an offsheet connector is linked to another offsheet connector, if any. Returns the null string ("") otherwise. |
| PltShpStringFunction | RouteBackgroundLength | Returns a double describing the string function length relative to a view named "Background View." If the view does not exist, this method returns 0.0. |