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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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
-
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