HVAC_PhysicalTypes Methods

This page discusses:

HVAC_Duct_Occurrence.GetAttributeOnConnectedPorts()

Function used to read the port attributes (lengths) on the connected HVAC parts.

Signature

HVAC_Duct_Occurrence.GetAttributeOnConnectedPorts(Linked Object : HVAC_Duct_Occurrence, Attribute : String, This Object Value : String, Linked Object Value : String) : Integer

Arguments

Name Input / Output Required? Type Comment
Linked Object In Yes HVAC_Duct_Occurrence
Attribute In Yes String The list of attributes comes from the HVAC_PartPort object.
This Object Value Out Yes String
Linked Object Value Out Yes String

ReturnType

Integer
Return code:
  • 0: Attribute values successfully read.
  • 1: Attribute not found on ThisObject.
  • 2: Attribute not found on iOccurrence.
  • 3: Invalid attribute.

HVAC_Duct_Occurrence.GetAttributeOnConnectedPorts()

Function used to read the port attributes (lengths) on the connected HVAC ducts.

Signature

HVAC_Duct_Occurrence.GetAttributeOnConnectedPorts(Linked Object : HVAC_Duct_Occurrence, Attribute : String, This Object Value : LENGTH, Linked Object Value : LENGTH) : Integer

Arguments

Name Input / Output Required? Type Comment
Linked Object In Yes HVAC_Duct_Occurrence
Attribute In Yes String The list of attributes comes from the HVAC_PartPort object.
This Object Value Out Yes LENGTH
Linked Object Value Out Yes LENGTH

ReturnType

Integer

HVAC_Duct_Occurrence.GetLineIDName()

Function used to read the line ID name.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Duct_Occurrence.GetLineIDName() : String

ReturnType

String

HVAC_Duct_Occurrence.GetLineIDObject()

Function used to return the line ID object.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Duct_Occurrence.GetLineIDObject() : HVAC_Line

ReturnType

HVAC_Line

HVAC_Duct_Occurrence.GetRelatedObjects()

Function used to get connected HVAC parts, which can be any of the following: HVAC part, equipment with at least one HVAC port.

Signature

HVAC_Duct_Occurrence.GetRelatedObjects() : List

ReturnType

List

Example

let results (List)
let nb (Integer) 
let inst (VPMInstance)
results = iOcc.GetRelatedObjects()
nb = results.Size()
inst = iOcc.Instance
if (NULL <> inst)
{

  if (0 == nb) { ThisCheck.AddTupleFailedWithComment("Isolated Part.", inst) }

  else { ThisCheck.AddTupleSucceeded(inst) }

}

HVAC_Duct_Occurrence.GetSpecName()

Function used to return the name of the spec set on the line ID of the occurrence /instance in a string.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Duct_Occurrence.GetSpecName() : String

ReturnType

String

HVAC_Duct_Occurrence.GetSpecificationObject()

Function used to return the object of the specification.

Signature

HVAC_Duct_Occurrence.GetSpecificationObject() : EnsSpecification

ReturnType

EnsSpecification

HVAC_Duct_Occurrence.GetSpoolName()

Function used to return the spool name.

Signature

HVAC_Duct_Occurrence.GetSpoolName() : String

ReturnType

String

HVAC_Duct_Occurrence.GetSpoolObject()

Function used to return the spool object.

Signature

HVAC_Duct_Occurrence.GetSpoolObject() : HVAC_Spool_Occurrence

ReturnType

HVAC_Spool_Occurrence

HVAC_Duct_Occurrence.GetTwistStatus()

Function used to detect if the duct contains bend points that cannot be manufactured. -

Signature

HVAC_Duct_Occurrence.GetTwistStatus() : Boolean

ReturnType

Boolean

HVAC_Insulation_Occurrence.GetCoveredObject()

Function used to return the covered object.

Signature

HVAC_Insulation_Occurrence.GetCoveredObject() : ProductOccurrence

ReturnType

ProductOccurrence

HVAC_Insulation_Occurrence.GetLineIDName()

Function used to read the line ID name.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Insulation_Occurrence.GetLineIDName() : String

ReturnType

String

HVAC_Insulation_Occurrence.GetLineIDObject()

Function used to return the line ID object.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Insulation_Occurrence.GetLineIDObject() : HVAC_Line

ReturnType

HVAC_Line

HVAC_Insulation_Occurrence.GetSpecName()

Function used to return the name of the spec set on the line ID of the occurrence /instance in a string.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Insulation_Occurrence.GetSpecName() : String

ReturnType

String

HVAC_Insulation_Occurrence.GetSpecificationObject()

Function used to return the object of the specification.

Signature

HVAC_Insulation_Occurrence.GetSpecificationObject() : EnsSpecification

ReturnType

EnsSpecification

HVAC_Insulation_Occurrence.GetSpoolName()

Function used to return the spool name.

Signature

HVAC_Insulation_Occurrence.GetSpoolName() : String

ReturnType

String

HVAC_Insulation_Occurrence.GetSpoolObject()

Function used to return the spool object.

Signature

HVAC_Insulation_Occurrence.GetSpoolObject() : HVAC_Spool_Occurrence

ReturnType

HVAC_Spool_Occurrence

HVAC_Part_Occurrence.GetAttributeOnConnectedPorts()

Function used to read the attributes (lengths) on the connected HVAC parts.

Signature

HVAC_Part_Occurrence.GetAttributeOnConnectedPorts(Linked Object : HVAC_Part_Occurrence, Attribute : String, This Object Value : String, Linked Object Value : String) : Integer

Arguments

Name Input / Output Required? Type Comment
Linked Object In Yes HVAC_Part_Occurrence
Attribute In Yes String The list of attributes comes from the HVAC_PartPort object.
This Object Value Out Yes String
Linked Object Value Out Yes String

ReturnType

Integer

HVAC_Part_Occurrence.GetAttributeOnConnectedPorts()

Function used to read the attributes (lengths) on the connected HVAC parts.

Signature

HVAC_Part_Occurrence.GetAttributeOnConnectedPorts(Linked Object : HVAC_Part_Occurrence, Attribute : String, This Object Value : LENGTH, Linked Object Value : LENGTH) : Integer

Arguments

Name Input / Output Required? Type Comment
Linked Object In Yes HVAC_Part_Occurrence
Attribute In Yes String The list of attributes comes from the HVAC_PartPort object.
This Object Value Out Yes LENGTH
Linked Object Value Out Yes LENGTH

ReturnType

Integer

HVAC_Part_Occurrence.GetLineIDName()

Function used to read the line ID name.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Part_Occurrence.GetLineIDName() : String

ReturnType

String

HVAC_Part_Occurrence.GetLineIDObject()

Function used to return the line ID object.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Part_Occurrence.GetLineIDObject() : HVAC_Line

ReturnType

HVAC_Line

HVAC_Part_Occurrence.GetRelatedObjects()

Function used to return the connected objects.

Signature

HVAC_Part_Occurrence.GetRelatedObjects() : List

ReturnType

List

HVAC_Part_Occurrence.GetSpecName()

Function used to return the name of the spec set on the line ID of the occurrence /instance in a string.

Note: The items must be loaded in a RFLP session.

Signature

HVAC_Part_Occurrence.GetSpecName() : String

ReturnType

String

HVAC_Part_Occurrence.GetSpecificationObject()

Function used to return the object of the specification.

Signature

HVAC_Part_Occurrence.GetSpecificationObject() : EnsSpecification

ReturnType

EnsSpecification

HVAC_Part_Occurrence.GetSpoolName()

Function used to return the spool name.

Signature

HVAC_Part_Occurrence.GetSpoolName() : String

ReturnType

String

HVAC_Part_Occurrence.GetSpoolObject()

Function used to return the spool object.

Signature

HVAC_Part_Occurrence.GetSpoolObject() : HVAC_Spool_Occurrence

ReturnType

HVAC_Spool_Occurrence

HVAC_Spool_Occurrence.GetSpoolMembers()

Function used to return the spool members.

Signature

HVAC_Spool_Occurrence.GetSpoolMembers() : List

ReturnType

List

HVAC_Spool_Occurrence.GetSpoolMode()

Function used to return the spool mode.

Signature

HVAC_Spool_Occurrence.GetSpoolMode() : HVACSpool_Mode

ReturnType

HVACSpool_Mode