All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPlantShipInterfaces Interface CATIPspPartConnector
System.IUnknown
|
+---CATIPspPartConnector
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPspPartConnector
Interface to manage the technological data on connectors.
Role: To access the technological data on connectors.
Method Index
- o
GetAlignType(CATPspPartConnectorTypeEnum&)
- Retrieve the alignment type for this connector.
- o
GetAlignmentConnector(IUnknown**)
- Get alignment connector.
- o
GetAlignmentDirection(CATIMovable*,CATMathDirection&)
- Retrieve the CATMathDirection of outward normal to the face place position
associated with this connector.
- o
GetClockType(CATPspPartConnectorTypeEnum&)
- Retrieve the clocking type (how symmetric this end is) for this connector.
- o
GetConnectorMathPlane(CATIMovable*,CATMathPlane&)
- Retrieve the CATMathPlane that contains the connector position (plane origin),
alignment direction (plane z-axis), and the up direction (plane y-axis).
- o
GetConnectorNumber(int&)
- Get connector number.
- o
GetDatumConnector(IUnknown**)
- Get datum connector.
- o
GetFaceConnector(IUnknown**)
- Get face connector.
- o
GetFaceType(CATPspPartConnectorTypeEnum&)
- Retrieve the face type (normal or "transparent" support) for this connector.
- o
GetOrientationConnector(IUnknown**)
- Get orientation connector.
- o
GetPosition(CATIMovable*,CATMathPoint&)
- Retrieve the CATMathPoint of the position associated with this connector.
- o
GetUpDirection(CATIMovable*,CATMathDirection&)
- Retrieve the CATMathDirection of the upward normal to the up plane
associated with this connector.
- o
ListAttrNames(CATListValCATUnicodeString*&)
- Returns a list of attribute names associated to this connector.
- o
SetAlignmentConnector(IUnknown*,CATPspPartConnectorTypeEnum)
- Set the alignment connector.
- o
SetAttrNames(CATListValCATUnicodeString*)
- Set a list of attribute names associated to this connector.
- o
SetDatumConnector(IUnknown*)
- Set the datum connector.
- o
SetFaceConnector(IUnknown*,CATPspPartConnectorTypeEnum)
- Set the face connector.
- o
SetOrientationConnector(IUnknown*,CATPspPartConnectorTypeEnum)
- Set the orientation connector.
Methods
o GetAlignType
-
Retrieve the alignment type for this connector.
- Parameters:
-
- oAlignType
- The alignment type.
- See also:
- CATPspPartConnectorTypeEnum
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetAlignmentConnector
-
Get alignment connector.
- Parameters:
-
- oConnector
- [out, IUnknown#Release] Alignment connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetAlignmentDirection
-
Retrieve the CATMathDirection of outward normal to the face place position
associated with this connector.
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- oAlignmentDirection
- The align direction as a CATMathDirection.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetClockType
-
Retrieve the clocking type (how symmetric this end is) for this connector.
- Parameters:
-
- oClockType
- The clock type.
- See also:
- CATPspPartConnectorTypeEnum
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetConnectorMathPlane
-
Retrieve the CATMathPlane that contains the connector position (plane origin),
alignment direction (plane z-axis), and the up direction (plane y-axis).
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- oMathPlane
- The connector face plane.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetConnectorNumber
public virtual HRESULT GetConnectorNumber( | int& | oCtrNumber) = 0 |
-
Get connector number.
- Parameters:
-
- oCtrNumber
- Connector number on this connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetDatumConnector
-
Get datum connector.
- Parameters:
-
- oConnector
- [out, IUnknown#Release] Datum connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetFaceConnector
-
Get face connector.
- Parameters:
-
- oConnector
- [out, IUnknown#Release] Face connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetFaceType
-
Retrieve the face type (normal or "transparent" support) for this connector.
- Parameters:
-
- oFaceType
- The face type.
- See also:
- CATPspPartConnectorTypeEnum
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetOrientationConnector
-
Get orientation connector.
- Parameters:
-
- oConnector
- [out, IUnknown#Release] Orientation connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetPosition
-
Retrieve the CATMathPoint of the position associated with this connector.
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- oPosition
- The position as CATMathPoint.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetUpDirection
-
Retrieve the CATMathDirection of the upward normal to the up plane
associated with this connector.
- Parameters:
-
- iRelAxis
- The relative axis object (NULL means relative to parent).
- oUpDirection
- The up direction as CATMathDirection.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListAttrNames
-
Returns a list of attribute names associated to this connector.
- Parameters:
-
- opListOfAttrNames
- List of attribute names associated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetAlignmentConnector
-
Set the alignment connector.
- Parameters:
-
- iConnector
- The new sub-alignment connector.
- iEAlignType
- The new alignment connector type.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetAttrNames
-
Set a list of attribute names associated to this connector.
- Parameters:
-
- opListOfAttrNames
- List of attribute names associated.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetDatumConnector
-
Set the datum connector.
- Parameters:
-
- iConnector
- The new sub-datum connector.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetFaceConnector
-
Set the face connector.
- Parameters:
-
- iConnector
- The new sub-Face connector.
- iEFaceType
- The new Face connector type.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetOrientationConnector
-
Set the orientation connector.
- Parameters:
-
- iConnector
- The new sub-orientation connector.
- iEClockType
- The new orientation connector clock type.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIPspPartConnector.h