pycatia.cat_sch_platform_interfaces.sch_app_connection

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_sch_platform_interfaces.sch_app_connection.SchAppConnection(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
SchAppConnection

Manage a schematic connection.
app_add_connector(i_cntr_to_add: SchAppConnector) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppAddConnector(SchAppConnector iCntrToAdd)

Add a connector.

Parameters:

iCntrToAdd
The Application Connector to be added to the connection


Example:



Dim objThisIntf As SchAppConnection
Dim objArg1 As SchAppConnector
…
objThisIntf.AppAddConnectorobjArg1
Parameters:

i_cntr_to_add (SchAppConnector) –

Return type:

None

app_list_connectables(i_l_cntble_class_filter: SchListOfBSTRs, o_l_cntbles: SchListOfObjects, o_l_cntrs: SchListOfObjects) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppListConnectables(SchListOfBSTRs
iLCntbleClassFilter,
SchListOfObjects oLCntbles,
SchListOfObjects oLCntrs)

Find all the application object connected to this connection through their
connectors.

Parameters:

oLCntrClassFilter
A list of all the class types for filtering the output application
objects list.
oLCntbles
A list of application objects connected to this connection.
(members are CATISchAppConnectable interface pointers).

oLCntrs
A list of connectors through which this connection is made.
(members are CATISchAppConnector interface pointers).


Example:



Dim objThisIntf As SchAppConnection
Dim objArg1 As SchListOfBSTRs
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchListOfObjects
…

objThisIntf.AppListConnectablesobjArg1,objArg2,objArg3
Parameters:
Return type:

None

app_list_connectors(i_l_cntr_class_filter: SchListOfBSTRs) → SchListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AppListConnectors(SchListOfBSTRs iLCntrClassFilter) As
SchListOfObjects

Find all the connectors included in this connection.

Parameters:

oLCntrClassFilter
A list of all the class types for filtering the output connector
list.
oLCntrs
A list of connectors included in this connection. (members are
CATISchAppConnector interface pointers).

Example:



Dim objThisIntf As SchAppConnection
Dim objArg1 As SchListOfBSTRs
Dim objArg2 As SchListOfObjects
…
Set objArg2 = objThisIntf.AppListConnectors(objArg1)
Parameters:

i_l_cntr_class_filter (SchListOfBSTRs) –

Return type:

SchListOfObjects

app_remove_connector(i_cntr_to_remove: SchAppConnector) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppRemoveConnector(SchAppConnector iCntrToRemove)

Remove a connector.

Parameters:

iCntrToRemove
The Application Connector to be removed

Example:



Dim objThisIntf As SchAppConnection
Dim objArg1 As SchAppConnector
…
objThisIntf.AppRemoveConnectorobjArg1
Parameters:

i_cntr_to_remove (SchAppConnector) –

Return type:

None