All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchAppRoute

System.IUnknown
  |
  +---CATISchAppRoute
 

Usage: you can freely reimplement this interface.


interface CATISchAppRoute

Interface to manage an application route object.
Role: Defines application route object behaviors


Method Index


o AppBreak(IUnknown**)
Break the application route into 2 routes.
o AppCreateLocalReference(CATDocument*,CATISchAppRoute**)
Make a local route reference in another document by copying an existing one in the current document.
o AppOKToBranch(char*,CATBoolean*)
Query whether it is OK to create branch.
o AppOKToBreak(CATBoolean*)
Query whether it is OK to break.
o AppOKToConcatenate(CATBoolean*)
Query whether it is OK to concatenate.
o AppOKToModifyPoints(CATBoolean*)
Query whether it is OK to modify (add or remove) the points.
o AppPostBreakProcess(CATISchRoute*,CATISchRoute*)
Post process after breaking an application route into 2 pieces.
o AppPostConcatenateProcess(CATISchRoute*)
Post process after concatenate 2 application routes into one.

Methods


o AppBreak
public virtual HRESULT AppBreak(IUnknown** oNewAppRoute) = 0
Break the application route into 2 routes.
Parameters:
oNewAppRoute
New application route
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppCreateLocalReference
public virtual HRESULT AppCreateLocalReference(CATDocument* iDocumentToPutCopyIn,
CATISchAppRoute** oSchAppRoute) = 0
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.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOKToBranch
public virtual HRESULT AppOKToBranch( const char* iBranchClassType,
CATBoolean* oBYes) = 0
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
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOKToBreak
public virtual HRESULT AppOKToBreak(CATBoolean* oBYes) = 0
Query whether it is OK to break.
Parameters:
oBYes
If TRUE, then it is OK to break the application route
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOKToConcatenate
public virtual HRESULT AppOKToConcatenate(CATBoolean* oBYes) = 0
Query whether it is OK to concatenate.
Parameters:
oBYes
If TRUE, then it is OK to concatenate the application route with another
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppOKToModifyPoints
public virtual HRESULT AppOKToModifyPoints(CATBoolean* oBYes) = 0
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
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppPostBreakProcess
public virtual HRESULT AppPostBreakProcess(CATISchRoute* iOldAppRoute,
CATISchRoute* iNewAppRoute) = 0
Post process after breaking an application route into 2 pieces.
Parameters:
iOldAppRoute
The old application route object
iNewAppRoute
The new Application route object
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o AppPostConcatenateProcess
public virtual HRESULT AppPostConcatenateProcess(CATISchRoute* iSchRoute2) = 0
Post process after concatenate 2 application routes into one.
Parameters:
iSchRoute2
Second route to be concatenate to this. This route will be deleted.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchAppRoute.h

Copyright © 2003, Dassault Systèmes. All rights reserved.