pycatia.cat_sch_platform_interfaces.sch_app_connectable

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_connectable.SchAppConnectable(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
SchAppConnectable

Represents an application object that can be connected to
others.
app_add_connector(i_class_type: str, o_new_app_cntr: SchAppConnector) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppAddConnector(CATBSTR iClassType,
SchAppConnector oNewAppCntr)

Add a connector.

Parameters:

iClassType
Class type of the connector to be added.
oNewAppCntr
The new Application Connector object created.

Example:



Dim objThisIntf As SchAppConnectable
Dim strVar1 As String
Dim objArg2 As SchAppConnector
…
objThisIntf.AppAddConnectorstrVar1,objArg2
Parameters:
Return type:

None

app_get_reference_name(o_reference_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppGetReferenceName(CATBSTR oReferenceName)

Get the reference name of a connectable. It will be displayed in
catalogs.

Parameters:

oReferenceName
The name of the reference

Example:



Dim objThisIntf As SchAppConnectable
Dim strVar1 As String
…
objThisIntf.AppGetReferenceNamestrVar1
Parameters:

o_reference_name (str) –

Return type:

None

app_list_connectables(i_l_cntble_class_filter: SchListOfBSTRs, o_l_cntbles: SchListOfObjects, o_l_cntrs_on_this_obj: SchListOfObjects, o_l_cntrs_on_connected: SchListOfObjects) → None

Note

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

Find all the application objects connected to this object 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 object. (members
are CATISchAppConnectable interface pointers).
oLCntrsOnThisObj
A list of connectors on this object through which the connection is
made. (members are CATISchAppConnector interface pointers).

oLCntrsOnConnected
A list of connectors on the connected objects through which the
connection is made. (members are CATISchAppConnector interface pointers).
Members in this list corresponds to those in oLCntrsOnThisObj in making the
corresponding connections.

Example:



Dim objThisIntf As SchAppConnectable
Dim objArg1 As SchListOfBSTRs
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchListOfObjects
Dim objArg4 As SchListOfObjects
…
objThisIntf.AppListConnectablesobjArg1,objArg2,objArg3,objArg4
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 of this application object.

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 SchAppConnectable
Dim objArg1 As SchListOfBSTRs
Dim objArg2 As SchListOfObjects
…
Set objArg2 = objThisIntf.AppListConnectors(objArg1)
Parameters:

i_l_cntr_class_filter (SchListOfBSTRs) –

Return type:

SchListOfObjects

app_list_valid_cntr_types() → SchListOfBSTRs

Note

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

List the valid application connector types allowed to be
created.

Parameters:

oLValidCntrTypes
A list of connector class types allowed.

Example:



Dim objThisIntf As SchAppConnectable
Dim objArg1 As SchListOfBSTRs
…
Set objArg1 = objThisIntf.AppListValidCntrTypes
Return type:

SchListOfBSTRs

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 object to be removed

Example:



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

i_cntr_to_remove (SchAppConnector) –

Return type:

None

app_set_reference_name(i_reference_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppSetReferenceName(CATBSTR iReferenceName)

Set the reference name of a connectable. It will be displayed in
catalogs.

Parameters:

iReferenceName
The name of the reference

Example:



Dim objThisIntf As SchAppConnectable
Dim strVar1 As String
…
objThisIntf.AppSetReferenceNamestrVar1
Parameters:

i_reference_name (str) –

Return type:

None