pycatia.cat_plant_ship_interfaces.psp_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_plant_ship_interfaces.psp_connectable.PSPConnectable(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
PspConnectable

Represents an Interface to manage object behaviors in making
connections.
Role: To specify object behaviors such as adding a connector and removing a
connector.
property connectors: PSPListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Connectors() As PspListOfObjects (Read Only)

Returns a list of connectors of the object.

Example:

Dim objThisIntf As PspConnectable
Dim objArg1 As CatPspIDLDomainID
Dim objArg2 As PspListOfBSTRs
…
Set objArg2 = objThisIntf.Connectors
Return type:

PSPListOfObjects

get_connector_by_name(iu_connector_name: str) → PSPConnector

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetConnectorByName(CATBSTR iuConnectorName) As
PspConnector

Retrieves a connector with the given name.

Parameters:

iConnectorName
Connector name to look for.

Returns:
Connector with given name.

Example:

Dim objThisIntf As PspConnectable
Dim strVar1 As PspListOfBSTRs
Dim objArg2 As PspConnector
…
Set objArg2 = objThisIntf.GetConnectorByName (strVar1)
Parameters:

iu_connector_name (str) –

Return type:

PSPConnector

list_connectables(iu_class_filter: PSPListOfBSTRs, o_l_cntbles: PSPListOfObjects, o_l_cntrs_on_this_obj: PSPListOfObjects, o_l_cntrs_on_connected: PSPListOfObjects) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListConnectables(PspListOfBSTRs iuClassFilter,
PspListOfObjects oLCntbles,
PspListOfObjects oLCntrsOnThisObj,
PspListOfObjects oLCntrsOnConnected)

Retrieve a list of connectors of the object.

Parameters:

iuClassFilter
Class filter list. If iuClassFilter is an empty list then it will
get connectors for all the application connector types.

oLCntbles
a list of CATIAPspConnectable objects that connect this object

oLCntrsOnThisObj
a list of connectors on “this” object in the connections ( A list
of CATIAPspConnector)
oLCntrsOnConnected
a list of connectors on the other objects that the member of the
former list is connected to (positions in oLCntrsOnThisObj and
oLCntrsOnConnected corresponds to each other) ( A list of CATIAPspConnector)

Example:

Dim objThisIntf As PspConnectable
Dim objArg1 As PspListOfBSTRs
Dim objArg2 As PspListofObjects
Dim objArg3 As PspListofObjects
Dim objArg4 As PspListofObjects
…
objThisIntf.ListConnectables
objArg1,objArg2,objArg3,objArg4
Parameters:
Return type:

None

property valid_connector_types: PSPListOfBSTRs

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ValidConnectorTypes() As PspListOfBSTRs (Read
Only)

Returns a list of Valid connector types on this object.

Example:

Dim objThisIntf As PspConnectable
Dim objArg1 As PspListOfBSTRs
…
Set objArg1 = objThisIntf.ValidConnectorTypes
Return type:

PSPListOfBSTRs