All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamUpgrade

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

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


interface CATISamUpgrade

Upgrade Analysis Sets or Entities.
Role: This interface is implemented on analysis entity or analysis sets.

It is called before the feature edition in order to upgrade the instances.

BOA information: this interface can 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.


Method Index


o NeedToUpgrade()
Returns if the startup nedds to be upgraded.
o Upgrade()
Upgrade the instance.

Methods


o NeedToUpgrade
public virtual CATBoolean NeedToUpgrade()= 0
Returns if the startup nedds to be upgraded.
Returns:
Status of upgrade need.
Legal values:
  • TRUE Instance needs to be upgraded.
  • FALSE No need to upgrade.
o Upgrade
public virtual HRESULT Upgrade()= 0
Upgrade the instance. CATEAnalysisUpgrade to see the default behavoir.

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

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