All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Interface CATIPspDefinePhysicalPart
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspDefinePhysicalPart
Interface to get the information required for part placement.
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. This interface give the information required for part placement.
Method Index
- o
GetPartNumbers(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,IUnknown*,CATListOfCATUnicodeString&)
-
- GetPartNumbers:
Get part numbers from the specification catalog that match input data.
- o
SetSpecification(IUnknown*,CATUnicodeString&)
- Set spec on instance part.
Methods
- o GetPartNumbers
-
| public virtual GetPartNumbers( | const | iuStandard, |
| const | iuPartType, |
| const | iuSpecName, |
| const | ipiLogicalLine, |
| | oListPartNumbers) |
-
- GetPartNumbers:
Get part numbers from the specification catalog that match input data.
- Parameters:
-
- iuStandard
- [in] Standard for application attribute values.
- iuPartType
- [in] Type of part desired.
- iuSpecName
- [in] Specification name
- ipiLogicalLine
- [in] Logical line (e.g. piping line)
- oListPartNumbers
- [out] Returned list of part numbers (options) when part number (option) choice is needed.
An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
- E_NOTIMPL
- Not applicable
- o SetSpecification
-
| public virtual SetSpecification( | const | ipiPlacedInstancePart, |
| const | iuSpec) |
-
Set spec on instance part.
Role: Interactively, the user can perform spec-driven part placement.
The CAA part placement interfaces performs un-spec placement.
This method turns a non-spec instance part into a spec part.
- Parameters:
-
- ipiPlacedInstancePart
- [in] The placed instance part on which to set the spec.
- iuSpec
- [in] The spec name to set on the instance part. Must be non-blank
- Returns:
- HRESULT
- S_OK: Spec successfully set on part.
- E_FAIL: Part already has spec defined or can not set spec on part
- E_INVALIDARG: Invalid input.
- E_NOTIMPL: Not applicable, part is a non-spec part
This object is included in the file: CATIPspDefinePhysicalPart.h