All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspPhysicalProduct

System.IUnknown
  |
  +---CATIPspPhysicalProduct
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIPspPhysicalProduct

Interface to manage the technological connectors on physical objects.
Role: To manage connectors on physical objects.


Method Index


o AddConnector(char*,int,IUnknown*,CATPspPartConnectorTypeEnum,IUnknown*,CATPspPartConnectorTypeEnum,IUnknown*,CATPspPartConnectorTypeEnum,CATIPspPartConnector**)
Add a connector.
o GetNumberOfConnectors(int&)
Get the number of connectors on this object.
o ListConnectors(char*,CATIUnknownList**)
Find all the connectors of this object.
o RemoveConnector(int)
Remove a connector.

Methods


o AddConnector
public virtual HRESULT AddConnector( const char* iTechCtrClassType,
int iCtrNumber,
IUnknown* iFaceConnector,
CATPspPartConnectorTypeEnum iEFaceType,
IUnknown* iAlignConnector,
CATPspPartConnectorTypeEnum iEAlignType,
IUnknown* iOrientationConnector,
CATPspPartConnectorTypeEnum iEClockType,
CATIPspPartConnector** oTechConnector) = 0
Add a connector.
Parameters:
iTechCtrClassType
Class type of the connector to be added.
iCtrNumber
Connector number.
iFaceConnector
Face connector.
iEFaceType
Connector face type to be set.
See also:
CATPspPartConnectorTypeEnum
iAlignConnector
Alignment connector.
iEAlignType
Connector alignment type to be set.
See also:
CATPspPartConnectorTypeEnum
iOrientationConnector
Orientation connector.
iEClockType
Connector orientation type to be set.
See also:
CATPspPartConnectorTypeEnum
oTechConnector
[out, IUnknown#Release] The new technological connector object created.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetNumberOfConnectors
public virtual HRESULT GetNumberOfConnectors(int& oNumOfCtrs) = 0
Get the number of connectors on this object.
Parameters:
oNumOfCtrs
Number of connectors on object.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectors
public virtual HRESULT ListConnectors(char* iTechCtrClassTypeFilter,
CATIUnknownList** oListOfTechConnectors) = 0
Find all the connectors of this object.
Parameters:
iTechCtrClassTypeFilter
Technological connector class types for filtering the output connector list.
oListOfTechConnectors
[out, IUnknown#Release] A list of technological connectors on this object. (members are CATIPspPartConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveConnector
public virtual HRESULT RemoveConnector(int iCtrNumber) = 0
Remove a connector.
Parameters:
iCtrNumber
The connector number of connector to be removed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspPhysicalProduct.h

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