All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectSpecsModeler Interface CATIUpdateProvider

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIUpdateProvider
 

Usage: you can freely reimplement this interface.


interface CATIUpdateProvider

Interface used to include a base feature's extension in the update process.
Role: overrides the default update behavior for feature extensions.

See also:
CATIOsmUpdate


Method Index


o IsInactive(CATBaseUnknown*)
Forces an updatable object to be ignored by the update mechanism.
o IsUpToDate(CATBaseUnknown*,CATIDomain_var)
Returns the status of the object concerning the update mechanism.
o SetUpToDate(CATBaseUnknown*,boolean)
Modifies the status of the updatable object.
o Update(CATBaseUnknown*,CATIDomain_var)
Rebuilds the feature ( generate the result ).

Methods


o IsInactive
public virtual int IsInactive(CATBaseUnknown* iWorkingObj) const=0
Forces an updatable object to be ignored by the update mechanism.
Parameters:
iWorkingObj
The base feature object.
Returns:
0 : default implementation, always active.
o IsUpToDate
public virtual CATBoolean IsUpToDate(CATBaseUnknown* iWorkingObj,
CATIDomain_var iDomain=NULL_var) const = 0
Returns the status of the object concerning the update mechanism.
Parameters:
iWorkingObj
The base feature object.
iDomain
The application domain of the update ( not used ).
Returns:
TRUE : the object has been updated. FALSE : the object has to be updated.
o SetUpToDate
public virtual void SetUpToDate(CATBaseUnknown* iWorkingObj,
boolean iFlag)=0
Modifies the status of the updatable object.
Parameters:
iWorkingObj
The base feature object.
iFlag
TRUE : the object has just been updated FALSE: the object needs to be rebuilt
o Update
public virtual int Update(CATBaseUnknown* iWorkingObj,
CATIDomain_var iDomain= NULL_var) = 0
Rebuilds the feature ( generate the result ). Note: The default update mechanism detects all features that have been modified upstream from a feature, rebuilds all the feature impacting the updated feature, and finally rebuild the final feature.
Parameters:
iWorkingObj
The base feature object.
iDomain
The application domain of the update ( not used ).

This object is included in the file: CATIUpdateProvider.h
If needed, your Imakefile.mk should include the module: CATObjectSpecsModeler

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