All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisModel

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

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


interface CATISamAnalysisModel

Interface to define the analysis Model.
Role: In the analysis document, an Analysis Model is the feature dedicated to set and manage all the required data for the discretization and idealization of a Finite Element model.


Method Index


o AddCase(CATISamAnalysisCase*,CATBoolean)
Adds a previously created case under the analysis model in the tree.
o GetAllCases(CATLISTV(CATBaseUnknown_var)&)
Retrieves all the cases in the context of the Analysis model.
o GetCurrentCase(CATISamAnalysisCase*&)
Retrieves the current case in the context of the Analysis model.
o GetImageModel(CATISamImageModel*&)
Retrieves the CATISamImageModel.
o GetInternalCount()
Return an Integer Value.
o GetMesh(CATBaseUnknown*&)
Retrieves the Mesh Set associated with the Finite Element Model.
o GetMeshNegociator(CATISamMeshNegociator*&)
Retrieves the Mesh Set Negociator associated with the Finite Element Model.
o GetNamedCase(CATUnicodeString&,CATISamAnalysisCase*&)
Retrieves a created case with a given under the analysis model.
o RemoveAnalysisFeature(CATISpecObject*)
Removes analysis feature from the Analysis Model.
o SetCurrentCase(CATISamAnalysisCase*,CATBoolean)
Sets the current case in the context of the Analysis model.
o SetMesh(CATBaseUnknown*)
Sets the Mesh Set associated with the Finite Element Model.

Methods


o AddCase
public virtual HRESULT AddCase( const CATISamAnalysisCase* iCase,
CATBoolean iUpdateVisualization=TRUE) = 0
Adds a previously created case under the analysis model in the tree.
Parameters:
iCase.
The case to be added.
iUpdateVisualization.
Defines the impact on current visualization.
Legal values:
  • TRUE Previous current case (and all its children) is hidden.
  • FALSE Previous current case visualization is keept.
o GetAllCases
public virtual HRESULT GetAllCases(CATLISTV(CATBaseUnknown_var)& oCasesList) = 0
Retrieves all the cases in the context of the Analysis model.
Parameters:
oCasesList
Collection of cases found.
o GetCurrentCase
public virtual HRESULT GetCurrentCase(CATISamAnalysisCase*& oCase) = 0
Retrieves the current case in the context of the Analysis model.
Parameters:
oCase
[out , CATBaseUnknown#Release] The current Case.
o GetImageModel
public virtual HRESULT GetImageModel(CATISamImageModel*& oImageModel) = 0
Retrieves the CATISamImageModel.
Parameters:
oImageModel
[out , CATBaseUnknown#Release] The image model manager.
o GetInternalCount
public virtual int GetInternalCount()= 0
Return an Integer Value.
o GetMesh
public virtual HRESULT GetMesh(CATBaseUnknown*& oMesh) const = 0
Retrieves the Mesh Set associated with the Finite Element Model.
Parameters:
oMesh
[out , CATBaseUnknown#Release] Mesh Set associated.
o GetMeshNegociator
public virtual HRESULT GetMeshNegociator(CATISamMeshNegociator*& oMeshNegociator) = 0
Retrieves the Mesh Set Negociator associated with the Finite Element Model.
Parameters:
oMeshNegociator
[out , CATBaseUnknown#Release] Mesh Negociator associated.
o GetNamedCase
public virtual HRESULT GetNamedCase( const CATUnicodeString& iName,
CATISamAnalysisCase*& oFoundCase) = 0
Retrieves a created case with a given under the analysis model.
Parameters:
iName
Name value for search.
oFoundCase
[out , CATBaseUnknown#Release] Case found.
o RemoveAnalysisFeature
public virtual HRESULT RemoveAnalysisFeature( const CATISpecObject* iAnalysisFeature) = 0
Removes analysis feature from the Analysis Model.
This methode will effectivelly delete the feature. For example, if you delete an analysiset, the set will be removed from all the cases that referenced it and removed from the document.
Parameters:
iAnalysisFeature
The feature to remove. Note that the set must be created using the
CATISamAnalysisModelFactory.CreateUserSet method
where the iContainingObject is the AnalysisModel.
o SetCurrentCase
public virtual HRESULT SetCurrentCase( const CATISamAnalysisCase* iCase,
CATBoolean iUpdateVisualization=TRUE) = 0
Sets the current case in the context of the Analysis model.
Parameters:
iCase
The Case to make current.
iUpdateVisualization.
Defines the impact on current visualization.
Legal values:
  • TRUE Previous current case (and all its children) is hidden.
  • FALSE Previous current case visualization is keept.
o SetMesh
public virtual HRESULT SetMesh(CATBaseUnknown* iMesh) = 0
Sets the Mesh Set associated with the Finite Element Model.
Parameters:
iMesh
Mesh Set to be associated.

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

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