pycatia.cat_sch_platform_interfaces.sch_gap_display

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_gap_display.SchGapDisplay(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

SchGapDisplay

Manage the graphical representation of a schematic route.

is_gap_shown(o_b_yes: bool) → None

Note

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

o Sub IsGapShown(boolean oBYes)

Query whether gaps are shown (gap attributes exist).

Parameters:

oBYes

If TRUE, then gaps are shown (gap attributes exist). If FALSE, then

gaps are not shown (gap attributes do not exist).

Example:

Dim objThisIntf As SchGapDisplay

Dim bVar1 As boolean

…

objThisIntf.IsGapShownbVar1

Parameters:

o_b_yes (bool) –

Return type:

None

set_gap(i_luk_routes: SchListOfObjects) → None

Note

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

o Sub SetGap(SchListOfObjects iLUKRoutes)

Add gap display attributes on the route.

Parameters:

iLUKRoutes

A list of routes to be processed, default is NULL (if NULL, then

all routes in model are processed). Members are CATISchRoute interface

pointers.

Example:

Dim objThisIntf As SchGapDisplay

Dim objArg1 As SchListOfObjects

…

objThisIntf.SetGapobjArg1

Parameters:

i_luk_routes (SchListOfObjects) –

Return type:

None

unset_gap(i_luk_routes: SchListOfObjects) → None

Note

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

o Sub UnsetGap(SchListOfObjects iLUKRoutes)

Remove gap display attributes on the route. A list of routes to be

processed, default is NULL (if NULL, then all routes in model are processed).

Members are CATISchRoute interface pointers.

Example:

Dim objThisIntf As SchGapDisplay

Dim objArg1 As SchListOfObjects

…

objThisIntf.UnsetGapobjArg1

Parameters:

i_luk_routes (SchListOfObjects) –

Return type:

None