InteractiveInterfaces Interface CATIIniSearchEngine
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIIniSearchEngine
Interface to launch the search engine and retrieve the results.
Role: This interface enables the user to launch the search
engine with the given criterion, context, and possibly document.
The results can be retrieved as a pointer to a instance.
Using this interface in batch mode could lead to unpredictable result. Search engine mainly
relies on visualization interfaces, which could be not used in batch mode.
Method Index
- o
GetFoundObjects(CATSO*&)
- Retrieves the list of found objects.
- o
LaunchSearchOnDocument(CATBaseUnknown*)
- Launches the Search process.
- o
SetCriterionAndContext(CATIIniSearchCriterion*,CATIIniSearchContext*)
- Sets up the necessary data.
Methods
o GetFoundObjects
| public virtual GetFoundObjects( | | oListOfFoundObjects) |
-
Retrieves the list of found objects.
Role: This method enables to retrieve the list of objects that
are matching the input criterion, in the input context, and in the
specified document.
- Parameters:
-
- oListOfFoundObjects
- The list of found objects
- Returns:
-
- E_FAIL if no element has been found.
- S_OK otherwise.
o LaunchSearchOnDocument
| public virtual LaunchSearchOnDocument( | const | iRoot | = NULL) |
-
Launches the Search process.
Role: This method launches the Search process for the criterion
and context as specified in the
method.
- Parameters:
-
- iRoot
- Where the Search will take place.
It can be a
, then the search root will be its ui-activable path root.
If no root is specified, the current editor's ui-activable path root is being used.
- Returns:
- S_OK always.
o SetCriterionAndContext
| public virtual SetCriterionAndContext( | const | iCriterion, |
| const | iContext) |
-
Sets up the necessary data.
Role: This method sets up the necessary criterion and context.
Those data are vital for appropriatly launching the search engine.
If iContext is NULL, the default context will be applied (
).
- Parameters:
-
- iCriterion
- The criterion to which objects will be confronted.
- iContext
- The context to determine which objects will be confronted to the criterion.
If iContext is NULL, the default context will apply.
- Returns:
-
- E_FAIL if iCriterion is NULL.
- S_OK otherwise.
This object is included in the file: CATIIniSearchEngine.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.