pycatia.cat_sch_platform_interfaces.sch_arrow_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_arrow_display.SchArrowDisplay(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
SchArrowDisplay

Manage the graphical representation of a schematic route.
is_arrow_shown(o_b_yes: bool) → None

Note

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

Query whether flow arrows are shown (arrow attributes
exist).

Parameters:

oBYes
If TRUE, then Flow arrows are shown (arrow attributes exist). If
FALSE, then Flow arrows are not shown (arrow attributes do not exist).

Example:

Dim objThisIntf As SchArrowDisplay
Dim bVar1 As boolean
…
objThisIntf.IsArrowShownbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

set_arrow(i_grr: SchGRRRoute, i_seg_num: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetArrow(SchGRRRoute iGRR,
long iSegNum)

Add arrow display attributes on the route.

Parameters:

iGRR
iGRR means apply only to segments of iGRR.
(if iGRR = NULL, apply to segments of all GRR’s of the route, and ignore iSegNum)
iSegNum
iSegNum = 0 means apply to all segments of iGRR.
iSegnum > 0 means apply to only to segment number iSegNum iGRR.

Example:

Dim objThisIntf As SchArrowDisplay
Dim objArg1 As SchGRRRoute
Dim intVar2 As Integer
…
objThisIntf.SetArrowobjArg1,intVar2
Parameters:
Return type:

None

unset_arrow(i_grr: SchGRRRoute, i_seg_num: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub UnsetArrow(SchGRRRoute iGRR,
long iSegNum)

Remove arrow display attributes on the route.

Parameters:

iGRR
iGRR means apply only to segments of iGRR. (if iGRR = NULL, apply to segments of all GRR’s of the route, and ignore iSegNum)
iSegNum
iSegNum = 0 means apply to all segments of iGRR. iSegnum > 0 means apply to only to segment number iSegNum iGRR.

Example:



Dim objThisIntf As SchArrowDisplay
Dim objArg1 As SchGRRRoute
Dim intVar2 As Integer
…
objThisIntf.UnsetArrowobjArg1,intVar2
Parameters:
Return type:

None