SchAppRoute (Object)

Manage a schematic route.

Methods


Func AppBreak() As
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
Func AppCreateLocalReference( iDocumentToPutCopyIn) As
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)
Sub AppOKToBranch( iBranchClassType, 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
Sub AppOKToBreak( 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
Sub AppOKToConcatenate( 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
Sub AppOKToModifyPoints( 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
Sub AppPostBreakProcess( iOldAppRoute, 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
Sub AppPostConcatenateProcess( 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