All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisScan

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

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


interface CATISamAnalysisScan

Interface for scanning the Analysis features.
Role: Interface designed to scan the Analysis Feature model in order to find sets and allow a set to be referenced by a Case.
This interface is implemented by the feature AnalysisCase and AnalysisModel.
The search criterion can take the Legal values:

See also:
SAM_Quality, SAM_QualitySearch, CATISamAnalysisSet


Method Index


o AddSet(CATISamAnalysisSet*,SAM_Quality)
Adds a previously created set under a AnalysisCase or AnalysisModel.
o ChangePosition(CATISamAnalysisSet*,CATISpecObject*,SAM_Quality,int)
Change the position of an AnalysisSet inside the list of references.
o GetAllSets(CATLISTV(CATBaseUnknown_var)&,SAM_QualitySearch)
Retrieves all sets under a AnalysisCase.
o GetNamedSet(CATUnicodeString&,CATISamAnalysisSet_var&,SAM_QualitySearch)
Retrieves a set with a given name referenced under a AnalysisCase.
o GetTypedSet(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&,SAM_QualitySearch)
Retrieves a set with a given type referenced under a AnalysisCase.
o RemoveSet(CATISamAnalysisSet*,SAM_QualitySearch)
Removes a set reference under a AnalysisCase or AnalysisModel.

Methods


o AddSet
public virtual HRESULT AddSet( const CATISamAnalysisSet* iSet,
SAM_Quality iQuality= Sam_NEUTRAL) = 0
Adds a previously created set under a AnalysisCase or AnalysisModel.
Note : These method needs that the implementing feature and the set are defined in the same document.
Parameters:
iSet
The set to add.
iQuality
The quality of the Set for the update. Default value is no impact.
o ChangePosition
public virtual HRESULT ChangePosition( const CATISamAnalysisSet* iSet,
const CATISpecObject* iPositionSet,
SAM_Quality iQuality,
int iBeforeAfter) = 0
Change the position of an AnalysisSet inside the list of references.
Parameters:
iSet
The set to be positionned.
iPositionSet
The positionning set. If NULL, the first position will be choosen
and iBeforeAfter will not be used.
iQuality
The quality of the Set for the update.
iBeforeAfter
The kind of positionning.
Legal values:
  • 1 Before iPositionSet.
  • 2 After iPositionSet.
o GetAllSets
public virtual HRESULT GetAllSets(CATLISTV(CATBaseUnknown_var)& oSetsList,
SAM_QualitySearch iSearch= Sam_SearchEverywhere) const = 0
Retrieves all sets under a AnalysisCase.
Parameters:
oSetsList
The collection of the sets Found.
iSearch
The search criterion.
o GetNamedSet
public virtual HRESULT GetNamedSet( const CATUnicodeString& iName,
CATISamAnalysisSet_var& oFoundSet,
SAM_QualitySearch iSearch= Sam_SearchEverywhere) const = 0
Retrieves a set with a given name referenced under a AnalysisCase.
Parameters:
iName
The name of the Set to retrieve.
oFoundSet
The set Found.
iSearch
The search criterion.
o GetTypedSet
public virtual HRESULT GetTypedSet( const CATUnicodeString& iType,
CATLISTV(CATBaseUnknown_var)& oSetsList,
SAM_QualitySearch iSearch= Sam_SearchEverywhere) const = 0
Retrieves a set with a given type referenced under a AnalysisCase.
Parameters:
iType
The type of the set to retrieve.
oSetsList
The collection of the sets Found.
iSearch
The search criterion.
o RemoveSet
public virtual HRESULT RemoveSet( const CATISamAnalysisSet* iSet,
SAM_QualitySearch iSearch= Sam_SearchEverywhere) const = 0
Removes a set reference under a AnalysisCase or AnalysisModel.
Parameters:
iSet
The set to be added.
iQuality
The quality of the Set for the update. Default value is Everywhere.

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

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