pycatia.cat_sch_platform_interfaces.sch_app_connector

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_connector.SchAppConnector(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

SchAppConnector

Manage a schematic connector.

app_connect(i_cntr_to_connect: SchAppConnector) → SchAppConnection

Note

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

o Func AppConnect(SchAppConnector iCntrToConnect) As

SchAppConnection

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)

Parameters:

i_cntr_to_connect (SchAppConnector) –

Return type:

SchAppConnection

app_connect_branch(i_cntr_to_connect: SchAppConnector) → SchAppConnection

Note

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

o Func AppConnectBranch(SchAppConnector iCntrToConnect) As

SchAppConnection

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)

Parameters:

i_cntr_to_connect (SchAppConnector) –

Return type:

SchAppConnection

app_disconnect(i_cntr_to_dis_connect: SchAppConnector) → None

Note

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

o Sub AppDisconnect(SchAppConnector 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

Parameters:

i_cntr_to_dis_connect (SchAppConnector) –

Return type:

None

app_get_associated_connectable() → SchAppConnectable

Note

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

o Func AppGetAssociatedConnectable() As SchAppConnectable

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

Return type:

SchAppConnectable

app_is_cntr_connected(o_b_yes: bool) → None

Note

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

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

Parameters:

o_b_yes (bool) –

Return type:

None

app_list_compatible_types() → SchListOfBSTRs

Note

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

o Func AppListCompatibleTypes() As SchListOfBSTRs

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

Return type:

SchListOfBSTRs

app_list_connections(i_l_cntn_class_filter: SchListOfBSTRs) → SchListOfObjects

Note

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

o Func AppListConnections(SchListOfBSTRs iLCntnClassFilter) As

SchListOfObjects

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)

Parameters:

i_l_cntn_class_filter (SchListOfBSTRs) –

Return type:

SchListOfObjects

app_ok_to_no_show_connected_cntr(o_b_yes: bool) → None

Note

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

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

Parameters:

o_b_yes (bool) –

Return type:

None