All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspPlacePart
System.IUnknown
|
+---CATIPspPlacePart
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspPlacePart
Interface to place physical parts.
Role: To place physical parts.
Method Index
- o
GetErrorMessage(CATUnicodeString&)
- Retrieves the message associated with the last error.
- o
PlacePartInSpace(CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*,IUnknown*,CATUnicodeString&,CATMathDirection&,CATMathDirection&,CATMathPoint&,IUnknown*&)
- Place a part in space given its reference.
- o
RouteStringPartInSpace(CATUnicodeString&,CATUnicodeString&,IUnknown*,IUnknown*,IUnknown*,CATUnicodeString&,CATMathDirection&,CATIUnknownList*,CATListOfDouble&,IUnknown*&)
- Route a string part.
Methods
o GetErrorMessage
-
Retrieves the message associated with the last error.
Role: If an error occurs when placing or routing a part, a message
is associated with the error.
- Parameters:
-
- obErrorMessage
- The error message associated with the last error. Null if no error.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o PlacePartInSpace
-
Place a part in space given its reference.
Role: A part instance is derived from
the given reference with respect to the given parent product.
The Part Placement Engine will not perform any of it's normal
checks for interactions with nearby parts.
Part is placed non-spec.
- Parameters:
-
- iuStandard
- Standard for application attribute values.
- iuFunctionType
- Type of function (e.g. Block valve, branch). Used when no function is specified but functional part placement is required.
- ipiReferencePart
- The reference part from which to derive the instance part.
- ipiParentProduct
- The parent product (in the design model) for the new instance part.
- ipiLogicalLine
- Logical line (e.g. piping line) which contains the instance part.
- iuPlacedPartID
- Name of the placed part in the design model.
Null uses the standard ID generated by the Part Placement Engine.
- iUpDirection
- Up direction for placed part.
Value is relative to ipiParentProduct.
- iHorizontalOrientation
- Orientation of part in "horizontal" plane (plane perpendicular to up direction).
Must be perpendicular to iUpDirection.
Value is relative to ipiParentProduct.
- iPosition
- Poition of part.
Value is relative to ipiParentProduct and expressed in millimeters.
- opiInstancePart
- The placed instance part.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RouteStringPartInSpace
-
Route a string part.
Role: A string part instance, such as a pipe, a tube, or a duct, is derived from
the given reference with respect to the given parent product.
The Part Placement engine will not perform any of it's normal
checks for interactions with nearby parts.
Part is placed non-spec.
- Parameters:
-
- iuStandard
- The standard for application attribute values.
- iuFunctionType
- The type of function (e.g. Block valve, branch).
- ipiReferencePart
- The reference part from which to derive the instance part.
- ipiParentProduct
- The parent product (in the design model) for the new instance part.
- ipiLogicalLine
- The logical line (e.g. piping line) which contains the instance part.
- iuPlacedPartID
- The name of the placed part in the design model.
Null uses the standard ID generated by the part placement engine.
- iFirstPointUpDirection
- The up direction of the first point of the string part.
The list has three values which represent the x, y and z values of a unit direction vector.
Value is relative to ipiParentProduct.
- ipiListPoints
- The list of points that describe the path of the string.
If the string part is stretchable, the list should contain two points.
Points are relative ipiParentProduct and are in milimeters.
- iListBendRadii
- The list of bend radii at each corner of the string part.
This list is ignored if the string part is stretchable.
This list is only for interior points and so should have two less elements than ipiListPoints.
(for example, if ipiListPoints has six points, iListBendRadii should have four radii values).
Values are in milimeters.
- opiInstancePart
- The routed string part.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspPlacePart.h