pycatia.cat_sch_platform_interfaces.sch_base_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_base_factory.SchBaseFactory(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
SchBaseFactory

Factory to create basic schematic objects.
create_network(i_l_cntbls: SchListOfObjects, i_lgr_rs: SchListOfObjects) → SchListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateNetwork(SchListOfObjects iLCntbls,
SchListOfObjects iLGRRs) As SchListOfObjects

Create schematic networks for query. These are volatile objects and will
not be saved in the model.

Parameters:

iLCntbl
A list of related objects that belong to the network
(CATISchAppConnectable pointers). These objects do not need to be connected.
This method will do the analysis and returns the network(s) containing these
objects.
iLCntbl
A list of graphical images interface (CATISchGRR) pointers. Each
member corresponds to the members in iLCntbl.
oNetwork
[out, IUnknown#Release] Pointer to the network analysis interface
pointers.

Example:

Dim objThisIntf As SchBaseFactory
Dim objArg1 As SchListOfObjects
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchListOfObjects
…
Set objArg3 = objThisIntf.CreateNetwork(objArg1,objArg2)
Parameters:
Return type:

SchListOfObjects

create_route_and_connect_to_objects(i_app_route: AnyObject, i_cntr_comp_from: SchAppConnector, i_cntr_comp_to: SchAppConnector, i_grr_comp_from: SchGRRComp, i_grr_comp_to: SchGRRComp, i_l_db2_pt_path: tuple, i_e_route_mode: int, o_sch_route: SchRoute) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateRouteAndConnectToObjects(AnyObject iAppRoute,
SchAppConnector iCntrCompFrom,
SchAppConnector iCntrCompTo,
SchGRRComp iGRRCompFrom,
SchGRRComp iGRRCompTo,
CATSafeArrayVariant iLDb2PtPath,
CatSchIDLRouteMode iERouteMode,
SchRoute oSchRoute)

Create a route and connect its extremity connectors to input
objects.

Parameters:

iAppRoute
Application route (at least a feature)
iCntrCompFrom
Pointer to component connector to connect starting end of the route
to If NULL, no connection is made at this end.
iCntrCompTo
Pointer to component connector to connect end of the route to If
NULL, no connection is made at this end.
iGRRCompFrom
Pointer to first component graphical image, if NULL, the PRIMARY
image associated with component will be used
iGRRCompTo
Pointer to second component graphical image, if NULL, the PRIMARY
image associated with component will be used
iLDb2PtPath
A list of X-Y coordinates of points to be used for the route image.
2 doubles per point. Not used if iERouteMode=SchRouteMode_AroundObject input a
NULL for this case
iERouteMode
Route mode to use. Only used when iLDb2PtPath is NULL.

oSchRoute
Pointer to the new route

Example:



Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim objArg2 As SchAppConnector
Dim objArg3 As SchAppConnector
Dim objArg4 As SchGRRComp
Dim objArg5 As SchGRRComp
Dim dbVar6(x) As CATSafeArrayVariant

Dim objArg9 As SchRoute
…
objThisIntf.CreateRouteAndConnectToObjectsobjArg1,objArg2,objArg3,objArg4,objArg5,dbVar6,CatSchIDLRouteMode_Enum,objArg9
Parameters:
Return type:

tuple

create_sch_comp_group(i_app_group: AnyObject, i_lgrr: SchListOfObjects, i_l_member: SchListOfObjects) → SchCompGroupExt

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSchCompGroup(AnyObject iAppGroup,
SchListOfObjects iLGRR,
SchListOfObjects iLMember) As SchCompGroupExt

Create a Schematic Component Group object.

Parameters:

iAppGroup
Application group object (at least a feature) Optional, it could be
NULL. If NULL, one will be created by the platform

iLGRR
A list of graphical representation. Optional, it could be NULL.

iLMembers
A list of initial members. Optional, it could be NULL.

oSchGroup
Pointer to the new group.

Example:



Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchListOfObjects
Dim objArg4 As SchCompGroupExt
…
Set objArg4 = objThisIntf.CreateSchCompGroup(objArg1,objArg2,objArg3)
Parameters:
Return type:

SchCompGroupExt

create_sch_component(i_app_component_ref: AnyObject, i_lgrr: SchListOfObjects) → SchComponent

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSchComponent(AnyObject iAppComponentRef,
SchListOfObjects iLGRR) As SchComponent

Create a Schematic Component reference.

Parameters:

iAppComponentRef
Application component reference (at least a feature)

iLGRR
A list of graphical representations.
oSchComp
Pointer to the new component.

Example:

Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchComponent
…
Set objArg3 = objThisIntf.CreateSchComponent(objArg1,objArg2)
Parameters:
Return type:

SchComponent

create_sch_route_by_points(i_app_route: AnyObject, i_l_db_pt: tuple, o_sch_route: SchRoute) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateSchRouteByPoints(AnyObject iAppRoute,
CATSafeArrayVariant iLDbPt,
SchRoute oSchRoute)

Create a Schematic Route object with a list of points.

Parameters:

iAppRoute
Application route (at least a feature)
iLDbPt
A list of X-Y coordinates of points. 2 doubles per point.

oSchRoute
Pointer to the new route

Example:

Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim dbVar2(x) As CATSafeArrayVariant
Dim objArg4 As SchRoute
…
objThisIntf.CreateSchRouteByPointsobjArg1,dbVar2,objArg4
Parameters:
Return type:

tuple

create_sch_route_by_prim(i_app_route: AnyObject, i_lgrr: SchListOfObjects) → SchRoute

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSchRouteByPrim(AnyObject iAppRoute,
SchListOfObjects iLGRR) As SchRoute

Create a Schematic Route object with primitives.

Parameters:

iAppRoute
Application route (at least a feature)
iLGRR
A list of graphical primitives. pointer).
oSchRoute
Pointer to the new route

Example:

Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchRoute
…
Set objArg3 = objThisIntf.CreateSchRouteByPrim(objArg1,objArg2)
Parameters:
Return type:

SchRoute

create_sch_zone(i_app_zone: AnyObject, i_lgrr: SchListOfObjects) → SchZone

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateSchZone(AnyObject iAppZone,
SchListOfObjects iLGRR) As SchZone

Create a Schematic Zone object.

Parameters:

iAppZone
Application zone object (at least a feature)
iLGRR
A list of graphical representation.
oSchZone
Pointer to the new zone.

Example:



Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchZone
…
Set objArg3 = objThisIntf.CreateSchZone(objArg1,objArg2)
Parameters:
Return type:

SchZone

delete_object(i_object: AnyObject) → None

Note

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

Delete a schematic object.

Parameters:

iObject
interface pointer to the object to be deleted

Example:

Dim objThisIntf As SchBaseFactory
Dim objArg1 As AnyObject
…
objThisIntf.DeleteObjectobjArg1
Parameters:

i_object (AnyObject) –

Return type:

None