pycatia.cat_sch_platform_interfaces.sch_app_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_app_component.SchAppComponent(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
SchAppComponent

Represents an application component object.
app_create_component_inst() → AnyObject

Note

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

Create a component instance.

Parameters:

oNewAppCompInst
Interface pointer (CATISchAppComponent) to the new application
component instance placed.

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As AnyObject
…
Set objArg1 = objThisIntf.AppCreateComponentInst
Return type:

AnyObject

app_create_local_reference(i_doc_to_copy_to: Document) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AppCreateLocalReference(Document iDocToCopyTo) As
AnyObject

Create Local Reference object. Given a reference object (the “this”), This
method make a copy of the reference into another document.

Parameters:

iDocToCopyTo
Pointer to a document to copy the reference to,
oNewAppCompRef
Interface pointer (CATISchAppComponent) to the new application
component Reference copied.

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As Document
Dim objArg2 As AnyObject
…
Set objArg2 = objThisIntf.AppCreateLocalReference(objArg1)
Parameters:

i_doc_to_copy_to (Document) –

Return type:

AnyObject

app_get_default_grr_name(o_grr_default_name: str) → None

Note

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

Get the default graphical representation names of an application
component.

Parameters:

oGRRDefaultName
The default name to be used for the graphical representation of a
component

Example:



Dim objThisIntf As SchAppComponent
Dim strVar1 As String
…
objThisIntf.AppGetDefaultGRRNamestrVar1
Parameters:

o_grr_default_name (str) –

Return type:

None

app_list_grr_names() → SchListOfBSTRs

Note

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

Find all the valid graphical representation names of an application
component.

Parameters:

oLGRRNames
A list of all the valid graphical representation names with this
connector for connections.

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As SchListOfBSTRs
…
Set objArg1 = objThisIntf.AppListGRRNames
Return type:

SchListOfBSTRs

app_ok_to_flip_connected(o_b_yes: bool) → None

Note

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

Query whether it is OK to reconnect a component to a different compatible
configuration.

Parameters:

oBYes
If TRUE, then it is OK to flip the component.

Example:

Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToFlipConnectedbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_flip_horizontal(o_b_yes: bool) → None

Note

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

Query whether it is OK to flip the application component about
Y.

Parameters:

oBYes
If TRUE, then it is OK to flip the component.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToFlipHorizontalbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_flip_on_line(o_b_yes: bool) → None

Note

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

Query whether it is OK to flip a component about its inserted
line.

Parameters:

oBYes
If TRUE, then it is OK to flip the component.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToFlipOnLinebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_flip_vertical(o_b_yes: bool) → None

Note

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

Query whether it is OK to flip the application component about
X.

Parameters:

oBYes
If TRUE, then it is OK to flip the component.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToFlipVerticalbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_place_in_space(o_b_yes: bool) → None

Note

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

Query whether the application component can be placed in free
space.

Parameters:

oBYes
If TRUE, the component can be slided.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToPlaceInSpacebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_scale(o_b_yes: bool) → None

Note

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

Query whether it is OK to scale the application component.

Parameters:

oBYes
If TRUE, then it is OK to scale the component.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToScalebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_slide(o_b_yes: bool) → None

Note

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

Query whether the application component can be slided.

Parameters:

oBYes
If TRUE, the component can be slided.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToSlidebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_uninsert(o_b_yes: bool) → None

Note

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

Query whether it is OK to uninsert the application
component.

Parameters:

oBYes
If TRUE, then it is OK to uninsert the component.

Example:



Dim objThisIntf As SchAppComponent
Dim bVar1 As boolean
…
objThisIntf.AppOKToUninsertbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_post_flip_connected_process() → None

Note

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

Post process after reconnecting a component to a different compatible
configuration.

Example:



Dim objThisIntf As SchAppComponent
…
objThisIntf.AppPostFlipConnectedProcess
Return type:

None

app_post_flip_horizontal_process() → None

Note

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

Post process after flipping a component in “x”.

Example:



Dim objThisIntf As SchAppComponent
…
objThisIntf.AppPostFlipHorizontalProcess
Return type:

None

app_post_flip_on_line_process() → None

Note

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

Post process after flipping an inserted component about the inserted line
segment of the route.

Example:



Dim objThisIntf As SchAppComponent
…
objThisIntf.AppPostFlipOnLineProcess
Return type:

None

app_post_flip_vertical_process() → None

Note

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

Post process after flipping a component in “y”.

Example:



Dim objThisIntf As SchAppComponent
…
objThisIntf.AppPostFlipVerticalProcess
Return type:

None

app_post_place_process(i_new_comp_inst: SchComponent, i_cntbl_connected_to: SchAppConnectable) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppPostPlaceProcess(SchComponent iNewCompInst,
SchAppConnectable iCntblConnectedTo)

Post process after placing an application component
instance.

Parameters:

iNewCompInst
The newly placed component instance (CATISchComponent interface
pointer).
iCntbleConnectedTo
The connectable that the placed component is connected to or placed
onto

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As SchComponent
Dim objArg2 As SchAppConnectable
…
objThisIntf.AppPostPlaceProcessobjArg1,objArg2
Parameters:
Return type:

None

app_post_slide_process() → None

Note

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

Post process after sliding a component.

Example:



Dim objThisIntf As SchAppComponent
…
objThisIntf.AppPostSlideProcess
Return type:

None

app_post_switch_graphic_process(i_grr: SchGRR) → None

Note

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

Post process after switching a component’s graphic
representation.

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As SchGRR
…
objThisIntf.AppPostSwitchGraphicProcessobjArg1
Parameters:

i_grr (SchGRR) –

Return type:

None

app_post_uninsert_process(i_old_app_route1: SchRoute, i_old_app_route2: SchRoute, i_new_app_route: SchRoute) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppPostUninsertProcess(SchRoute iOldAppRoute1,
SchRoute iOldAppRoute2,
SchRoute iNewAppRoute)

Post process after uninserting a component, disconnecting it from a
route.

Parameters:

iOldAppRoute1
One of the route that was connected to one connector of the
inserted component before the operation.
iOldAppRoute2
The other route that was connected to the other connector of the
inserted component before the operation. This would be NULL if the component
was connected at extremity.
iNewAppRoute
The new route created after the operation. This would be NULL if
the component was connected at extremity.

Example:



Dim objThisIntf As SchAppComponent
Dim objArg1 As SchRoute
Dim objArg2 As SchRoute
Dim objArg3 As SchRoute
…
objThisIntf.AppPostUninsertProcessobjArg1,objArg2,objArg3
Parameters:
Return type:

None