All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface 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:
- Creation of the Explicit object according to the physical type of the analysis feature.
- Control the Life Cycle of the Explicit object(s) as the feature one (Remove, Undo/redo,...).
- Retrieve Explicit object(s) associated to the feature.
- Tools to generate a new version of explicit object(s). To be used for the implementation of CATISamExplicitation.
- 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
GetExplicitTagsNumber()
- Retrieves the number of Explicit object(s) generated.
- o
GetExplicitTags(CATListOfInt&)
- Retrieves the tags of the Explicit object(s) generated during the
translation.
- o
GetPhysicalTypeNumber()
- Retrieves the Physical type of the feature.
- o
GetPhysicalType()
- 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 GetContainingData( | | iexplObjects, |
| | oContainingData, |
| | iChildPhysType | = NULL) |
-
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 GetExplicitModel( | ) |
-
Retrieves the explicit model associated.
- Parameters:
-
- returns
- the CATAnalysisExplicitModel
o GetExplicitObject
| public virtual GetExplicitObject( | | oChild, |
| | iObjectIndex | = 1) |
-
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 GetExplicitObjects( | | oExplObjects) |
-
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 GetExplicitTag( | | iObjectIndex | = 1) |
-
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 GetExplicitTagsNumber
| public virtual GetExplicitTagsNumber( | ) |
-
Retrieves the number of Explicit object(s) generated.
- Returns:
- the number of explicit children.
o GetExplicitTags
| public virtual GetExplicitTags( | | oExplicitTags) |
-
Retrieves the tags of the Explicit object(s) generated during the
translation.
- Parameters:
-
- oExplicitTags
- The list of explicit tags.
o GetPhysicalTypeNumber
| public virtual GetPhysicalTypeNumber( | ) |
-
Retrieves the Physical type of the feature.
- Returns:
- the physical type identifer.
o GetPhysicalType
| public virtual GetPhysicalType( | ) |
-
Retrieves the Physical type of the feature.
- Returns:
- the physical type identifer as String
o LogCreateDelete
| public virtual LogCreateDelete( | | ilAdd, |
| | iExplObjects) |
-
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 UpdateExplicitList( | | iexplObjects, |
| | iContainingData, |
| | iNewObjects) |
-
Update the explicit Lists of Objects that are created inside the field model.
The steps that are done in this method consists in :
- Delete the objects in the iexplObjects.
- Create the link (parent/ Children) between the objects in the iContainingData
and the iexplObjects objects.
- 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