pycatia.cat_sch_platform_interfaces.sch_route_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_graphic.SchRouteGraphic(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
SchRouteGraphic

Manage graphical primitives representing a schematic route.
add_graphical_primitive(i_grr_to_add: SchGRRRoute) → None

Note

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

Add a graphical primitive to a route.

Parameters:

iGRRToAdd
The route graphical primitive to be added to the route.

Example:

Dim objThisIntf As SchRouteGraphic
Dim objArg1 As SchGRRRoute
…
objThisIntf.AddGraphicalPrimitiveobjArg1
Parameters:

i_grr_to_add (SchGRRRoute) –

Return type:

None

list_graphical_primitives() → SchListOfObjects

Note

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

List all graphical primitives of a route.

Parameters:

oLGRR
A list of graphical primitives (members are CATISchGRRRoute
interface pointers).

Example:

Dim objThisIntf As SchRouteGraphic
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListGraphicalPrimitives
Return type:

SchListOfObjects

remove_all_graphical_primitives() → None

Note

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

Remove all graphical primitives of a route, including alternate graphical
primitives.

Example:

Dim objThisIntf As SchRouteGraphic
…
objThisIntf.RemoveAllGraphicalPrimitives
Return type:

None

remove_graphical_primitive(i_grr_to_remove: SchGRRRoute) → None

Note

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

Remove a graphical primitive from a route.

Parameters:

iGRRToRemove
The route graphical primitive to be removed from the component.

Example:

Dim objThisIntf As SchRouteGraphic
Dim objArg1 As SchGRRRoute
…
objThisIntf.RemoveGraphicalPrimitiveobjArg1
Parameters:

i_grr_to_remove (SchGRRRoute) –

Return type:

None