CATDraftingGenUseItf Interface CATIDftGenViewUpdate
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftGenViewUpdate
This interface is dedicated to the update of generative drafting views.
Role: This interface is implemented by hlrview object (applicative extension of the view).
Method Index
- o
ForceUpdate(DftGenUpdate)
- Forces the update of the generative view.
- o
GetGenViewUpdateStatus(CATBoolean*)
- Get the update status of the generative view.
- o
Update(DftGenUpdate)
- Updates the generative view.
Enumerated Type Index
- o
DftGenUpdate
- Update mode.
Methods
o ForceUpdate
| public virtual ForceUpdate( | | iMode | = UpdateDftGenSpecAndInitVisu) |
-
Forces the update of the generative view.
Role: This method allows to force the update of the view even if not necessary.
- Returns:
- S_OK : if everything ran ok.
S_FALSE : succeeded but nothing was updated since the generated view was locked.
E_FAIL : if the operation failed.
o GetGenViewUpdateStatus
| public virtual GetGenViewUpdateStatus( | | oUpdateStatus) |
-
Get the update status of the generative view.
- Parameters:
-
-
-
- oUpdateStatus : TRUE if the view is up-to-date.
- Returns:
-
- S_OK
- if the operation succeeded.
- E_FAIL
- if the operation failed.
o Update
| public virtual Update( | | iMode | = UpdateDftGenSpecAndInitVisu) |
-
Updates the generative view.
Role: This method allows to update a generative view.
- Returns:
- S_OK : if everything ran ok.
S_FALSE : succeeded but nothing was updated since the generated view was up-to-date or locked.
E_FAIL : if the operation failed.
Enumerated Types
o DftGenUpdate
-
enum DftGenUpdate {
UpdateDftGenSpec,
UpdateDftGenSpecAndInitVisu,
UpdateDftGenSimplified
}
Update mode.
The generative view is updated:
- Parameters:
-
- UpdateDftGenSpec
- without initializing the visualization of generated items.
- UpdateDftGenSpecAndInitVisu
- initializing the visualization of generated items.
- UpdateDftGenSimplified
- and a simplified result is computed till the view is updated.
This object is included in the file: CATIDftGenViewUpdate.h
If needed, your Imakefile.mk should include the module: CATDraftingGenUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.