pycatia.cat_sch_platform_interfaces.sch_cntr_location

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_cntr_location.SchCntrLocation(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
SchCntrLocation

Manage the location of a schematic connector.
get_align_vector(i_grr: SchGRR, o_db2_align_vector: SchListOfDoubles) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetAlignVector(SchGRR iGRR,
SchListOfDoubles oDb2AlignVector)

Get the current alignment vector of the connector.

Parameters:

iGRR
Pointer to the graphical primitive or the graphical image or the
graphical primitives of the owner of the connector.

oDb2AlignVector
X-Y component of the current alignment vector of the connector.

Example:

Dim objThisIntf As SchCntrLocation
Dim objArg1 As SchGRR
Dim objArg2 As SchListOfDoubles
…
objThisIntf.GetAlignVectorobjArg1,objArg2
Parameters:
Return type:

None

get_position(i_grr: SchGRR, o_db2_position: SchListOfDoubles) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetPosition(SchGRR iGRR,
SchListOfDoubles oDb2Position)

Get the current position of the connector in absolute
coordinates.

Parameters:

iGRR
Pointer to the graphical primitive or the graphical image or the
graphical primitives of the owner of the connector.

oDb2Position
Absolute X-Y coordinates of the current position of the connector.

Example:

Dim objThisIntf As SchCntrLocation
Dim objArg1 As SchGRR
Dim objArg2 As SchListOfDoubles
…
objThisIntf.GetPositionobjArg1,objArg2
Parameters:
Return type:

None

get_relative_position(o_db2_relative_position: SchListOfDoubles) → None

Note

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

Get the current position of the connector in relative
coordinates.

Parameters:

oDb2RelativePosition
relative X-Y coordinates of the current position of the connector.


Example:



Dim objThisIntf As SchCntrLocation
Dim objArg1 As SchListOfDoubles
…
objThisIntf.GetRelativePositionobjArg1
Parameters:

o_db2_relative_position (SchListOfDoubles) –

Return type:

None

set_align_vector(i_grr: SchGRR, i_db2_align_vector: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAlignVector(SchGRR iGRR,
CATSafeArrayVariant iDb2AlignVector)

Set the current alignment vector of the connector.

Parameters:

iGRR
Pointer to the graphical primitive or the graphical image or the
graphical primitives of the owner of the connector.

iDb2AlignVector
X-Y component of the current alignment vector of the connector to
be set.

Example:

Dim objThisIntf As SchCntrLocation
Dim objArg1 As SchGRR
Dim dbVar2(2) As CATSafeArrayVariant
…
objThisIntf.SetAlignVectorobjArg1,dbVar2
Parameters:

  • i_grr (SchGRR) –

  • i_db2_align_vector (tuple) –

Return type:

tuple

set_position(i_grr: SchGRR, i_db2_position: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPosition(SchGRR iGRR,
CATSafeArrayVariant iDb2Position)

Set the current position of the connector in absolute coordinates. All
connectors on multi-images are affected because the relative position on
connect will be changed accordingly.

Parameters:

iGRR
Pointer to the graphical primitive or the graphical image or the
graphical primitives of the owner of the connector..

iDb2Position
absolute X-Y coordinates of the current position of the connector
to be set.

Example:

Dim objThisIntf As SchCntrLocation
Dim objArg1 As SchGRR
Dim dbVar2(2) As CATSafeArrayVariant
…
objThisIntf.SetPositionobjArg1,dbVar2
Parameters:

  • i_grr (SchGRR) –

  • i_db2_position (tuple) –

Return type:

tuple

set_relative_position(i_db2_relative_position: tuple) → tuple

Note

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

Set the current position of the connector in absolute
coordinates.

Parameters:

iDb2RelativePosition
relative X-Y coordinates of the current position of the connector
to be set.

Example:

Dim objThisIntf As SchCntrLocation
Dim dbVar1(2) As CATSafeArrayVariant
…
objThisIntf.SetRelativePositiondbVar1
Parameters:

i_db2_relative_position (tuple) –

Return type:

tuple