pycatia.cat_sch_platform_interfaces.sch_grr_factory

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_factory.SchGRRFactory(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
SchGRRFactory

Factory to create graphical representations of schematic
objects.
create_grr_cntr() → SchGRRCntr

Note

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

Create the graphical representation of a Schematic
Connector.

Parameters:

oGRRCntr
The graphical representation of the connector

Example:

Dim objThisIntf As SchGRRFactory
Dim objArg1 As SchGRRCntr
…
Set objArg1 = objThisIntf.CreateGRRCntr
Return type:

SchGRRCntr

create_grr_group(i_l_primitive: SchListOfObjects) → AnyObject

Note

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

Create the graphical representation of a Schematic Group.

Parameters:

iLPrimitives
A list of 2D drafting detail pointers Members are CATI2DDetail
interface poiners.
oGRRGroup
The graphical representation of the Group

Example:

Dim objThisIntf As SchGRRFactory
Dim objArg1 As SchListOfObjects
Dim objArg2 As AnyObject
…
Set objArg2 = objThisIntf.CreateGRRGroup(objArg1)
Parameters:

i_l_primitive (SchListOfObjects) –

Return type:

AnyObject

create_grr_route(i_l_db_line_path: tuple, o_grr_route: SchGRRRoute) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateGRRRoute(CATSafeArrayVariant iLDbLinePath,
SchGRRRoute oGRRRoute)

Create the graphical representation of a Schematic Route.

Parameters:

iLDbPtPath
A list of X-Y coordinates of points defining the Route. 2 doubles
per point.
oGRRRoute
The graphical representation of the Route

Example:

Dim objThisIntf As SchGRRFactory
Dim dbVar1(x) As CATSafeArrayVariant
Dim objArg3 As SchGRRRoute
…
objThisIntf.CreateGRRRoutedbVar1,objArg3
Parameters:

  • i_l_db_line_path (tuple) –

  • o_grr_route (SchGRRRoute) –

Return type:

tuple

create_grr_route_ellipse(i_db_xy_seed_pt: tuple, o_grr_route_ellipse: SchGRRRouteEllipse) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateGRRRouteEllipse(CATSafeArrayVariant iDbXYSeedPt,
SchGRRRouteEllipse oGRRRouteEllipse)

Create the graphical representation of a Schematic Route
Ellipse.

Parameters:

iDbXYSeedPt
X-Y coordinate of the seed point for the ellipse. If NULL, the seed
point will not be set.
oGRRRouteEllipse
The graphical representation of the Route Ellipse

Example:

Dim objThisIntf As SchGRRFactory
Dim dbVar1(X) As CATSafeArrayVariant
Dim objArg2 As SchGRRRouteEllipse
…
objThisIntf.CreateGRRRouteEllipsedbVar1,objArg2
Parameters:
Return type:

tuple

create_grr_zone(i_l_primitive: SchListOfObjects) → SchGRRZone

Note

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

Create the graphical representation of a Schematic Zone.

Parameters:

iLPrimitives
A list of 2D drafting object pointers defining the zone boundaries.

oGRRZone
The graphical representation of the Zone

Example:

Dim objThisIntf As SchGRRFactory
Dim objArg1 As SchListOfObjects
Dim objArg2 As SchGRRZone
…
Set objArg2 = objThisIntf.CreateGRRZone(objArg1)
Parameters:

i_l_primitive (SchListOfObjects) –

Return type:

SchGRRZone