All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Class CATSamAnalysisSetImpl

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseObject
        |
        +---CATSamAnalysisSetImpl
 

Usage: you can derive this class.


public class CATSamAnalysisSetImpl

Root object used to implement derived classes of CATIAAnalysisSet.
Declare your interface as interface MyInterface : CATIAAnalysisSet
Implement it as class MyImplementation : public CATSamAnalysisSetImpl.


Constructor and Destructor Index


o CATSamAnalysisSetImpl()
Default Constructor.
o ~CATSamAnalysisSetImpl()
Default Destructor.

Method Index


o GetItem(CATBSTR&,CATBaseDispatch*&)
Returns an object from its name.
o GetResolution(CATIScriptMethodCall*&,CATBaseDispatch*)
Helps the resolution mechanism of the macros generation.
o GiveAccurateExposedInterface(CATBaseDispatch**)
Retrieve the accurate CATBaseDispatch or CATIABase interface on a component.
o Update()
Update an Analysis Set.
o get_AnalysisEntities(CATIAAnalysisEntities*&)
Returns the analysis entities collection associated to a set.
o get_AnalysisImages(CATIAAnalysisImages*&)
Returns the analysis image collection associated with an analysis set.
o get_AnalysisOutputEntities(CATIAAnalysisOutputEntities*&)
Returns the analysis output entities collection associated to a set.
o get_AnalysisSets(CATIAAnalysisSets*&)
Returns the analysis sets collection associated with an analysis set.
o get_BasicComponents(CATIABasicComponents*&)
Returns the BasicComponent collection associated with an analysis set.
o get_Name(CATBSTR&)
Sets the name of the analysis Set.
o get_Parent(CATBaseDispatch*&)
Returns the parent object.
o get_Type(CATBSTR&)
Returns the type of the analysis Set.
o put_Name(CATBSTR&)
Returns the name of the analysis Set.

Constructor and Destructor


o CATSamAnalysisSetImpl
public CATSamAnalysisSetImpl()
Default Constructor.
o ~CATSamAnalysisSetImpl
public virtual ~CATSamAnalysisSetImpl()
Default Destructor.

Methods


o GetItem
public HRESULT GetItem( const CATBSTR& iNameBSTR,
CATBaseDispatch*& oObject)
Returns an object from its name. All implementations should not override this default implementation.
Parameters:
IDName
The searched obect name
Returns:
The searched object All implementations should not override this default implementation.
o GetResolution
public virtual HRESULT GetResolution(CATIScriptMethodCall*& oResolution,
CATBaseDispatch* iObjectToResolve)
Helps the resolution mechanism of the macros generation. Role: This interface must be implemented by objects that want to specify a custom access path in the Automation container-content hierarchy.
It contains a single method which generates a CATIScriptMethodCall. This generated object describes how to access the object from its container.
See also:
CATIAutomationResolution
o GiveAccurateExposedInterface
public virtual HRESULT GiveAccurateExposedInterface(CATBaseDispatch** oBasePointer)
Retrieve the accurate CATBaseDispatch or CATIABase interface on a component. Returns with this methode Your VB Interface build by derivation of CATIAAnalysisSet.
See also:
CATIBaseAccess
o Update
public virtual HRESULT Update()
Update an Analysis Set. All implementations should not override this default implementation.
o get_AnalysisEntities
public HRESULT get_AnalysisEntities(CATIAAnalysisEntities*& oAnalysisEntities)
Returns the analysis entities collection associated to a set. All implementations should not override this default implementation.
o get_AnalysisImages
public HRESULT get_AnalysisImages(CATIAAnalysisImages*& oAnalysisImages)
Returns the analysis image collection associated with an analysis set. All implementations should not override this default implementation.
o get_AnalysisOutputEntities
public HRESULT get_AnalysisOutputEntities(CATIAAnalysisOutputEntities*& oAnalysisEntities)
Returns the analysis output entities collection associated to a set. All implementations should not override this default implementation.
o get_AnalysisSets
public HRESULT get_AnalysisSets(CATIAAnalysisSets*& oAnalysisSets)
Returns the analysis sets collection associated with an analysis set. All implementations should not override this default implementation.
o get_BasicComponents
public HRESULT get_BasicComponents(CATIABasicComponents*& oBasicComponents)
Returns the BasicComponent collection associated with an analysis set. All implementations should not override this default implementation.
o get_Name
public HRESULT get_Name(CATBSTR& oName)
Sets the name of the analysis Set. All implementations should not override this default implementation.
o get_Parent
public virtual HRESULT __stdcall get_Parent(CATBaseDispatch*& oParent)
Returns the parent object.
Role: The parent object of a given object is the object just above in the object structure, usually the object that created this object and that aggregates it. In the case of an object part of a collection, the parent object is not the collection object itself, but the object that aggregates the collection object.
o get_Type
public HRESULT get_Type(CATBSTR& oType)
Returns the type of the analysis Set. All implementations should not override this default implementation.
o put_Name
public HRESULT put_Name( const CATBSTR& iNameBSTR)
Returns the name of the analysis Set. All implementations should not override this default implementation.

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

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