All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamExplicit

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

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


interface CATISamExplicit

Interface to manage the Field model link.
Role: Interface used by an analysis feature to manage it's result view in the Field model.
It means:

See also:
CATISamExplicitation


Method Index


o GetContainingData(CATAnalysisExplicitListUsr&,CATAnalysisExplicitListUsr&,CATString*)
Return data that currently contain the explicit entities of the given given type.
o GetExplicitModel()
Retrieves the explicit model associated.
o GetExplicitObject(CATAnalysisExplicitChild&,int)
Retrieves one of the Explicit object(s) created for the analysis feature translation.
o GetExplicitObjects(CATAnalysisExplicitListUsr&)
Retrieves the explicit datum corresponding to the given index.
o GetExplicitTag(int)
Retrieves the tag of the explicit datum corresponding to the given index.
o GetExplicitTags(CATListOfInt&)
Retrieves the tags of the Explicit object(s) generated during the translation.
o GetExplicitTagsNumber()
Retrieves the number of Explicit object(s) generated.
o GetPhysicalType()
Retrieves the Physical type of the feature.
o GetPhysicalTypeNumber()
Retrieves the Physical type of the feature.
o LogCreateDelete(CATBoolean,CATAnalysisExplicitListUsr&)
Toolkit to manage local creation of deletion children.
o UpdateExplicitList(CATAnalysisExplicitListUsr&,CATAnalysisExplicitListUsr&,CATAnalysisExplicitListUsr&)
Update the explicit Lists of Objects that are created inside the field model.

Methods


o GetContainingData
public virtual HRESULT GetContainingData(CATAnalysisExplicitListUsr& iexplObjects,
CATAnalysisExplicitListUsr& oContainingData,
CATString* iChildPhysType= NULL) = 0
Return data that currently contain the explicit entities of the given given type. Explicit List of Objects generated by CATISamExplicitation Iplementation.
Parameters:
oContainingData
explicit List which contain the explicit version of this analysis entity.
iChildPhysType
the entity physical type dedicated to filter the returned containing data. Warning! The explicitation of an analysis entity can consist in the creation of several kind of explicit entities. On the other hand, we suppose that every entities of a given kind have the same containing data.
o GetExplicitModel
public virtual CATAnalysisExplicitModel* GetExplicitModel()const = 0
Retrieves the explicit model associated.
Parameters:
returns
the CATAnalysisExplicitModel
o GetExplicitObject
public virtual HRESULT GetExplicitObject(CATAnalysisExplicitChild& oChild,
int iObjectIndex= 1) = 0
Retrieves one of the Explicit object(s) created for the analysis feature translation.
Parameters:
oChild
The Explicit datum corresponding to given index.
iObjectIndex
The index of the explicit datum. This index must be less or equal to the total number of Explicit object(s).
o GetExplicitObjects
public virtual HRESULT GetExplicitObjects(CATAnalysisExplicitListUsr& oExplObjects) = 0
Retrieves the explicit datum corresponding to the given index.
Parameters:
oExplObjects
The list which contains the Explicit object(s) corresponding to the analysis feature translation.
o GetExplicitTag
public virtual int GetExplicitTag(int iObjectIndex= 1) = 0
Retrieves the tag of the explicit datum corresponding to the given index.
Parameters:
iObjectIndex
Index of the explicit datum.
This index must be less or equal to the total number of Explicit object(s).
Returns:
the tag of the explicit datum.
o GetExplicitTags
public virtual HRESULT GetExplicitTags(CATListOfInt& oExplicitTags) = 0
Retrieves the tags of the Explicit object(s) generated during the translation.
Parameters:
oExplicitTags
The list of explicit tags.
o GetExplicitTagsNumber
public virtual int GetExplicitTagsNumber()= 0
Retrieves the number of Explicit object(s) generated.
Returns:
the number of explicit children.
o GetPhysicalType
public virtual CATString GetPhysicalType()const = 0
Retrieves the Physical type of the feature.
Returns:
the physical type identifer as String
o GetPhysicalTypeNumber
public virtual CATSamPhysicalType GetPhysicalTypeNumber()const = 0
Retrieves the Physical type of the feature.
Returns:
the physical type identifer.
o LogCreateDelete
public virtual HRESULT LogCreateDelete(CATBoolean ilAdd,
CATAnalysisExplicitListUsr& iExplObjects) = 0
Toolkit to manage local creation of deletion children. This methode should not be used with objects that are already managed by the UpdateExplicitList method. Note: In case of deletion this method will delete your object.
Parameters:
ilAdd
informs about creation or deletion. Legal values:
TRUE : Create
FALSE: Delete
iExplObjects
Liste of objects to take into account.
o UpdateExplicitList
public virtual HRESULT UpdateExplicitList(CATAnalysisExplicitListUsr& iexplObjects,
CATAnalysisExplicitListUsr& iContainingData,
CATAnalysisExplicitListUsr& iNewObjects) = 0
Update the explicit Lists of Objects that are created inside the field model. The steps that are done in this method consists in :
Parameters:
iexplObjects
: List of pre-existing version.
iContainingData
: List of containing data.
iNewObjects
: List of new version data.

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

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