CATPipeTubeDesignUseItf Interface CATIPipPartReference
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPipPartReference
Method Index
- o
CreatePort(CATMathPoint&,CATMathVector&,CATMathVector&,CATIPipPipingPortRef::CATPipGeomPortTypeEnum&,CATUnicodeString&,CATIPipPipingPortRef*&,CATMathPoint*)
- Create a Piping Port on a Part
- o
GetSubTypePart(CATUnicodeString&)
- Gets the sub type Part of Piping Part.
- o
ListPorts(CATLISTP(CATIPipPipingPortRef)&)
- Gets the list of all the Ports.
Methods
o CreatePort
| public virtual CreatePort( | const | iOriginPoint, |
| const | iAlignmentDirection, |
| const | iOrientationDirection, |
| const | iPortType, |
| const | iuPortName, |
| | opIPipPipingPortRef, |
| | ipOffsetPoint | =NULL ) |
-
Create a Piping Port on a Part
- Parameters:
-
- iOriginPoint
- [in, CATMathPoint]. Origin of a Piping Port
- iAlignmentDirection
- [in, CATMathVector]. Alignment Direction - X Axis
- iOrientationDirection
- [in, CATMathVector]. Orientation Direction - Z Axis
- iPortType
- [in, CATPipGeomPortTypeEnum]. Port Type
- iuPortName
- [in, CATUnicodeString] Port Name. It should be a unique name for a port, not used for existing ports on the Part.
- opIPipPipingPortRef
- [out, CATIPipPipingPortRef#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 GetSubTypePart
| public virtual GetSubTypePart( | | ouSubTypePart) |
-
Gets the sub type Part of Piping Part.
- Parameters:
-
- ouSubTypePart
- The sub part type [out, CATUnicodeString].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListPorts
| public virtual ListPorts( | | oListPorts) |
-
Gets the list of all the Ports.
- Parameters:
-
- oListPorts
- List of all ports of this object [out, CATLISTP(CATIPipPipingPortRef)].
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPipPartReference.h
If needed, your Imakefile.mk should include the module: CATPipeTubeDesignUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.