All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspConnectable

System.IUnknown
  |
  +---CATIPspConnectable
 

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


interface CATIPspConnectable

Interface to manage object behaviors in making connections.
Role: To specify object behaviors such as adding a connector and removing a connector.


Method Index


o GetConnector(CATUnicodeString&,CATIPspConnector**)
Find a connector with the given name.
o ListConnectables(CATICStringList*,CATICStringList*,CATICStringList*,CATIUnknownList**,CATIUnknownList**,CATIUnknownList**)
Find all the objects connected to this object through their connectors subject to class filters.
o ListConnectables(CATICStringList*,CATIUnknownList**,CATIUnknownList**,CATIUnknownList**)
Find all the objects connected to this object through their connectors.
o ListConnectors(CATICStringList*,CATIUnknownList**)
Find all the connectors of this object.
o ListValidCntrTypes(CATICStringList**)
List the valid application connector types allowed to be created.

Methods


o GetConnector
public virtual HRESULT GetConnector( const CATUnicodeString& iConnectorName,
CATIPspConnector** oCntr) = 0
Find a connector with the given name.
Parameters:
iConnectorName
Connector name to look for.
oCntr
[out, IUnknown#Release] Connector with given name.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectables
public virtual HRESULT ListConnectables(CATICStringList* iLCntbleClassFilter,
CATICStringList* iLCntrsClassFilter,
CATICStringList* iLCnxsClassFilter,
CATIUnknownList** oLCntbles,
CATIUnknownList** oLCntrsOnThisObj,
CATIUnknownList** oLCntrsOnConnected) = 0
Find all the objects connected to this object through their connectors subject to class filters.
Parameters:
iLCntbleClassFilter
A list of all the class types for filtering the output connectable objects list.
iLCntrsClassFilter
A list of all the class types for filtering the output connector objects list.
iLCnxsClassFilter
A list of all the class types for filtering the output other connector objects list.
oLCntbles
[out, IUnknown#Release] A list of objects connected to this object. (members are CATIPspConnectable interface pointers).
oLCntrsOnThisObj
[out, IUnknown#Release] A list of connectors on this object through which the connection is made. (members are CATIPspConnector interface pointers).
oLCntrsOnConnected
[out, IUnknown#Release] A list of connectors on the connected objects through which the connection is made. (members are CATIPspConnector interface pointers). Members in this list corresponds to those in oLCntrsOnThisObj in making the corresponding connections.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectables
public virtual HRESULT ListConnectables(CATICStringList* iLCntbleClassFilter,
CATIUnknownList** oLCntbles,
CATIUnknownList** oLCntrsOnThisObj,
CATIUnknownList** oLCntrsOnConnected) = 0
Find all the objects connected to this object through their connectors.
Parameters:
iLCntbleClassFilter
A list of all the class types for filtering the output objects list. If NULL, then no filtering is done.
oLCntbles
[out, IUnknown#Release] A list of objects connected to this object. (members are CATIPspConnectable interface pointers).
oLCntrsOnThisObj
[out, IUnknown#Release] A list of connectors on this object through which the connection is made. (members are CATIPspConnector interface pointers).
oLCntrsOnConnected
[out, IUnknown#Release] A list of connectors on the connected objects through which the connection is made. (members are CATIPspConnector interface pointers). Members in this list corresponds to those in oLCntrsOnThisObj in making the corresponding connections.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectors
public virtual HRESULT ListConnectors(CATICStringList* iLCntrClassFilter,
CATIUnknownList** oLCntrs) = 0
Find all the connectors of this object.
Parameters:
iLCntrClassFilter
A list of all the class types for filtering the output connector list.
oLCntrs
[out, IUnknown#Release] A list of connectors included in this connection. (members are CATIPspConnector interface pointers).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListValidCntrTypes
public virtual HRESULT ListValidCntrTypes(CATICStringList** oLValidCntrTypes) = 0
List the valid application connector types allowed to be created.
Parameters:
oLValidCntrTypes
[out, IUnknown#Release] A list of connector class types allowed.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspConnectable.h

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