pycatia.cat_sch_platform_interfaces.sch_grr

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.SchGRR(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
SchGRR

Manage the graphical representation of a schematic object.
get_grr_name(o_grr_name: str) → None

Note

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

Get current name of the GRR.

Parameters:

oGRRName
The name of this GRR. A component can be associated with more than
one GRRs. Each GRR is identified by a specific name. Valid names are specified
by the application when building the component. Every component should have a
GRR named “Primary”. The GRR by this name is used in the catalog.

Example:

Dim objThisIntf As SchGRR
Dim strVar1 As String
…
objThisIntf.GetGRRNamestrVar1
Parameters:

o_grr_name (str) –

Return type:

None

get_sch_cntr_owners(o_cntr_owner: SchAppConnector, o_grr_owner: SchGRR) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSchCntrOwners(SchAppConnector oCntrOwner,
SchGRR oGRROwner)

Get the schematic objects that own this connector graphic
representation.

Parameters:

oCntrOwner.
A schematic connector that owns this connector graphic
representation.
oGRROwner
A component or route graphic representation that owns this
connector graphic representation.

Example:

Dim objThisIntf As SchGRR
Dim objArg1 As SchAppConnector
Dim objArg2 As SchGRR
…
objThisIntf.GetSchCntrOwnersobjArg1,objArg2
Parameters:
Return type:

None

get_sch_obj_owner() → SchAppConnectable

Note

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

Get the schematic object that owns this graphic
representation.

Parameters:

oGRROwner
A schematic object that owns this graphic representation.

Example:

Dim objThisIntf As SchGRR
Dim objArg1 As SchAppConnectable
…
Set objArg1 = objThisIntf.GetSchObjOwner
Return type:

SchAppConnectable

list_connected_gr_rs(i_grr_owner: SchAppConnectable, i_l_cntble_class_filter: SchListOfBSTRs, o_l_cntble_gr_rs: SchListOfObjects, o_l_cntbles: SchListOfObjects, o_l_cntrs_on_this_obj: SchListOfObjects, o_l_cntrs_on_connected: SchListOfObjects) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ListConnectedGRRs(SchAppConnectable iGRROwner,
SchListOfBSTRs iLCntbleClassFilter,
SchListOfObjects oLCntbleGRRs,
SchListOfObjects oLCntbles,
SchListOfObjects oLCntrsOnThisObj,
SchListOfObjects oLCntrsOnConnected)

Get a list of graphical objects that connects to this graphic
representation.

Parameters:

iGRROwner
A CATISchAppConnectable that owns this graphic representation. In
the case of GRRCntr (this object), iGRROwner is the owner of the owner of this
graphic.
oLCntrClassFilter
A list of all the class types for filtering the output application
objects list.
oLCntbleGRRs
A list of GRRs connected to this GRR. (members are CATISchGRR
interface pointers).
oLCntbles
A list of application objects connected to this object. (members
are CATISchAppConnectable interface pointers).
oLCntrsOnThisObj
A list of connectors on this object through which the connection is
made. (members are CATISchAppConnector interface pointers).

oLCntrsOnConnected
A list of connectors on the connected objects through which the
connection is made. (members are CATISchAppConnector interface pointers).
Members in this list corresponds to those in oLCntrsOnThisObj in making the
corresponding connections.

Example:

Dim objThisIntf As SchGRR
Dim objArg1 As SchAppConnectable
Dim objArg2 As SchListOfBSTRs
Dim objArg3 As SchListOfObjects
Dim objArg4 As SchListOfObjects
Dim objArg5 As SchListOfObjects
Dim objArg6 As SchListOfObjects
…
objThisIntf.ListConnectedGRRsobjArg1,objArg2,objArg3,objArg4,objArg5,objArg6
Parameters:
Return type:

None

set_grr_name(i_grr_name: str) → None

Note

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

Set current name of the GRR.

Parameters:

iGRRName
The name of this GRR to be set.

Example:

Dim objThisIntf As SchGRR
Dim strVar1 As String
…
objThisIntf.SetGRRNamestrVar1
Parameters:

i_grr_name (str) –

Return type:

None