pycatia.cat_plant_ship_interfaces.psp_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_plant_ship_interfaces.psp_connector.PSPConnector(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
PspConnector

Represents connector object.
Role: To specify connector behaviors such as connect and
disconnect.
property attr_names: PSPListOfBSTRs

Note

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

Returns or Sets Attribute names of the connector.

Example:

Dim objThisIntf As PspConnector
Dim ojArg1 As CATIAPspListOfBSTRs
…
Set ojArg1 = objThisIntf.AttrNames
Return type:

PSPListOfBSTRs

connect(i_cntr_to_connect: PSPConnector) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Connect(PspConnector iCntrToConnect)

Connect the connector to another connector.

Parameters:

iCntrToConnect
the connector to be connected to

Example:

Dim objThisIntf As PspConnector
Dim objArg1 As PspConnector
…
objThisIntf.Connect objArg1
Parameters:

i_cntr_to_connect (PSPConnector) –

Return type:

None

property connector_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ConnectorName() As CATBSTR

Returns or sets name of the connector.

Example:

Dim objThisIntf As PspConnector
Dim strVar1 As CATBSTR
…
Set strVar1 = objThisIntf.Name
Dim strVar1 As CATBSTR
…
objThisIntf.ConnectorName = strVar2
Return type:

str

disconnect(i_cntr_to_disconnect: PSPConnector) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Disconnect(PspConnector iCntrToDisconnect)

DisConnect the connector from another connector.

Parameters:

iCntrToDisconnect
The connector to be disconnected from

Example:

Dim objThisIntf As PspConnector
Dim objArg1 As PspConnector
…
objThisIntf.Disconnect objArg1
Parameters:

i_cntr_to_disconnect (PSPConnector) –

Return type:

None

get_associated_connectable() → PSPConnectable

Note

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

Get the connectable-owner of this connector.

Parameters:

oConnectable
Connectable owner of this connector

Example:

Dim objThisIntf As PspConnector
Dim objArg1 As CATIAPspConnectable
…
Set objArg1 = objThisIntf.GetAssociatedConnectable
Return type:

PSPConnectable

is_cntr_connected() → bool

Note

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

Query whether the connector has been connected.

Returns:
TRUE if this connector is connected.

Example:

Dim objThisIntf As PspConnector
Dim bArg1 As boolean
…
bArg1 = objThisIntf.IsCntrConnected
Return type:

bool