pycatia.cat_sch_platform_interfaces.sch_component

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_component.SchComponent(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
SchComponent

Manage a schematic component.
create_component_inst(i_grr: SchGRRComp, i_db6_axis: tuple, o_new_component: SchComponent) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateComponentInst(SchGRRComp iGRR,
CATSafeArrayVariant iDb6Axis,
SchComponent oNewComponent)

Create a component instance. The reference component must exist in current
document

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
“Primary” graphical representation will be used.
iDb6Axis
X-axis of the local axis of the new instance Y-axis of the local
axis of the new instance X-Y coordinates of the orgin of the new instance. This
axis defines the orientation and location of the new instance in space.
Optional (could be NULL). If provided, the instance will be and orientated as
defined. Else (1.0,0.0,0.0,1.0,0.0,0.0) is used
oNewComponent
Interface pointer to the new component instance placed.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim dbVar2(6) As CATSafeArrayVariant
Dim objArg3 As SchComponent
…
objThisIntf.CreateComponentInstobjArg1,dbVar2,objArg3
Parameters:
Return type:

tuple

create_local_reference(i_document_to_put_copy_in: Document) → SchComponent

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateLocalReference(Document iDocumentToPutCopyIn) As
SchComponent

Make a local component reference in another document by copying an existing
one in the current document.

Parameters:

iDocumentToPutCopyIn
Pointer to the document to make the copy in
oSchComp
Pointer to the copy.

Example:



Dim objThisIntf As SchComponent
Dim objArg1 As Document
Dim objArg2 As SchComponent
…
Set objArg2 = objThisIntf.CreateLocalReference(objArg1)
Parameters:

i_document_to_put_copy_in (Document) –

Return type:

SchComponent

flip_connected(i_grr: SchGRRComp) → None

Note

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

For component that is connected to another component or is inserted into a
route. This method changes the current connections on this component and
connects the component to the next compatible connector (connectors-pair in
case of inserted component).

Parameters:

iGRR
Pointer to the component graphical representation object. if NULL
the first insert image found will be used.

Example:



Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
…
objThisIntf.FlipConnectedobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None

flip_horizontal(i_grr: SchGRRComp) → None

Note

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

Mirror transform a component’s image about the horizontal-axis centered at
the local axis of the component. This component should not be connected to any
other object.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
…
objThisIntf.FlipHorizontalobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None

flip_on_line(i_grr: SchGRRComp) → None

Note

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

Mirror the graphical object of this component. Ths mirror line is the
inserted route segment. The current connections on the component is not
changed. case of inserted component).

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.

Example:



Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
…
objThisIntf.FlipOnLineobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None

flip_vertical(i_grr: SchGRRComp) → None

Note

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

Mirror transform a component’s image about the vertical-axis centered at
the local axis of the component. This component should not be connected to any
other object.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
…
objThisIntf.FlipVerticalobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None

insert_into_route_with_info(i_insert_info: AnyObject, o_new_component: SchComponent, o_new_route: SchRoute) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub InsertIntoRouteWithInfo(AnyObject iInsertInfo,
SchComponent oNewComponent,
SchRoute oNewRoute)

Insert a component into a route. An internal structure is prerequisite to
calling this method. This structure is obtained from calling
CATISchCompatible::GetBestFitInsertInfo.

Parameters:

iInsertInfo
Pointer to an internal class which contains structured information
of a component for placement. This is the output for calling
CATISchCompatible::GetBestFitInsertInfo.
oNewComponent
Interface pointer to the new component instance placed.

oNewRoute
Interface pointer to the new route instance, created when the
component is inserted into the route

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As AnyObject
Dim objArg2 As SchComponent
Dim objArg3 As SchRoute
…
objThisIntf.InsertIntoRouteWithInfoobjArg1,objArg2,objArg3
Parameters:
Return type:

None

is_a_reference(o_b_yes: bool) → None

Note

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

Query whether the component is a reference (as opposed to an
instance).

Parameters:

oBYes
If TRUE, the component is a reference.

Example:

Dim objThisIntf As SchComponent
Dim bVar1 As boolean
…
objThisIntf.IsAReferencebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

is_inserted(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub IsInserted(SchGRRComp iGRR,
boolean oBYes)

Query whether the component is inserted into a route.

Parameters:

iGRR
Pointer to the component graphical representation.

oBYes
If TRUE, the component is currently inserted in a route.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.IsInsertedobjArg1,bVar2
Parameters:
Return type:

None

ok_to_flip_connected(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToFlipConnected(SchGRRComp iGRR,
boolean oBYes)

Query whether it is OK to connect the component via next compatible
connectors.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, then it is OK to flip the component.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToFlipConnectedobjArg1,bVar2
Parameters:
Return type:

None

ok_to_flip_horizontal(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToFlipHorizontal(SchGRRComp iGRR,
boolean oBYes)

Query whether it is OK to flip the component about the horizontal
axis.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, then it is OK to flip the component.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToFlipHorizontalobjArg1,bVar2
Parameters:
Return type:

None

ok_to_flip_on_line(i_grr: SchGRRComp, o_b_yes: bool, o_db2_line_pt: SchListOfDoubles, o_db2_line_vec: SchListOfDoubles) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToFlipOnLine(SchGRRComp iGRR,
boolean oBYes,
SchListOfDoubles oDb2LinePt,
SchListOfDoubles oDb2LineVec)

Query whether it is OK to flip the component about the inserted route
segment.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, then it is OK to flip the component.
oDb2LinePt
Absolute X-Y coordinates of a point on the segment.

oDb2LineVec
Absolute X-Y component vector along the segment.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
Dim objArg3 As SchListOfDoubles
Dim objArg4 As SchListOfDoubles
…
objThisIntf.OKToFlipOnLineobjArg1,bVar2,objArg3,objArg4
Parameters:
Return type:

None

ok_to_flip_vertical(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToFlipVertical(SchGRRComp iGRR,
boolean oBYes)

Query whether it is OK to flip the component about vertical
axis.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, then it is OK to flip the component.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToFlipVerticalobjArg1,bVar2
Parameters:
Return type:

None

ok_to_place_in_space(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToPlaceInSpace(SchGRRComp iGRR,
boolean oBYes)

Query whether the component can be placed in free space.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, the component can be slided.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToPlaceInSpaceobjArg1,bVar2
Parameters:
Return type:

None

ok_to_scale(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToScale(SchGRRComp iGRR,
boolean oBYes)

Query whether it is OK to scale the component.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first image found will be used.
oBYes
If TRUE, then it is OK to scale the component.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToScaleobjArg1,bVar2
Parameters:
Return type:

None

ok_to_slide(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToSlide(SchGRRComp iGRR,
boolean oBYes)

Query whether the component can be slided.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, the component can be slided.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToSlideobjArg1,bVar2
Parameters:
Return type:

None

ok_to_uninsert(i_grr: SchGRRComp, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub OKToUninsert(SchGRRComp iGRR,
boolean oBYes)

Query whether it is OK to uninsert the component.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
oBYes
If TRUE, then it is OK to uninsert the component.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim bVar2 As boolean
…
objThisIntf.OKToUninsertobjArg1,bVar2
Parameters:
Return type:

None

place_in_space(i_grr: SchGRRComp, i_db6_axis: tuple, o_new_component: SchComponent) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PlaceInSpace(SchGRRComp iGRR,
CATSafeArrayVariant iDb6Axis,
SchComponent oNewComponent)

Place a component in space, unconnected to other objects. It will create
local reference (from a catalog referenced document) if
necessary.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
“Primary” graphical representation will be used.
iDb6Axis[6]
X-axis of the local axis of the new instance Y-axis of the local
axis of the new instance X-Y coordinates of the orgin of the new instance. This
axis defines the orientation and location of the new instance in space.

oNewComponent
Interface pointer to the new component instance placed.


Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim dbVar2(6) As CATSafeArrayVariant
Dim objArg3 As SchComponent
…
objThisIntf.PlaceInSpaceobjArg1,dbVar2,objArg3
Parameters:
Return type:

tuple

place_on_component_with_info(i_place_info: AnyObject) → SchComponent

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func PlaceOnComponentWithInfo(AnyObject iPlaceInfo) As
SchComponent

Place a component connected to another component. An internal structure is
prerequisite to calling this method. This structure is obtained from calling
CATISchCompatible::GetBestFitPlaceInfo.

Parameters:

iPlaceInfo
Pointer to an internal class which contains structured information
of a component for placement. This is the output for calling
CATISchCompatible::GetBestFitPlaceInfo.
oNewComponent
Interface pointer to the new component instance placed.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As AnyObject
Dim objArg2 As SchComponent
…
Set objArg2 = objThisIntf.PlaceOnComponentWithInfo(objArg1)
Parameters:

i_place_info (AnyObject) –

Return type:

SchComponent

place_on_object(i_grr: SchGRRComp, i_db6_axis: tuple, i_object_to_connect: SchAppConnectable, o_new_component: SchComponent) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub PlaceOnObject(SchGRRComp iGRR,
CATSafeArrayVariant iDb6Axis,
SchAppConnectable iObjectToConnect,
SchComponent oNewComponent)

Place a component connected to another component or insert into a
route.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
“Primary” graphical representation will be used.
iDb6Axis[6]
X-axis of the local axis of the new instance Y-axis of the local
axis of the new instance X-Y coordinates of the orgin of the new instance. This
axis defines the orientation and location of the new instance in space.

iObjectToConnect
Pointer to a component to connect the new instance to or a route
object to insert new component into.
oNewComponent
Interface pointer to the new component instance placed.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim dbVar2(6) As CATSafeArrayVariant
Dim objArg3 As SchAppConnectable
Dim objArg4 As SchComponent
…
objThisIntf.PlaceOnObjectobjArg1,dbVar2,objArg3,objArg4
Parameters:
Return type:

tuple

query_connect_ability(i_grr: SchGRRComp) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func QueryConnectAbility(SchGRRComp iGRR) As AnyObject

Find the Schematic component information for placement.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
“Primary” graphical representation will be used.
oPlaceInfo
Pointer to an internal class which contains structured information
of a component for placement. This is the input for calling
CATISchCompatible::IsComponentCompatible

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim objArg2 As AnyObject
…
Set objArg2 = objThisIntf.QueryConnectAbility(objArg1)
Parameters:

i_grr (SchGRRComp) –

Return type:

AnyObject

slide(i_grr: SchGRRComp, i_db2_pt_to_slide_to: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Slide(SchGRRComp iGRR,
CATSafeArrayVariant iDb2PtToSlideTo)

Slide a component (applicable to inserted component only). The component is
moved along the route and remain inserted.

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.
iDb2PtToSlideTo[2]
X-Y coordinates of the point to slide the component to.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
Dim dbVar2(2) As CATSafeArrayVariant
…
objThisIntf.SlideobjArg1,dbVar2
Parameters:

  • i_grr (SchGRRComp) –

  • i_db2_pt_to_slide_to (tuple) –

Return type:

tuple

uninsert(i_grr: SchGRRComp) → None

Note

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

Remove all connections of a component with a route. (applicable to inserted
component only).

Parameters:

iGRR
Pointer to the component graphical representation. if NULL the
first insert image found will be used.

Example:

Dim objThisIntf As SchComponent
Dim objArg1 As SchGRRComp
…
objThisIntf.UninsertobjArg1
Parameters:

i_grr (SchGRRComp) –

Return type:

None