HVAC

The following computed attributes and methods are in the HVACLayout 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
HVACDuctFunc
Duct Function
IsEquivDiameterConsistent() Checks if the input object has the same equivalent diameter as anything connected to it.
HVACDuctFunc/
Duct Function
ParentHVACLineName Returns the name of the HVAC line to which the object belongs.
HVACDuctFunc/
Duct Function
ParentHVACLineObject Returns a pointer to the HVAC line to which the object belongs.
HVACFltOvlStDuct/
Flat Oval Straight Duct
BottomElevation Defines the bottom Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACFltOvlStDuct/
Flat Oval Straight Duct
TopElevation Defines the top Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACLine/
HVAC Line
FromToTable Contains the names of the From and To equipment connected by a line.
HVACLine/
HVAC Line
TotalDryWeight Total dry weight of an object. This is computed by multiplying the length with the dry weight per unit length.
HVACPart/
HVAC Part
ConnectorNames List of connector names separated by line feed.
HVACPart/
HVAC Part
ConnectorTypes List of connector types separated by line feed.
HVACPart/
HVAC Part
ConnectorXCoordList List of X coordinate and current unit (e.g. mm), separated by line feed.
HVACPart/
HVAC Part
ConnectorYCoordList List of Y coordinate and current unit (e.g. mm), separated by line feed.
HVACPart/
HVAC Part
ConnectorZCoordList List of Z coordinate and current unit (e.g. mm), separated by line feed.
HVACPart/
HVAC Part
ConnectorAttributes List of attribute names and values for each connector in the ConnectorNames list, separated by line feed and formatted as:
  <AttributeName> = <AttributeValue>
HVACPart/
HVAC 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>
HVACPart/
HVAC Part
ConnectorFlowDirections List of connector flow directions.
HVACPart/
HVAC Part
ConnectedObjectNames List of connected object instance names separated by line feed.
HVACPart/
HVAC Part
ConnectedObjectPartNumbers List of connected object part numbers.
HVACPart/
HVAC Part
ConnectedConnectorNames List of connected connector names.
HVACPart/
HVAC Part
ParentHVACSpoolName Returns the name of the HVAC spool to which the HVAC part belongs.
HVACPart/
HVAC Part
ParentHVACSpoolObject Returns a pointer to the HVAC spool to which the HVAC part belongs.
HVACPartFunc/
HVAC Part Function
ConnectorNames List of connector names separated by line feed.
HVACPartFunc/
HVAC Part Function
ConnectorTypes List of connector types separated by line feed.
HVACPartFunc/
HVAC Part Function
ConnectorXCoordList List of X coordinate and current unit (e.g. mm), separated by line feed.
HVACPartFunc/
HVAC Part Function
ConnectorYCoordList List of Y coordinate and current unit (e.g. mm), separated by line feed.
HVACPartFunc/
HVAC Part Function
ConnectorZCoordList List of Z coordinate and current unit (e.g. mm), separated by line feed.
HVACPartFunc/
HVAC 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>
HVACPartFunc/
HVAC 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>
HVACPartFunc/
HVAC Part Function
ConnectorFlowDirections List of connector flow directions.
HVACPartFunc/
HVAC Part Function
ConnectedObjectNames List of connected object instance names separated by line feed.
HVACPartFunc/
HVAC Part Function
ConnectedObjectPartNumbers List of connected object part numbers.
HVACPartFunc/
HVAC Part Function
ConnectedConnectorNames List of connected connector names.
HVACPartFunc/
HVAC Part Function
IsEquivDiameterConsistent() Returns true if the input object has the same equivalent diameter as anything connected to it.
HVACPartFunc/
HVAC Part Function
IsInDuctSpec() Returns true if the duct specification attribute of the input HVAC part function is "in spec." (That is, its duct specification value is derived from its HVAC line.)
HVACPartFunc/
HVAC Part Function
ParentICLoopName Returns the name of the instrumentation and control loop to which the object belongs.
HVACPartFunc/
HVAC Part Function
PhysicalEndStyle Returns a string describing the endstyle type: plain-end or flanged.
HVACPartFunc/
HVAC Part Function
PhysicalHeight Height of the part.
HVACPartFunc/
HVAC Part Function
PhysicalMaterialCategory Material used to create the part: aluminum, steel, copper, etc.
HVACPartFunc/
HVAC Part Function
PhysicalMaterialThickness Thickness of the material used to create the part.
HVACPartFunc/
HVAC Part Function
PhysicalPartName User-assigned name for the part.
HVACPartFunc/
HVAC Part Function
PhysicalShape Shape of the part: round, rectangular, flat-oval, or radius-corner.
HVACPartFunc/
HVAC Part Function
PhysicalStandard Industry standard for the part. For example: Ashrae92.
HVACPartFunc/
HVAC Part Function
PhysicalWeightDry Dry weight of an object.
HVACPartFunc/
HVAC Part Function
PhysicalWidth Wet weight of an object.
HVACPartFunc/
HVAC Part Function
ParentICLoopObject Returns a pointer to the instrumentation and control loop of which the object is a member.
HVACRectRCStrtDuct/
Radius Corner Straight Duct
BottomElevation Defines the bottom Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACRectRCStrtDuct/
Radius Corner Straight Duct
TopElevation Defines the top Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACRectStDuct/
Rectangular Straight Duct
BottomElevation Defines the bottom Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACRectStDuct/
Rectangular Straight Duct
TopElevation Defines the top Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACRndStDuct
Round Straight Duct
BottomElevation Defines the bottom Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACRndStDuct/
Round Straight Duct
TopElevation Defines the top Z elevation of a specific duct. You can use this parameter to label the required elevations while drafting.
HVACSpool/
HVAC Spool
TotalDryWeight Total dry weight of an object. This is computed by multiplying the length with the dry weight per unit length.
HVACStraightDuct/
Straight Duct
NodeNumber Node number that is generated automatically during route definition.
HVACStraightDuct/
Straight Duct
NodeX Absolute X coordinate for a specific node of the duct.
HVACStraightDuct/
Straight Duct
NodeY Absolute Y coordinate for a specific node of the duct.
HVACStraightDuct/
Straight Duct
NodeZ Absolute Z coordinate for a specific node of the duct.
HVACStraightDuct/
Straight Duct
UpDirectionX X direction for an up vector.
HVACStraightDuct/
Straight Duct
UpDirectionY Y direction for an up vector.
HVACStraightDuct/
Straight Duct
UpDirectionZ Z direction for an up vector.
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.