All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchCompConnector

System.IUnknown
  |
  +---CATISchCompConnector
 

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


interface CATISchCompConnector

Interface to mangage Schematic object ability to make connections.
Role: To add or remove connectors.


Method Index


o AddConnector(char*,CATISchGRRComp*,double*,CATISchAppConnector**)
Add a connector.
o AddDynamicConnector(char*,CATISchGRRComp*,double*,CATISchAppConnector**)
Add a dynamic connector.
o RemoveConnector(CATISchGRRComp*,CATISchAppConnector*)
Remove a connector.

Methods


o AddConnector
public virtual HRESULT AddConnector( const char* iClassType,
CATISchGRRComp* iGRR,
double* iDb2CntrPosition,
CATISchAppConnector** oNewSchCntr) = 0
Add a connector.
Parameters:
iClassType
Class type of the connector to be added.
iGRR
The graphical image of the component to add the connector to. If NULL, connector will be added to all representations.
iDb2CntrPosition
The position of the connector (optional, it could be NULL).
oNewSchCntr
The new Schematic Connector object created.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AddDynamicConnector
public virtual HRESULT AddDynamicConnector( const char* iClassType,
CATISchGRRComp* iGRR,
double* iDb2CntrPosition,
CATISchAppConnector** oNewSchCntr) = 0
Add a dynamic connector.
Parameters:
iClassType
Class type of the connector to be added.
iGRR
The graphical image of the component to add the connector to. If NULL, connector will be added to all representations.
iDb2CntrPosition
The position of the connector (optional, it could be NULL).
oNewSchCntr
The new Schematic Connector object created.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveConnector
public virtual HRESULT RemoveConnector(CATISchGRRComp* iGRR,
CATISchAppConnector* iCntrToRemove) = 0
Remove a connector.
Parameters:
iCntrToRemove
The schematic connector object to be removed
iGRR
The graphical image of the component to remove the connector from. If NULL, connector will be removed from all representations.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchCompConnector.h

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