All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisManager

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISamAnalysisManager

Interface to manage Analysis Manager behaviour.
Role:In the Analysis Document, an Analysis Manager is the data dedicated to set and manage the

See also:
CATISamAnalysisModel, CATISamAnalysisCase, CATISamDocumentManager


Method Index


o GetAllAnalysisModels(CATLISTV(CATBaseUnknown_var)&)
Retrieves all the Analysis Models in the context of the Analysis Manager.
o GetAnalysisModelByName(CATUnicodeString&,CATISamAnalysisModel*&)
Retrieves the Analysis Model whose Name is iName.
o GetCurrentModel(CATISpecObject*&)
Retrieves the current Analysis model.
o GetDocumentManager(CATISamDocumentManager_var&)
Retrieves the Document Manager of the current Analysis Manager.
o GetWorkbench(CATString&)
Retrieves the most accurate workbench.
o SetCurrentModel(CATISpecObject*)
Sets the current Analysis model.
o SetWorkbench(CATString&)
Sets the most accurate workbench.

Methods


o GetAllAnalysisModels
public virtual HRESULT GetAllAnalysisModels(CATLISTV(CATBaseUnknown_var)& oAnalysisModels) = 0
Retrieves all the Analysis Models in the context of the Analysis Manager.
Parameters:
oCasesList
collection of cases found.
o GetAnalysisModelByName
public virtual HRESULT GetAnalysisModelByName( const CATUnicodeString& iName,
CATISamAnalysisModel*& opiAnalysisModel) = 0
Retrieves the Analysis Model whose Name is iName.
Parameters:
iName
Name of the case we are looking for.
oAnalysisModel
[out , CATBaseUnknown#Release] The AnalysisModel retreived
o GetCurrentModel
public virtual HRESULT GetCurrentModel(CATISpecObject*& opiModel) const = 0
Retrieves the current Analysis model.
Parameters:
oModel
[out , CATBaseUnknown#Release] The current Analysis model.
Returns:
The call status.
Legal values: S_OK, E_FAIL
o GetDocumentManager
public virtual HRESULT GetDocumentManager(CATISamDocumentManager_var& ospDocumentManager) const = 0
Retrieves the Document Manager of the current Analysis Manager.
Parameters:
oDocumentManager
The document Manager
o GetWorkbench
public virtual HRESULT GetWorkbench(CATString& oWorkbenchName) const = 0
Retrieves the most accurate workbench.
Parameters:
oWorkbenchName
o SetCurrentModel
public virtual HRESULT SetCurrentModel( const CATISpecObject* ipiModel) = 0
Sets the current Analysis model.
Parameters:
iModel
The Analysis model to set as current. The CATISpecObject is to be considered as a CATISamAnalysisModel.
Returns:
The call status.
Legal values: S_OK, E_FAIL
o SetWorkbench
public virtual HRESULT SetWorkbench( const CATString& iWorkbenchName) = 0
Sets the most accurate workbench.
Parameters:
iWorkbenchName
the identifier of the Workbench

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

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