pycatia.cat_sch_platform_interfaces.sch_app_route

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_route.SchAppRoute(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
SchAppRoute

Manage a schematic route.
app_break() → AnyObject

Note

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

Break the application route into 2 routes.

Parameters:

oNewAppRoute
New application route

Example:

Dim objThisIntf As SchAppRoute
Dim objArg1 As AnyObject
…
Set objArg1 = objThisIntf.AppBreak
Return type:

AnyObject

app_create_local_reference(i_document_to_put_copy_in: Document) → SchAppRoute

Note

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

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

Parameters:

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

Example:



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

i_document_to_put_copy_in (Document) –

Return type:

SchAppRoute

app_ok_to_branch(i_branch_class_type: str, o_b_yes: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AppOKToBranch(CATBSTR iBranchClassType,
boolean oBYes)

Query whether it is OK to create branch.

Parameters:

iBranchClassType
Class type of the branch to create.
oBYes
If TRUE, then it is OK to create a branch from an application route

Example:

Dim objThisIntf As SchAppRoute
Dim strVar1 As String
Dim bVar2 As boolean
…
objThisIntf.AppOKToBranchstrVar1,bVar2
Parameters:

  • i_branch_class_type (str) –

  • o_b_yes (bool) –

Return type:

None

app_ok_to_break(o_b_yes: bool) → None

Note

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

Query whether it is OK to break.

Parameters:

oBYes
If TRUE, then it is OK to break the application route


Example:



Dim objThisIntf As SchAppRoute
Dim bVar1 As boolean
…
objThisIntf.AppOKToBreakbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_concatenate(o_b_yes: bool) → None

Note

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

Query whether it is OK to concatenate.

Parameters:

oBYes
If TRUE, then it is OK to concatenate the application route with
another

Example:

Dim objThisIntf As SchAppRoute
Dim bVar1 As boolean
…
objThisIntf.AppOKToConcatenatebVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_ok_to_modify_points(o_b_yes: bool) → None

Note

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

Query whether it is OK to modify (add or remove) the
points.

Parameters:

oBYes
If TRUE, then it is OK to add or remove the points from the
application route

Example:

Dim objThisIntf As SchAppRoute
Dim bVar1 As boolean
…
objThisIntf.AppOKToModifyPointsbVar1
Parameters:

o_b_yes (bool) –

Return type:

None

app_post_break_process(i_old_app_route: SchRoute, i_new_app_route: SchRoute) → None

Note

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

Post process after breaking an application route into 2
pieces.

Parameters:

iOldAppRoute
The old application route object
iNewAppRoute
The new Application route object

Example:

Dim objThisIntf As SchAppRoute
Dim objArg1 As SchRoute
Dim objArg2 As SchRoute
…
objThisIntf.AppPostBreakProcessobjArg1,objArg2
Parameters:
Return type:

None

app_post_concatenate_process(i_sch_route2: SchRoute) → None

Note

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

Post process after concatenate 2 application routes into
one.

Parameters:

iSchRoute2
Second route to be concatenate to this. This route will be deleted.

Example:

Dim objThisIntf As SchAppRoute
Dim objArg1 As SchRoute
…
objThisIntf.AppPostConcatenateProcessobjArg1
Parameters:

i_sch_route2 (SchRoute) –

Return type:

None