All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectSpecsModeler Interface CATIOsmUpdate

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

Usage: you can reimplement this interface by deriving the supplied CATOsmUpdateAdapter adapter class.


interface CATIOsmUpdate

Interface dedicated to the Build/Update mechanism.
Role: This interface is used internally by the CATISpecObject implementation. It allows

This interface is to be implemented only, not used.
Usage: You can reimplement this interface only by deriving the supplied CATOsmUpdateAdapter class.
Check this adapter class for details on how to implement the interface.

BOA information: this interface must be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

See also:
CATISpecObject
See also:
CATIBuild


Method Index


o IsInactive()
Indicates whether the object must be ignored by the update mechanism.
o IsUpToDate()
Returns the status of the object concerning the update mechanism.
o SetUpToDate(CATBoolean)
Modifies the object update status.
o Update()
Rebuilds the feature.

Methods


o IsInactive
public virtual HRESULT IsInactive()const=0
Indicates whether the object must be ignored by the update mechanism.
Returns:
S_OK if the object should be ignored by the update mechanism, S_FALSE otherwise.
o IsUpToDate
public virtual HRESULT IsUpToDate()const = 0
Returns the status of the object concerning the update mechanism.
Returns:
CATBoolean
  • S_OK : the object has been updated.
  • S_FALSE : the object has to be updated.
o SetUpToDate
public virtual HRESULT SetUpToDate(CATBoolean iflag)=0
Modifies the object update status.
Role: This method changes the up to date status of the object. It is called every time the object's status changes. The status may change either because an input of the object changes, or because the object is updated or someone directly calls CATISpecObject.SetUpToDate .
Parameters:
iflag
The new status.
  • TRUE : the object has just been updated. You are not allowed to call SetUpToDate(TRUE).
  • FALSE: the object needs to be rebuild.
o Update
public virtual HRESULT Update()= 0
Rebuilds the feature.
Role: This method will be called internally by CATISpecObject.Update if the startup implements CATIOsmUpdate. It allows applications to override the default method mechanism.
This method should not be used: use instead the Update method defined in CATISpecObject .
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 rebuilds the final feature thanks to the CATIBuild interface.
This method can throw exceptions.
Returns:
S_OK if update succeeded, E_FAIL otherwise (the update process is then aborted).

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

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