CATHvacDesignUseItf Interface CATIHvaEquipmentReference

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

interface CATIHvaEquipmentReference

Interface to access Equipment Reference.
Role: Access Equipment Reference.
This interface is implemented by Equipment VPMReference.

Method Index

o CreatePort(CATMathPoint&,CATMathVector&,CATMathVector&,CATIHvaHvacPortRef::CATHvaGeomPortTypeEnum&,CATUnicodeString&,CATIHvaHvacPortRef*&,CATMathPoint*): Create a Hvac Port on a Equipment
o GetSubType(CATUnicodeString&): Retrieves the sub type Part of an Equipement.
o ListPorts(CATLISTPOfCATIHvaHvacPortRef&): Retrieves the list of Hvac Ports.

o CreatePort

public virtual HRESULT CreatePort(	const CATMathPoint&	`iOriginPoint`,
	const CATMathVector&	`iAlignmentDirection`,
	const CATMathVector&	`iOrientationDirection`,
	const CATIHvaHvacPortRef::CATHvaGeomPortTypeEnum&	`iPortType`,
	const CATUnicodeString&	`iuPortName`,
	CATIHvaHvacPortRef*&	`opIHvaHvacPortRef`,
	CATMathPoint*	`ipOffsetPoint`	`=NULL` )= 0

Create a Hvac Port on a Equipment

Parameters:

iOriginPoint: [in, CATMathPoint]. Origin of a Hvac Port
iAlignmentDirection: [in, CATMathVector]. Alignment Direction - X Axis
iOrientationDirection: [in, CATMathVector]. Orientation Direction - Z Axis
iPortType: [in, CATHvaGeomPortTypeEnum]. Port Type
iuPortName: [in, CATUnicodeString] Port Name. It should be a unique name for a port, not used for existing ports on the Equipment.
opIHvaHvacPortRef: [out, CATIHvaHvacPortRef#Release] Created Port.
ipOffsetPoint: [in, optional] Pointer to Offset Point in case of "2 Pt Part Port" or "2 Pt Hole Port". In this case, input iAlignmentDirection is NOT taken into considerderation.

Returns:

An HRESULT value.
Legal values:

S_OK: operation is successful
E_FAIL: operation failed
E_INVALIDARG: Either Alignment and Orienation vectors are not orthogonal or the input name for port is already used.

o GetSubType

public virtual HRESULT GetSubType( CATUnicodeString& oSubType) = 0

Retrieves the sub type Part of an Equipement.
Role: Retrieves the sub type Part of an Equipement.

Parameters:

Returns:

An HRESULT value.
Legal values:

o ListPorts

public virtual HRESULT ListPorts( CATLISTPOfCATIHvaHvacPortRef& oLptrPort) = 0

Retrieves the list of Hvac Ports.
Role: Retrieves the list of Hvac Ports.

Parameters:

oLptrPort: List of all ports of this object. Each pointer of the list has to be released.

Returns:

An HRESULT value.
Legal values:

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