pycatia.cat_sch_platform_interfaces.sch_grr_route

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_grr_route.SchGRRRoute(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

SchGRRRoute

Manage the graphical representations of a schematic route.

add_points(i_l_db2_pt_path_to_add: tuple, i_after_which_pt_num: int) → tuple

Note

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

o Sub AddPoints(CATSafeArrayVariant iLDb2PtPathToAdd,

long iAfterWhichPtNum)

Add a list of point to a route.

Parameters:

iLDbPtPathToAdd

A list of X-Y coordinates of the points to be added. 2 doubles per

point.

iAfterWhichPtNum

The point number to add the points after. Use 0 to indicate adding

before the first point.

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(x) As CATSafeArrayVariant

Dim intVar3 As Integer

…

objThisIntf.AddPointsdbVar1,intVar3

Parameters:

• i_l_db2_pt_path_to_add (tuple) –

• i_after_which_pt_num (int) –

Return type:

tuple

break_(i_db2_pt1: tuple, i_db2_pt2: tuple, o_new_grr_route: SchGRRRoute) → tuple

Note

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

o Sub Break(CATSafeArrayVariant iDb2Pt1,

CATSafeArrayVariant iDb2Pt2,

SchGRRRoute oNewGRRRoute)

Break a route graphic into 2 pieces. The old graphic is shortened and a new

graphic is created.

Parameters:

iDb2Pt1

X-Y coordinates of point 1 to break the route at (this point is

mandatory).

iDb2Pt2

X-Y coordinates of point 2 to break the route at (this point is

optional). If provided the points in between point 1 and this point will be

eliminated. Point 1 is the last point of the shortened old route and point 2 is

the first point of the new route. If this point is not provided (i.e. sends in

a NULL). point 1 and point 2 are the same.

oNewGRRRoute

The new line string graphic created (CATISchGRRRoute interface

pointer)

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(2) As CATSafeArrayVariant

Dim dbVar2(2) As CATSafeArrayVariant

Dim objArg3 As SchGRRRoute

…

objThisIntf.BreakdbVar1,dbVar2,objArg3

Parameters:

• i_db2_pt1 (tuple) –

• i_db2_pt2 (tuple) –

• o_new_grr_route (SchGRRRoute) –

Return type:

tuple

compress() → None

Note

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

o Sub Compress()

Compress a the defining points of a route graphic, removing coincident

points.

Example:

Dim objThisIntf As SchGRRRoute

…

objThisIntf.Compress

Return type:

None

compress2(i_unset_gaps: int) → None

Note

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

o Sub Compress2(CatSchIDLRouteUnsetGapsMode iUnsetGaps)

Compress the defining points of a route graphic, removing coincident

points.

Parameters:

iUnsetGaps

Whether to unset gaps (in all the effected routes: this route

and other routes intersecting it) or not = SchUnsetGapsOn :

unset gaps = SchUnsetGapsOff : don’t unset gaps

Example:

Dim objThisIntf As SchGRRRoute

…

objThisIntf.Compress2CatSchIDLRouteUnsetGapsMode_Enum

Parameters:

i_unset_gaps (int) – enum cat_sch_idl_route_unset_gaps_mode

Return type:

None

concatenate(i_which_end1: int, i_grr_route2: SchGRRRoute, i_which_end2: int) → None

Note

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

o Sub Concatenate(long iWhichEnd1,

SchGRRRoute iGRRRoute2,

long iWhichEnd2)

Concatenate 2 route graphic objects into one. The first route graphic is

elongated and the second object is deleted.

Parameters:

iWhichEnd1

=1 at start point; =2 at end point

iGRRRoute2

Second route graphic object (CATISchGRRRoute interface pointer) to

be concatenated to the first. This route graphic will be deleted.

iWhichEnd2

=1 at start point; =2 at end point

Example:

Dim objThisIntf As SchGRRRoute

Dim intVar1 As Integer

Dim objArg2 As SchGRRRoute

Dim intVar3 As Integer

…

objThisIntf.ConcatenateintVar1,objArg2,intVar3

Parameters:

• i_which_end1 (int) –

• i_grr_route2 (SchGRRRoute) –

• i_which_end2 (int) –

Return type:

None

concatenate_keep_grr2(i_which_end1: int, i_grr_route2: SchGRRRoute, i_which_end2: int) → None

Note

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

o Sub ConcatenateKeepGRR2(long iWhichEnd1,

SchGRRRoute iGRRRoute2,

long iWhichEnd2)

Concatenate 2 route graphic objects into one. The first route graphic is

elongated and the second object is unchanged.

Parameters:

iWhichEnd1

=1 at start point; =2 at end point

iGRRRoute2

Second route graphic object (CATISchGRRRoute interface pointer) to

be concatenated to the first. This route graphic will be unchanged.

iWhichEnd2

=1 at start point; =2 at end point

Example:

Dim objThisIntf As SchGRRRoute

Dim intVar1 As Integer

Dim objArg2 As SchGRRRoute

Dim intVar3 As Integer

…

objThisIntf.ConcatenateKeepGRR2intVar1,objArg2,intVar3

Parameters:

• i_which_end1 (int) –

• i_grr_route2 (SchGRRRoute) –

• i_which_end2 (int) –

Return type:

None

create_route_symbol(i_seg_num: int, i_seg_parm: float, i_grr_symbol: SchGRR, o_route_symbol: SchRouteSymbol) → None

Note

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

o Sub CreateRouteSymbol(long iSegNum,

double iSegParm,

SchGRR iGRRSymbol,

SchRouteSymbol oRouteSymbol)

Place a symbol on the route.

Parameters:

iSegNum

The route segment number to place the symbol on.

iSegParm

The parameter along the segment used to place the symbol on

(0.<=iSegParm<=1.).

iGRRSymbol

The graphical primitive (detail) to be used for the symbol.

oRouteSymbol

The created route symbol (ditto).

Example:

Dim objThisIntf As SchGRRRoute

Dim intVar1 As Integer

Dim dbVar2 As Double;

Dim objArg3 As SchGRR

Dim objArg4 As SchRouteSymbol

…

objThisIntf.CreateRouteSymbolintVar1,dbVar2,objArg3,objArg4

Parameters:

• i_seg_num (int) –

• i_seg_parm (float) –

• i_grr_symbol (SchGRR) –

• o_route_symbol (SchRouteSymbol) –

Return type:

None

get_end_point(o_db2_end_pt: SchListOfDoubles) → None

Note

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

o Sub GetEndPoint(SchListOfDoubles oDb2EndPt)

Get the end point of the route graphic.

Parameters:

oDb2EndPt

X-Y coordinates of the end point of the route graphic object.

Example:

Dim objThisIntf As SchGRRRoute

Dim objArg1 As SchListOfDoubles

…

objThisIntf.GetEndPointobjArg1

Parameters:

o_db2_end_pt (SchListOfDoubles) –

Return type:

None

get_path(o_l_db2_pt_path: SchListOfDoubles) → None

Note

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

o Sub GetPath(SchListOfDoubles oLDb2PtPath)

Get the defining points of a route graphic.

Parameters:

oLDbPtPath

A list of X-Y coordinates of the points. 2 doubles per point.

Example:

Dim objThisIntf As SchGRRRoute

Dim objArg1 As SchListOfDoubles

Dim intVar2 As Integer

…

objThisIntf.GetPathobjArg1

Parameters:

o_l_db2_pt_path (SchListOfDoubles) –

Return type:

None

get_start_point(o_db2_start_pt: SchListOfDoubles) → None

Note

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

o Sub GetStartPoint(SchListOfDoubles oDb2StartPt)

Get the start point of the route graphic.

Parameters:

oDb2StartPt

X-Y coordinates of the start point of the route graphic object.

Example:

Dim objThisIntf As SchGRRRoute

Dim objArg1 As SchListOfDoubles

…

objThisIntf.GetStartPointobjArg1

Parameters:

o_db2_start_pt (SchListOfDoubles) –

Return type:

None

list_route_symbols() → SchListOfObjects

Note

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

o Func ListRouteSymbols() As SchListOfObjects

List route symbols on the route.

Parameters:

oLRouteSymbol

A list of route symbols. (members are CATIASchRouteSymbol objects).

Example:

Dim objThisIntf As SchGRRRoute

Dim objArg1 As SchListOfObjects

…

Set objArg1 = objThisIntf.ListRouteSymbols

Return type:

SchListOfObjects

remove_points(i_num_of_pts_to_remove: int, i_after_which_pt_num: int) → None

Note

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

o Sub RemovePoints(long iNumOfPtsToRemove,

long iAfterWhichPtNum)

Remove points from route graphic.

Parameters:

iNumOfPtsToRemove

The number of points to be removed

iAfterWhichPtNum

The point number at which to start removing the point.

Example:

Dim objThisIntf As SchGRRRoute

Dim intVar1 As Integer

Dim intVar2 As Integer

…

objThisIntf.RemovePointsintVar1,intVar2

Parameters:

• i_num_of_pts_to_remove (int) –

• i_after_which_pt_num (int) –

Return type:

None

set_end_point(i_db2_end_pt: tuple) → tuple

Note

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

o Sub SetEndPoint(CATSafeArrayVariant iDb2EndPt)

Set the end point of the route graphic.

Parameters:

iDb2EndPt

X-Y coordinates of the end point of the route graphic object to be

set.

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(2) As CATSafeArrayVariant

…

objThisIntf.SetEndPointdbVar1

Parameters:

i_db2_end_pt (tuple) –

Return type:

tuple

set_path(i_l_db2_pt_path: tuple, i_compress: int) → tuple

Note

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

o Sub SetPath(CATSafeArrayVariant iLDb2PtPath,

CatSchIDLRouteCompressMode iCompress)

Set the defining points of a route graphic.

Parameters:

iLDbPtPath

A list of X-Y coordinates of the points to be set. 2 doubles per

point.

iCompress

Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.) or

not = SchCompressOn : compress = SchCompressOff : don’t compress

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(x) As CATSafeArrayVariant

…

objThisIntf.SetPathdbVar1,CatSchIDLRouteCompressMode_Enum

Parameters:

• i_l_db2_pt_path (tuple) –

• i_compress (int) – enum cat_sch_idl_route_compress_mode

Return type:

tuple

set_path2(i_l_db2_pt_path: tuple, i_compress: int, i_unset_gaps: int) → tuple

Note

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

o Sub SetPath2(CATSafeArrayVariant iLDb2PtPath,

CatSchIDLRouteCompressMode iCompress,

CatSchIDLRouteUnsetGapsMode iUnsetGaps)

Set the defining points of a route graphic.

Parameters:

iLDbPtPath

A list of X-Y coordinates of the points to be set. 2 doubles per

point.

iCompress

Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.)

or not = SchCompressOn : compress = SchCompressOff : don’t compress

iUnsetGaps

Whether to unset gaps (in all the effected routes: this route and other routes intersecting it) or not = SchUnsetGapsOn : unset gaps = SchUnsetGapsOff : don’t unset gaps

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(x) As CATSafeArrayVariant

…

objThisIntf.SetPath2dbVar1,CatSchIDLRouteCompressMode_Enum,CatSchIDLRouteUnsetGapsMode_Enum

Parameters:

• i_l_db2_pt_path (tuple) –

• i_compress (int) – enum cat_sch_idl_route_compress_mode

• i_unset_gaps (int) – enum cat_sch_idl_route_unset_gaps_mode

Return type:

tuple

set_path3(i_l_db2_pt_path: tuple, i_compress: int, i_unset_gaps: int, i_route_update_symbols: int) → tuple

Note

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

o Sub SetPath3(CATSafeArrayVariant iLDb2PtPath,

CatSchIDLRouteCompressMode iCompress,

CatSchIDLRouteUnsetGapsMode iUnsetGaps,

CatSchIDLRouteSymbolUpdateMode iRouteUpdateSymbols)

Set the defining points of a route graphic.

Parameters:

iLDb2PtPath

A list of X-Y coordinates of the points to be set. 2 doubles per

point.

iCompress

Whether to compress the route (i.e., remove duplicate pts, colinear segments, etc.)

or not = catSchIDLCompressOn : compress = catSchIDLCompressOff : don’t compress

iUnsetGaps

Whether to unset gaps (in all the effected routes: this route and other routes

intersecting it) or not = catSchIDLUnsetGapsOn : unset gaps = catSchIDLUnsetGapsOff :

don’t unset gaps

iRouteSymbolUpdate

Whether to update route symbols’ positions = catSchIDLSymbolUpdateOff : don’t update

route symbols = catSchIDLSymbolUpdateOn : update route symbols

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(x) As CATSafeArrayVariant

…

objThisIntf.SetPath3dbVar1,CatSchIDLRouteCompressMode_Enum,CatSchIDLRouteUnsetGapsMode_Enum,CatSchIDLRouteSymbolUpdateMode_Enum

Parameters:

• i_l_db2_pt_path (tuple) –

• i_compress (int) – enum cat_sch_idl_route_compress_mode

• i_unset_gaps (int) – enum cat_sch_idl_route_unset_gaps_mode

• i_route_update_symbols (int) – enum cat_sch_idl_route_symbol_update_mode

Return type:

tuple

set_start_point(i_db2_start_pt: tuple) → tuple

Note

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

o Sub SetStartPoint(CATSafeArrayVariant iDb2StartPt)

Set the start point of the route graphic.

Parameters:

iDb2StartPt

X-Y coordinates of the start point of the route graphic object to

be set.

Example:

Dim objThisIntf As SchGRRRoute

Dim dbVar1(2) As CATSafeArrayVariant

…

objThisIntf.SetStartPointdbVar1

Parameters:

i_db2_start_pt (tuple) –

Return type:

tuple