pycatia.pcb_board_base.pcb_board

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_board.PCBBoard(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
PCBBoard
create_pcbhole(i_hole: Hole, iplating_style: str, i_associated_part_name: str, i_hole_type: str, i_hole_owner: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub create_pcbhole(Hole iHole,
CATBSTR iplatingStyle,
CATBSTR iAssociatedPartName,
CATBSTR iHoleType,
CATBSTR iHoleOwner)

This method allows to add a Pcb hole to a board or a
panel.

Parameters:

iHole
This parameter represents the hole to transform in Pcb hole

iplatingStyle
This parameter represents the plating style of the hole. The
differents values are PTH or NPTH
iAssociatedPartName
This parameter represents name of the associated part to the hole.
The possible values are : the name of the instance of component in which the
hole is defined.
BOARD if the hole is defined in the Board part
PANEL If the hole is defined in the Panel part
NOREFDES is the hole is defined in a non Electronic Part.
iHoleType
This parameter represents the function of the hole. The
differents values are :
PIN if the hole is associated with a component pin
VIA if the hole is associated with a conductive via
MTG if the hole is used for mounting purposes
TOOL if the hole is used for tooling purposes Other ( User defined )
iHoleOwner
The parameter represents the owner of the hole.
The possible values are : MCAD, ECAD, UNOWNED

Returns:

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

  • i_hole (Hole) –

  • iplating_style (str) –

  • i_associated_part_name (str) –

  • i_hole_type (str) –

  • i_hole_owner (str) –

Return type:

None

create_pcbpattern(i_pattern: Pattern, iplating_style: str, i_associated_part_name: str, i_hole_type: str, i_hole_owner: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub create_pcbpattern(Pattern iPattern,
CATBSTR iplatingStyle,
CATBSTR iAssociatedPartName,
CATBSTR iHoleType,
CATBSTR iHoleOwner)

This method allows to add a Pcb pattern of hole to a board or a panel. If
the motif hole of the pattern is pcb hole, the input value are not taken into
account

Parameters:

iPattern
This parameter represents the Pattern to transform in Pcb Pattern

iplatingStyle
This parameter represents the plating style of the hole. The
differents values are PTH or NPTH
iAssociatedPartName
This parameter represents name of the associated part to the hole.
The possible values are : the name of the instance of component in which the hole is defined.
BOARD if the hole is defined in the Board part
PANEL If the hole is defined in the Panel part
NOREFDES is the hole is defined in a non Electronic Part.
iHoleType
This parameter represents the function of the hole. The differents values are :
PIN if the hole is associated with a component pin
VIA if the hole is associated with a conductive via
MTG if the hole is used for mounting purposes
TOOL if the hole is used for tooling purposes Other ( User defined )
iHoleOwner
The parameter represents the owner of the hole.
The possible values are : MCAD, ECAD, UNOWNED

Returns:

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

  • i_pattern (Pattern) –

  • iplating_style (str) –

  • i_associated_part_name (str) –

  • i_hole_type (str) –

  • i_hole_owner (str) –

Return type:

None

create_zone(zonetype: str, i_pad: Pad) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub create_zone(CATBSTR zonetype,
Pad iPad)

This method allows to add a constraint area to a board.

Parameters:

zonetype
This parameter represents the type of the zone to create The
differents values are ROUTE_OUTLINE, PLACE_OUTLINE, OTHER_OUTLINE, VIA_KEEPOUT,
PLACE_KEEPOUT, PLACE_REGION, ROUTE_KEEPOUT

Returns:

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

  • zonetype (str) –

  • i_pad (Pad) –

Return type:

None

property owner: str

Note

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

Allow to get and set the attribute owner of a Panel or a Board The possible
values are MCAD, ECAD, UNKNOWN

Returns:

The result of the method:
S_OK if succeeded
E_FAIL if failed
Return type:

str

property part: Pad

Note

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

set the pad of a Board or a component or a panel.
Return type:

Pad