All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

SchAppConnector (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---SchAppConnector
 


Manage a schematic connector.

Method Index

AppConnect
Connect to an input connector.
AppConnectBranch
Connect to an input connector for Branch.
AppDisconnect
Disconnect from an input connector.
AppGetAssociatedConnectable
Find the application object that owns this connector.
AppIsCntrConnected
Query whether the connector has been connected.
AppListCompatibleTypes
Find all the class types of connector that are compatible with this connector for connections.
AppListConnections
Find all the connections that include this connector.
AppOKToNoShowConnectedCntr
Query whether it is OK to no show the connector after it is connected.

Methods


o Func AppConnect(CATIASchAppConnector iCntrToConnect) As CATIASchAppConnection
Connect to an input connector.
Parameters:
iCntrToConnect
A schematic connector object to connect to
oConnection
Connection created
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchAppConnector
 Dim objArg2 As SchAppConnection
  ...
 Set objArg2 = objThisIntf.AppConnect(objArg1)
 
o Func AppConnectBranch(CATIASchAppConnector iCntrToConnect) As CATIASchAppConnection
Connect to an input connector for Branch.
Parameters:
iCntrToConnect
A schematic connector object to connect to
oConnection
Connection created
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchAppConnector
 Dim objArg2 As SchAppConnection
  ...
 Set objArg2 = objThisIntf.AppConnectBranch(objArg1)
 
o Sub AppDisconnect(CATIASchAppConnector iCntrToDisConnect)
Disconnect from an input connector.
Parameters:
iCntrToDisconnect
A schematic connector object to disconnect from
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchAppConnector
  ...
 objThisIntf.AppDisconnectobjArg1
 
o Func AppGetAssociatedConnectable() As CATIASchAppConnectable
Find the application object that owns this connector.
Parameters:
oConnectable
An application object that the connector belongs to.
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchAppConnectable
  ...
 Set objArg1 = objThisIntf.AppGetAssociatedConnectable
 
o Sub AppIsCntrConnected(boolean oBYes)
Query whether the connector has been connected.
Parameters:
oBYes
If TRUE, then it is connected
Example:
 Dim objThisIntf As SchAppConnector
 Dim bVar1 As boolean
  ...
 objThisIntf.AppIsCntrConnectedbVar1
 
o Func AppListCompatibleTypes() As CATIASchListOfBSTRs
Find all the class types of connector that are compatible with this connector for connections.
Parameters:
oLCntrCompatClassTypes
A list of all the class types of connectors that are compatible with this connector for connections.
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchListOfBSTRs
  ...
 Set objArg1 = objThisIntf.AppListCompatibleTypes
 
o Func AppListConnections(CATIASchListOfBSTRs iLCntnClassFilter) As CATIASchListOfObjects
Find all the connections that include this connector.
Parameters:
oLCntnClassFilter
A list of all the class types for filtering the output connection list.
oLConnections
A list of connections that include this connector (members are CATISchAppConnection interface pointers).
Example:
 Dim objThisIntf As SchAppConnector
 Dim objArg1 As SchListOfBSTRs
 Dim objArg2 As SchListOfObjects
  ...
 Set objArg2 = objThisIntf.AppListConnections(objArg1)
 
o Sub AppOKToNoShowConnectedCntr(boolean oBYes)
Query whether it is OK to no show the connector after it is connected.
Parameters:
oBYes
If TRUE, then it is OK to no show.
Example:
 Dim objThisIntf As SchAppConnector
 Dim bVar1 As boolean
  ...
 objThisIntf.AppOKToNoShowConnectedCntrbVar1
 

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