All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamAnalysisSetInit

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

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


interface CATISamAnalysisSetInit

Customize analysis set management.
Role: This interface allows to

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.

See also:
CATISamAnalysisSet


Method Index


o CheckAnalysisParent(CATBaseUnknown*,SAM_Quality&)
Checks if an Analysis parent is allowed.
o InitWhenPositioned(CATBaseUnknown*)
Initializes the analysis set.
o Initialize()
Initializes the analysis set.
o Remove(int)
Removes the object.
o ReorderInScan(CATISamAnalysisScan*)
Change the position of an AnalysisSet inside the list of references.

Methods


o CheckAnalysisParent
public virtual int CheckAnalysisParent( const CATBaseUnknown* ipiAnalysisParent,
SAM_Quality& oQuality) = 0
Checks if an Analysis parent is allowed. Warning : this method will be called on a StartUp and therefor some CATISamExplicit methods will not work.
Parameters:
ipiAnalysisSet
Interface pointer on a possible parent for the set.
oQuality
Returns:

Legal values:
  • 0 the set is not valid.
  • 1 the set is valid.
o InitWhenPositioned
public virtual HRESULT InitWhenPositioned( const CATBaseUnknown* ipiAnalysisParent) = 0
Initializes the analysis set. This Method is called after the set is positioned under it's parent by using CATISamAnalysisScan.AddSet
Parameters:
oQuality
ipiAnalysisParent The parent.

No specific behavoir is associated to the returned HRESULT.

o Initialize
public virtual HRESULT Initialize()= 0
Initializes the analysis set.
(This Method is systematically called after the set creation).

No specific behavoir is associated to the returned HRESULT.

o Remove
public virtual HRESULT Remove(int iForCloseContext) = 0
Removes the object.
Parameters:
iForCloseContext
param to specify context of remove. If removes happens while closing a document, some actions don't need to be execute for example.
1 if remove acts while closing a document ... Note: Prefer this method to LifeCycleObject implementation

No specific behavoir is associated to the returned HRESULT.

o ReorderInScan
public virtual HRESULT ReorderInScan( const CATISamAnalysisScan* ipiScan) = 0
Change the position of an AnalysisSet inside the list of references.
Parameters:
ipiScan
The CATISamAnalysisScan Object in which the set is defined.

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

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