pycatia.cat_plant_ship_interfaces.psp_phsyical_product

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_phsyical_product.PSPPhsyicalProduct(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
PspPhsyicalProduct

Represents the interface to manage the technological connectors on physical
objects.
Role: To manage connectors on physical objects.
add_connector(i_class_filter: str, i_face_cntr: Reference, ie_face_type: int, i_alignment_cntr: Reference, ie_align_type: int, i_clock_cntr: Reference, ie_clock_type: int) → PSPPartConnector

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddConnector(CATBSTR iClassFilter,
Reference iFaceCntr,
CatPspIDLPartConnectorType ieFaceType,
Reference iAlignmentCntr,
CatPspIDLPartConnectorType ieAlignType,
Reference iClockCntr,
CatPspIDLPartConnectorType ieClockType) As PspPartConnector

Returns the added connector on the object.

Parameters:

iuClassFilter
Connector class type. If null string application default connector
class will be used.
iFaceCntr
A face connector
ieFaceType
Face connector type
iAlignmentCntr
An alignment connector
ieAlignType
Alignment connector type
iClockCntr
A clock connector
ieClockType
A clock connector type

Returns:
Part connector added

Example:

Dim objThisIntf As PspPhsyicalProduct
Dim strVar1 As CATBSTR
Dim objArg2 As Reference
Dim objArg3 As catPspIDLPartConnectorType
Dim objArg4 As Reference
Dim objArg5 As catPspIDLPartConnectorType
Dim objArg6 As Reference
Dim objArg7 As catPspIDLPartConnectorType
Dim objArg8 As PspPartConnector
…
objArg8 = objThisIntf.AddConnector (strVar1, objArg2,objArg3,objArg4, objArg5,objArg6,objArg7 )
Parameters:

  • i_class_filter (str) –

  • i_face_cntr (Reference) –

  • ie_face_type (int) – enum cat_psp_idl_part_connector_type

  • i_alignment_cntr (Reference) –

  • ie_align_type (int) – enum cat_psp_idl_part_connector_type

  • i_clock_cntr (Reference) –

  • ie_clock_type (int) – enum cat_psp_idl_part_connector_type

Return type:

PSPPartConnector

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 Part connectors of the object.

Example:

Dim objThisIntf As PspPhsyicalProduct
Dim objArg1 As PspListOfObjects
…
Set objArg1 = objThisIntf.Connectors
Return type:

PSPListOfObjects

remove_connector(i_cntr_to_remove: PSPPartConnector) → None

Note

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

Removes part connector.

Parameters:

iCntrToRemove
Part connector to be removed

Example:

Dim objThisIntf As PspPhsyicalProduct
Dim objArg1 As PspPartConnector
…
objThisIntf.RemoveConnector objArg1
Parameters:

i_cntr_to_remove (PSPPartConnector) –

Return type:

None