pycatia.pcb_board_base.pcb_workbench

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.pcb_board_base.pcb_workbench.PCBWorkbench(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
InfInterfaces.Workbench
PCBWorkbench

Interface to access Circuit Board Design workbench object.
create_board(i_root: AnyObject) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateBoard(CATBaseDispatch iRoot) As CATBaseDispatch

Allows to create a Board.

Parameters:

iRoot
Root product of the Part to extend
oBoard
The board created

Returns:

The result of the method:
S_OK if succeeded
E_FAIL if failed
Parameters:

i_root (AnyObject) –

Return type:

AnyObject

create_component(i_root: AnyObject, i_elec_package_number: str, i_elec_part_number: str, i_elec_type: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateComponent(CATBaseDispatch iRoot,
CATBSTR iElecPackageNumber,
CATBSTR iElecPartNumber,
CATBSTR iElecType) As CATBaseDispatch

Allows to create a Component.

Parameters:

iRoot
Root product of the Part to extend
iElecPackageNumber
The package number used to valuate the component attribute

iElecPartNumber
The part number used to valuate the part number of the component

iElecType
The Type of the component to create : ELECTRICAL or MECHANICAL
oComponent
The Component created

Returns:

The result of the method:
S_OK if succeeded
E_FAIL if failed
Parameters:

  • i_root (AnyObject) –

  • i_elec_package_number (str) –

  • i_elec_part_number (str) –

  • i_elec_type (str) –

Return type:

AnyObject

create_panel(i_root: AnyObject) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreatePanel(CATBaseDispatch iRoot) As CATBaseDispatch

Allows to create a panel.

Parameters:

iRoot
Root product of the Part to extend
oPanel
The panel created

Returns:

The result of the method:
S_OK if succeeded
E_FAIL if failed
Parameters:

i_root (AnyObject) –

Return type:

AnyObject

get_root_product(doc: Document) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetRootProduct(Document doc) As CATBaseDispatch

Allows to get the root product of a document.

Parameters:

doc
The document to scan
oRoot
The root product of the document scanned

Returns:

The result of the method:
S_OK if succeeded
E_FAIL if failed
Parameters:

doc (Document) –

Return type:

AnyObject