All Frameworks Class Hierarchy This Framework Indexes
CATCommonLayoutInterfaces Interface CATICloPartRules
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICloPartRules
Interface to get the function types required to place parts.
Role: Equipment and Systems applications are used to layout 3D AEC designs.
Fluid flow routes are defined using runs. Further detail is provided by adding
parts to runs. Part placement APIs need function type information of the
part being placed. This interface give the function type information.
Method Index
- o
GetPartFunctions(IUnknown*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfInt&,CATIUnknownList*)
-
- GetPartFunctions:
Get function types for a given physical part.
Methods
- o GetPartFunctions
-
| public virtual GetPartFunctions( | const | ipiReferencePart, |
| const | iuStandard, |
| const | iuSpecName, |
| const | iuNominalSize, |
| | oListFunctions, |
| const | iSectionTypes, |
| const | ipiListParms | = NULL ) |
-
- GetPartFunctions:
Get function types for a given physical part.
- Parameters:
-
- ipiReferencePart
- [in] Physical part reference. The part type is extracted from the part.
- iuStandard
- [in] Standard for application attribute values. Must not be empty string.
- iuSpecName
- [in] Specification name
- iuNominalSize
- [in] Nominal size
- oListFunctions
- [out] Returned list of function types this part is mapped to
- iSectionTypes
- [in] For HVAC parts, list of section types. See CATRouSectionTypes.h for values.
For HVAC transition parts with different shapes, include unique section types.
- ipiListParms
- [in] For HVAC parts. List of CATICkeParms defining the section dimensions
For rectangular section provide height and width.
For round sections provide diameter
An HRESULT value.
Legal values:
- S_OK
- Function type(s) found
- E_INVALIDARG
- Invalid input argument
- E_FAIL
- CATReturnError may be returned. See Usage notes on how to handle CATReturnError
This object is included in the file: CATICloPartRules.h