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
public virtual HRESULT GetAlignType(CATPspPartConnectorTypeEnum& oAlignType) = 0
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
public virtual HRESULT GetAlignmentConnector(IUnknown** oConnector) = 0
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
public virtual HRESULT GetAlignmentDirection( const CATIMovable* iRelAxis,
CATMathDirection& oAlignmentDirection) = 0
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
public virtual HRESULT GetClockType(CATPspPartConnectorTypeEnum& oClockType) = 0
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
public virtual HRESULT GetConnectorMathPlane( const CATIMovable* iRelAxis,
CATMathPlane& oMathPlane) = 0
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
public virtual HRESULT GetDatumConnector(IUnknown** oConnector) = 0
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
public virtual HRESULT GetFaceConnector(IUnknown** oConnector) = 0
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
public virtual HRESULT GetFaceType(CATPspPartConnectorTypeEnum& oFaceType) = 0
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
public virtual HRESULT GetOrientationConnector(IUnknown** oConnector) = 0
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
public virtual HRESULT GetPosition( const CATIMovable* iRelAxis,
CATMathPoint& oPosition) = 0
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
public virtual HRESULT GetUpDirection( const CATIMovable* iRelAxis,
CATMathDirection& oUpDirection) = 0
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
public virtual HRESULT ListAttrNames(CATListValCATUnicodeString*& opListOfAttrNames)= 0
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
public virtual HRESULT SetAlignmentConnector(IUnknown* iConnector,
CATPspPartConnectorTypeEnum iEAlignType) = 0
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
public virtual HRESULT SetAttrNames( const CATListValCATUnicodeString* ipListOfAttrNames)= 0
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
public virtual HRESULT SetDatumConnector(IUnknown* iConnector) = 0
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
public virtual HRESULT SetFaceConnector(IUnknown* iConnector,
CATPspPartConnectorTypeEnum iEFaceType) = 0
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
public virtual HRESULT SetOrientationConnector(IUnknown* iConnector,
CATPspPartConnectorTypeEnum iEClockType) = 0
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

Copyright © 2003, Dassault Systèmes. All rights reserved.