pycatia.cat_sch_platform_interfaces.sch_comp_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_comp_graphic.SchCompGraphic(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
SchCompGraphic

Manage the graphical representation of a schematic component.
activate(i_grr_name: str, i_db2_where_at: tuple, o_grr: SchGRRComp) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Activate(CATBSTR iGRRName,
CATSafeArrayVariant iDb2WhereAt,
SchGRRComp oGRR)

To add a new image to an existing object. This new image is an instance of
graphical representation with the input name.

Parameters:

iGRRName
The name of the graphic representation
iDb2WhereAt
The x-y coordinates of the image position. If NULL, the image will
be positioned at the origin.
oGRR
Pointer to the new graphical image of the component.

Example:

Dim objThisIntf As SchCompGraphic
Dim strVar1 As String
Dim dbVar2(2) As CATSafeArrayVariant
Dim objArg3 As SchGRRComp
…
objThisIntf.ActivatestrVar1,dbVar2,objArg3
Parameters:

  • i_grr_name (str) –

  • i_db2_where_at (tuple) –

  • o_grr (SchGRRComp) –

Return type:

tuple

add_graphical_representation(i_grr_to_add: SchGRRComp) → None

Note

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

Add a graphical representation to a component.

Parameters:

iGRRToAdd
The graphical representation to be added to the component.

Example:

Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchGRRComp
…
objThisIntf.AddGraphicalRepresentationobjArg1
Parameters:

i_grr_to_add (SchGRRComp) –

Return type:

None

deactivate(i_grr: SchGRRComp) → None

Note

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

To remove an image to an existing object.

Parameters:

iGRR
The graphical image to be removed from the component.

iDb2WhereAt
The x-y coordinates of the image position. If NULL, the image will
be positioned at the origin.

Example:



Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchGRRComp
…
objThisIntf.DeactivateobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None

list_graphical_images() → SchListOfObjects

Note

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

List all graphical images (instances of the rep) of a
component.

Parameters:

oLGRR
A list of graphical images (members are CATISchGRRComp interface
pointers).

Example:

Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListGraphicalImages
Return type:

SchListOfObjects

list_graphical_representations() → SchListOfObjects

Note

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

List all graphical representation of a component.

Parameters:

oLGRR
A list of graphical representations (members are CATISchGRRComp
interface pointers).

Example:

Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListGraphicalRepresentations
Return type:

SchListOfObjects

remove_graphical_representation(i_grr_to_remove: SchGRRComp) → None

Note

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

Remove a graphical representation from a component.

Parameters:

iGRRToRemove
The graphical representation to be removed from the component.

Example:

Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchGRRComp
…
objThisIntf.RemoveGraphicalRepresentationobjArg1
Parameters:

i_grr_to_remove (SchGRRComp) –

Return type:

None

switch(i_grr: SchGRRComp, i_grr_name: str, o_grr: SchGRRComp) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Switch(SchGRRComp iGRR,
CATBSTR iGRRName,
SchGRRComp oGRR)

Replace the input image object with an image of the graphical
representation with the input name.

Parameters:

iGRR
Pointer to the component graphical image to be switched.

oGRR
Pointer to the new graphical image of the component.

Example:

Dim objThisIntf As SchCompGraphic
Dim objArg1 As SchGRRComp
Dim strVar2 As String
Dim objArg3 As SchGRRComp
…
objThisIntf.SwitchobjArg1,strVar2,objArg3
Parameters:
Return type:

None

switch_all(i_grr_name: str) → None

Note

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

Replace all occurances of the images of this component with those of the
graphical representation with the input name.

Parameters:

iGRRName
The name of the graphical representation

Example:

Dim objThisIntf As SchCompGraphic
Dim strVar1 As String
…
objThisIntf.SwitchAllstrVar1
Parameters:

i_grr_name (str) –

Return type:

None