pycatia.cat_sch_platform_interfaces.sch_grr_cntr

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_cntr.SchGRRCntr(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
SchGRRCntr

Manage the graphical representation of a schematic connector.
get_symbol(o_grr: SchGRR, o_e_symbol_type: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSymbol(SchGRR oGRR,
CatSchIDLCntrSymbolType oESymbolType)

Get the graphical primitive of a connector.

Parameters:

oGRR
The graphical primitive (ditto) used to represent a connector.

oESymbolType
Connector symbol type such as: point, point/vector, OnOffSheet,
LineBoundary.

Example:

Dim objThisIntf As SchGRRCntr
Dim objArg1 As SchGRR

…
objThisIntf.GetSymbolobjArg1,CatSchIDLCntrSymbolType_Enum
Parameters:

  • o_grr (SchGRR) –

  • o_e_symbol_type (int) – enum cat_sch_idl_cntr_symbol_type

Return type:

None

remove_symbol() → None

Note

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

Remove the graphical primitive used as the connector’s symbol. The default
connector’s symbol type will be set to point.

Example:



Dim objThisIntf As SchGRRCntr
…
objThisIntf.RemoveSymbol
Return type:

None

set_symbol(i_grr_symbol: SchGRR, i_e_symbol_type: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSymbol(SchGRR iGRRSymbol,
CatSchIDLCntrSymbolType iESymbolType)

Set the symbol or graphics used to represent a connector.

Parameters:

iGRRSymbol
The graphical primitive (detail) to be used as the connector’s
symbol. iGRRSymbol can be NULL if iESymbolType is a point or point/vector.

iESymbolType
Connector symbol type such as: point, point/vector, OnOffSheet,
LineBoundary.

Example:

Dim objThisIntf As SchGRRCntr
Dim objArg1 As SchGRR
…
objThisIntf.SetSymbolobjArg1,CatSchIDLCntrSymbolType_Enum
Parameters:

  • i_grr_symbol (SchGRR) –

  • i_e_symbol_type (int) – enum cat_sch_idl_cntr_symbol_type

Return type:

None