pycatia.cat_sch_platform_interfaces.sch_route_alternate_graphic

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_sch_platform_interfaces.sch_route_alternate_graphic.SchRouteAlternateGraphic(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
SchRouteAlternateGraphic

Manage alternative graphical primitives of a schematic route.
add_alternate_graphic(i_initial_xy_position: tuple, o_added_grr: SchGRR) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddAlternateGraphic(CATSafeArrayVariant
iInitialXYPosition,
SchGRR oAddedGRR)

Add an alternate graphical primitive to a route. The alternate graphical
style is determined by the application. on the Schematic component in order to
specify the graphic style. on the Schematic component in order to identify the
component as an assembly.

Parameters:

iInitialXYPosition
The initial position for calculating the display of the graphic. If
NULL, the start point will be calculated based on the route graphic path of the
first assembly member to this Schematic component.

oAddedGRR
The route alternate graphical primitive that is added to the route.

Example:

Dim objThisIntf As SchRouteAlternateGraphic
Dim dbVar1(x) As CATSafeArrayVariant
Dim objArg2 As SchGRR
…
objThisIntf.AddAlternateGraphicdbVar1,objArg2
Parameters:

  • i_initial_xy_position (tuple) –

  • o_added_grr (SchGRR) –

Return type:

tuple

list_alternate_graphics() → SchListOfObjects

Note

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

Lists the alternate graphics of a route. The list contains all objects of
the same alternate graphic style. The style is determined must be implemented
on the Schematic component in order to specify the graphic
style.

Parameters:

oLGRR
A list of the alternate graphic objects.

Example:

Dim objThisIntf As SchRouteAlternateGraphic
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListAlternateGraphics
Return type:

SchListOfObjects

remove_all_alternate_graphics() → None

Note

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

Removes all alternate graphical primitives.

Example:

Dim objThisIntf As SchRouteAlternateGraphic
…
objThisIntf.RemoveAllAlternateGraphics
Return type:

None

remove_all_alternate_graphics_of_style(i_style: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RemoveAllAlternateGraphicsOfStyle(CatSchIDLRouteAlternateGraphicStyle
iStyle)

Removes all alternate graphical primitives of the given
style.

Parameters:

iStyle
An enum of the style of alternate graphic to remove.

Example:

Dim objThisIntf As SchRouteAlternateGraphic

…
objThisIntf.RemoveAllAlternateGraphicsOfStyleCatSchIDLRouteAlternateGraphicStyle_Enum
Parameters:

i_style (int) – enum cat_sch_idl_route_alternate_graphic_style

Return type:

None

remove_alternate_graphic(i_grr_to_be_removed: SchGRR) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RemoveAlternateGraphic(SchGRR iGRRToBeRemoved)

Remove an alternate graphical primitive from a route.

Parameters:

iGRRToBeRemoved
The route alternate graphic to be removed from the route. The input
graphic will be removed as long as there are at least two alternate graphics of
that style on the route.

Example:

Dim objThisIntf As SchRouteAlternateGraphic
Dim objArg1 As SchGRR
…
objThisIntf.RemoveAlternateGraphicobjArg1
Parameters:

i_grr_to_be_removed (SchGRR) –

Return type:

None