All Frameworks Class Hierarchy This Framework Previous Next Indexes
OptimizationInterfaces Interface CATIOptUpdateManagement
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIOptUpdateManagement
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIOptUpdateManagement
Interface to ask for an update model in the Optimization context.
The optimization feature adheres to this interface.
Method Index
- o
AfterLastUpdate()
- This method is called after the last update asked by the optimization.
- o
BeforeFirstUpdate()
- This method is called before the first update asked by the optimization algorithm.
- o
BeforeLastUpdate()
- This method is called before the last update asked by the optimization algorithm.
- o
GetAverageUpdateDuration()
- Returns the average update duration since last reset (ResetUpdateDurationCalculus).
- o
GetLastUpdateDuration()
- Returns the last update duration.
- o
Init()
- Initializes the update engine on the current document, in accordance with the given inputs and outputs.
- o
LaunchUpdate(int)
- Launches the ouputs computations in accordance with the inputs modifications.
- o
ResetUpdateDurationCalculus()
- Resets the average update duration calculus.
- o
SetInputs(CATLISTV(CATBaseUnknown_var)*)
- Initializes the list of objects whose modifications will be taken in account during the update.
- o
SetOutputs(CATLISTV(CATBaseUnknown_var)*)
- Initializes the list of objects that will be recomputed.
Enumerated Type Index
- o
PEOUpdateMode
- Arguments for the method SetUpdateMode.
Methods
o AfterLastUpdate
public virtual void AfterLastUpdate( | )= 0 |
-
This method is called after the last update asked by the optimization.
It has a cleaning purpose.
o BeforeFirstUpdate
public virtual void BeforeFirstUpdate( | )= 0 |
-
This method is called before the first update asked by the optimization algorithm.
It has an initialization purpose.
o BeforeLastUpdate
public virtual void BeforeLastUpdate( | )= 0 |
-
This method is called before the last update asked by the optimization algorithm.
It has a warning and preparatory exit purpose.
o GetAverageUpdateDuration
public virtual double GetAverageUpdateDuration( | )= 0 |
-
Returns the average update duration since last reset (ResetUpdateDurationCalculus).
- Returns:
- The average update duration in seconds.
o GetLastUpdateDuration
public virtual long GetLastUpdateDuration( | )= 0 |
-
Returns the last update duration.
- Returns:
- The average update duration in seconds.
o Init
public virtual void Init( | )= 0 |
-
Initializes the update engine on the current document, in accordance with the given inputs and outputs.
!!! You have to call it after calling the SetInputs() and/or SetOutputs() methods !!!
o LaunchUpdate
public virtual int LaunchUpdate( | int | beforeLastUpdate | = 0) = 0 |
-
Launches the ouputs computations in accordance with the inputs modifications.
- Parameters:
-
- beforeLastUpdate
- Set it to 1 if you are calling this method for the last time.
- Returns:
- 1 if update succeeded, 0 else.
FIXME: add a policy for editability.
o ResetUpdateDurationCalculus
public virtual void ResetUpdateDurationCalculus( | )= 0 |
-
Resets the average update duration calculus.
o SetInputs
-
Initializes the list of objects whose modifications will be taken in account during the update.
the
CATIOptUpdateManagement.LaunchUpdate computes the new values of outputs.
- Parameters:
-
- objects
- : the list of object to taken into account.
o SetOutputs
-
Initializes the list of objects that will be recomputed.
It is done in accordance with the inputs modifications at each call of the
CATIOptUpdateManagement.LaunchUpdate method.
- Parameters:
-
- objects
- : the list of objects to be recomputed.
Enumerated Types
o PEOUpdateMode
-
enum PEOUpdateMode {
GlobalWithUnload,
GlobalWithoutUnload,
LeanWithUnload,
LeanWithoutUnload,
Mixed,
NotSet
}
Arguments for the method SetUpdateMode.
Defines the behavior of the Update used by the optimization.
- Lean: the optimization only updates its outputs.
- Global: the optimization updates the documents globally.
- Unload: during the update the model can be partially unloaded.
- Mixed: In the context of Part documents this stratgey consists in first updating variational elements
of the full document and then to update the skectches and finish by the output of the optimization.
This mode has no meaning in the context of CATProducts
This object is included in the file: CATIOptUpdateManagement.h
If needed, your Imakefile.mk should include the module: OptimizationItf