All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisResources Class CATEAnalysisSetInit
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATAnalysisInterfaces.CATISamAnalysisSetInit
|
+---CATEAnalysisSetInit
Usage: you can derive this class.
public class CATEAnalysisSetInit
Adapter for the implementation of CATISamAnalysisSetInit interface.
It can be used for AnalysisSet.
- See also:
- CATISamAnalysisSetInit
Constructor and Destructor Index
- o
CATEAnalysisSetInit()
- Default constructor.
- o
~CATEAnalysisSetInit()
- Destructor.
Method Index
- o
CheckAnalysisParent(CATBaseUnknown*,SAM_Quality&)
- Checks if an Analysis feature 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.
Constructor and Destructor
o CATEAnalysisSetInit
public CATEAnalysisSetInit( | ) |
-
Default constructor.
o ~CATEAnalysisSetInit
public virtual ~CATEAnalysisSetInit( | ) |
-
Destructor.
Methods
o CheckAnalysisParent
-
Checks if an Analysis feature is allowed.
Warning : this method will be called on a StartUp and therefor some CATISamExplicit methods will not work.
- Parameters:
-
- ipiAnalysisSet
- Interface pointer on the candidate parent.
- Returns:
-
Legal values:
- 0 the parent is not valid.
- 1 the parent is valid.
o InitWhenPositioned
-
Initializes the analysis set.
This Method is called after the set is positioned under it's parent.
- Parameters:
-
- oQuality
- ipiAnalysisParent The parent.
o Initialize
public virtual HRESULT Initialize( | ) |
-
Initializes the analysis set.
(This Method is systematically called after the entity creation).
o Remove
public virtual HRESULT Remove( | int | iForCloseContext) |
-
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 reimplementing a LifeCycleObject implementation
o ReorderInScan
-
Change the position of an AnalysisSet inside the list of references.
- Parameters:
-
- ipiScan
- The CATISamAnalysisScan Object in wich the set is defined.
This object is included in the file: CATEAnalysisSetInit.h
If needed, your Imakefile.mk should include the module: CATAnalysisResources