All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATHvacDesignUseItf Interface CATIHvaDuctInstance

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIHvaDuctInstance

Interface to access Rigid and Flexible Duct Instance.

Role: Retrieve the connected Rigid Duct, Flexible Duct, HVAC part, Equipment link to the branch port or Duct end This interface is implemented by PLM Occurrence of Rigid Duct or Flexible Duct.

Method Index

o GetConnectedObject(CATIHvaHvacPortRef*&,CATBaseUnknown*&,CATIHvaHvacPortRef*): Gets the other connectable object and Port at this Port.
o GetLinkedSupports(CATLISTP(CATIHvaSupportInstance)&,CATListOfInt*,CATListOfInt*): Retrieves the list of Support Instances linked to the Duct Instance.
o GetLogicalLine(CATIHvaLogicalLineInstance*&): Retrieves the Logical Line Instance if any.
o GetReference(CATBaseUnknown*&): Gets the PLM reference of corresponding Duct Occurrence.
o GetRelatedObject(CATLISTP(CATBaseUnknown)*&): Gets the related object in term of insulation, HVAC part with Hole port and support.
o GetSpool(CATIHvaSpoolInstance*&): Finds the Spool of current duct if any.
o ListGeometricalBranch(CATLISTP(CATBaseUnknown)*&,CATListOfDouble&): Gets the list of all geometrical branch.

Methods

o GetConnectedObject

public virtual GetConnectedObject(		`opiOtherPort`,
		`opiOtherConnectable`,
		`ipiThisPort`)

Gets the other connectable object and Port at this Port.

Parameters:

opIOtherConnectable: A connected object [out, CATBaseUnknown#Release].
opIOtherPort: A Port of the other connected object [out, CATIHvaHvacPortRef#Release].
ipIThisPort: A Port of this object. (Branch Port or Duct End) [in, CATIHvaHvacPortRef].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: ipiThisPort argument is NULL or output argument pointer(s) is(are) NOT NULL
E_FAIL: operation failed

o GetLinkedSupports

public virtual GetLinkedSupports(	`oLptrSupportInstance`,
	`opListOfSupportRefPoints`	`= NULL`,
	`opListOfSupportProjectPoints`	`= NULL`)

Retrieves the list of Support Instances linked to the Duct Instance.
Role: Retrieves the list of Support Instances linked to the Duct Instance.

Parameters:

oLptrSupport: List of Support Instances linked to the Duct Instance. The list can be empty. Each pointer of the list has to be released.
opListOfSupportRefPoints: [out, optional] Pointer to the List of nodes on the route which are reference points on support.
opListOfSupportProjectPoints[out,: optional] Pointer to the List of nodes on the route which are projected points on support.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful
S_FALSE: Operation is successful, but current Duct does not have any support linked.
E_INVALIDARG: The input argument oLptrSupport is not empty
E_FAIL: Otherwise

o GetLogicalLine

public virtual GetLogicalLine( opiLogLine)

Retrieves the Logical Line Instance if any.
Role: Retrieves the Logical Line Instance if any.

Parameters:

opiLogLine: [out, CATIHvaLogicalLineInstance#Release] Interface pointer on Logical Line Instance. Can be NULL if no Logical Line has been found.

Returns:

An HRESULT value.
Legal values:

S_OK: Operation is successful.
S_FALSE: Operation is successful, but current Duct is not in Logical Line.
E_INVALIDARG: The input argument opiLogLine is not NULL.
E_FAIL: Otherwise.

o GetReference

public virtual GetReference( opIDuctReference)

Gets the PLM reference of corresponding Duct Occurrence.
Postcondition This method can return a Rigid or Flexible Duct.

Parameters:

opIDuctReference

A pointer on reference [out, CATBaseUnknown#Release]. An HRESULT value.
Legal values:

E_INVALIDARG: output pointer is NOT NULL
S_OK: operation is successful
E_FAIL: operation failed

o GetRelatedObject

public virtual GetRelatedObject( opListObject)

Gets the related object in term of insulation, HVAC part with Hole port and support.

Parameters:

opListObject: A list of related object to Duct [out, CATLISTP(CATBaseUnknown) #Release].

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: output pointer is NOT NULL
E_FAIL: operation failed

o GetSpool

public virtual GetSpool( opISpoolInstance)

Finds the Spool of current duct if any.

Parameters:

opISpoolInstance[out,: CATIHvaSpoolInstance#Release]. Interface pointer on spool occurence Can be NULL if current duct is not in any spool .

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
S_FALSE: Operation is successful, but current duct is not in any spool.
E_INVALIDARG: The input argument opISpoolInstance is not NULL
E_FAIL: Otherwise

o ListGeometricalBranch

public virtual ListGeometricalBranch(		`opListDuct`,
		`opListCurvilinearLength`)

Gets the list of all geometrical branch.

Parameters:

opListPorts: List of all Ducts that it is connected on main Duct by geometrical connection. [out, CATLISTP(CATBaseUnknown)]
opListCurvilinearLength: List of curvilinear position of secondary Duct on main Duct curve. This list has the same size of opListPorts. There is a mapping where same index is same port. [out, CATListOfDouble]

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_INVALIDARG: output list pointer is NOT NULL and/or the other output list is not empty
E_FAIL: operation failed

This object is included in the file: CATIHvaDuctInstance.h
If needed, your Imakefile.mk should include the module: CATHvacDesignUseItf