All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisResources Class CATEAnalysisUpgrade

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

Usage: you can derive this class.


public class CATEAnalysisUpgrade

Adapter for the implementation of CATISamUpgrade interface.
It can be used for AnalysisEntity or AnalysisSet.

See also:
CATISamUpgrade


Constructor and Destructor Index


o CATEAnalysisUpgrade()
Default constructor.
o ~CATEAnalysisUpgrade()
Default destructor.

Method Index


o CheckMultiLayer(CATISamBasicComponent*)
Toolkit MultiLayerManager.
o FindInList(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Toolkit to retrieve if a basic component name is in the list.
o GetValuesOnInstanceOrStartup(CATBoolean,CATISpecObject*)
Retrieves the list of values attributes.
o NeedToUpgrade()
Returns if the startup needs to be upgraded.
o RemoveBasicComp(CATISamBasicComponent*)
Removes a basic componenent.
o Upgrade()
Upgrade the instance.
o UpgradeMultiLayer(CATISamBasicComponent*)
Toolkit MultiLayerManager.

Constructor and Destructor


o CATEAnalysisUpgrade
public CATEAnalysisUpgrade()
Default constructor.
o ~CATEAnalysisUpgrade
public virtual ~CATEAnalysisUpgrade()
Default destructor.

Methods


o CheckMultiLayer
public CATBoolean CheckMultiLayer( const CATISamBasicComponent* ipiBasicComp)
Toolkit MultiLayerManager.

Allows to add new columns defined in the startup based on a comparison of the instance and it's startup.

Parameters:
ipiBasicComp
The MultiLayerManager basic component.
o FindInList
public CATBoolean FindInList( const CATUnicodeString& iName,
const CATLISTV(CATBaseUnknown_var)& iLCompThis)
Toolkit to retrieve if a basic component name is in the list.
Parameters:
iName
Name to Retrieve.
iLCompThis
The list.
Returns:
TRUE is in the list.
Legal values:
  • TRUE Is in the list.
  • FALSE Not in the list.
o GetValuesOnInstanceOrStartup
public CATListValCATBaseUnknown_var* GetValuesOnInstanceOrStartup(CATBoolean iOnStartUp,
const CATISpecObject* ipiInstance)
Retrieves the list of values attributes.
Parameters:
iOnStartUp
informs is check is done on startup TRUE or on the instance FALSE
ipiInstance
Instance pointer.
o NeedToUpgrade
public virtual CATBoolean NeedToUpgrade()
Returns if the startup needs to be upgraded.
Returns:
Status of upgrade need.
The default implementation is based on a comparison of the instance and it's startup.
Legal values:
  • TRUE Instance needs to be upgraded.
  • FALSE No need to upgrade.
o RemoveBasicComp
public HRESULT RemoveBasicComp( const CATISamBasicComponent* ipiBasicComp)
Removes a basic componenent.
Parameters:
ipiBasicComp
Instance pointer.
o Upgrade
public virtual HRESULT Upgrade()
Upgrade the instance. The default implementation is based on a comparison of the instance and it's startup.
It adds the basic components defined on the startup and missing on the instance.
o UpgradeMultiLayer
public HRESULT UpgradeMultiLayer( const CATISamBasicComponent* ipiBasicComp)
Toolkit MultiLayerManager.

Allows to add new columns defined in the startup based on a comparison of the instance and it's startup.

Parameters:
ipiBasicComp
The MultiLayerManager basic component.

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

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