All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Interface CATIPspConnector

System.IUnknown
  |
  +---CATIPspConnector
 

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


interface CATIPspConnector

Interface to manage connector object behaviors.
Role: To specify connector behaviors such as connect and disconnect.


Method Index


o Connect(char*,CATIPspConnector*,CATIPspConnection**)
Connect to an input connector.
o Disconnect(CATIPspConnector*)
Disconnect from an input connector.
o GetAssociatedConnectable(CATIPspConnectable**)
Find the object that owns this connector.
o GetConnectorNumber(int&)
Get connector number.
o GetName(CATUnicodeString&)
Get the connector display name.
o GetValidConnection(CATIPspConnector*,CATUnicodeString&)
Get the connection class type for this connector and the input connector.
o IsCntrConnected(CATBoolean*)
Query whether the connector has been connected.
o ListAttrNames(CATListValCATUnicodeString*&)
Returns a list of attribute names associated to this connector.
o ListConnectedCntrs(CATIPspConnection*,CATIUnknownList**)
Find connectors connected to this connector in the input connection.
o ListConnections(CATICStringList*,CATIUnknownList**)
Find all the connections that include this connector.
o SetAttrNames(CATListValCATUnicodeString*)
Set a list of attribute names associated to this connector.
o SetName(CATUnicodeString&)
Set the connector display name.

Methods


o Connect
public virtual HRESULT Connect( const char* iClassType,
CATIPspConnector* iCntrToConnect,
CATIPspConnection** oConnection) = 0
Connect to an input connector.
Parameters:
iClassType
A connection class type.
iCntrToConnect
A connector object to connect to
oConnection
[out, IUnknown#Release] Connection created
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Disconnect
public virtual HRESULT Disconnect(CATIPspConnector* iCntrToDisConnect) = 0
Disconnect from an input connector.
Parameters:
iCntrToDisconnect
A connector object to disconnect from
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetAssociatedConnectable
public virtual HRESULT GetAssociatedConnectable(CATIPspConnectable** oConnectable) = 0
Find the object that owns this connector.
Parameters:
oConnectable
[out, IUnknown#Release] An object that the connector belongs to.
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 GetName
public virtual HRESULT GetName(CATUnicodeString& oConnectorName) = 0
Get the connector display name.
Parameters:
oConnectorName
A connector name
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetValidConnection
public virtual HRESULT GetValidConnection( const CATIPspConnector* iCntrToConnect,
CATUnicodeString& oCnxClassType) = 0
Get the connection class type for this connector and the input connector.
Parameters:
iCntrToConnect
A connector object to connect to
oCnxClassType
Valid connection class type
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o IsCntrConnected
public virtual HRESULT IsCntrConnected(CATBoolean* oBYes) = 0
Query whether the connector has been connected.
Parameters:
oBYes
If TRUE, then it is connected
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 to the connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectedCntrs
public virtual HRESULT ListConnectedCntrs( const CATIPspConnection* iConnection,
CATIUnknownList** oLConnectedCntrs) = 0
Find connectors connected to this connector in the input connection.
Parameters:
iConnection
Connection used for finding the connected connectors.
oLConnectedCntrs
[out, IUnknown#Release] A list of connectors connected to this connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnections
public virtual HRESULT ListConnections(CATICStringList* iLCntnClassFilter,
CATIUnknownList** oLConnections) = 0
Find all the connections that include this connector.
Parameters:
iLCntnClassFilter
A list of all the class types for filtering the output connection list.
oLConnections
[out, IUnknown#Release] A list of connections that include this connector (members are CATIPspConnection interface pointers).
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 to the connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iConnectorName) = 0
Set the connector display name.
Parameters:
iConnectorName
A connector name
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIPspConnector.h

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