All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamEnumManager
Usage: you can reimplement this interface by deriving the supplied CATESamEnumManager adapter class.
interface CATISamEnumManager
Interface to manage enumerate basic componenent that will create other basic components.
This inferface is to be implemented on a basic component build by derivation of "SAMListManager".
According to the first level selection return lists of basic components to instanciate.
BOA information: this interface CANNOT be implemented
using the BOA (Basic Object Adapter).
To know more about the BOA, refer to the CAA Encyclopedia home page.
Click Middleware at the bottom left, then click the Object Modeler tab page.
Several articles deal with the BOA.
Method Index
- o
GetList(CATListValCATUnicodeString&)
- Retrieves the list of strings defined in the enumerate.
- o
GetMode(CATSamSelectionMode&)
- Retrieves the mode of the selection.
- o
GetResult(CATUnicodeString&,CATListValCATUnicodeString&,CATListValCATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
- Retrieves the list of features.
- o
GetSelected(CATUnicodeString&,int&)
- Retrieves the string and the index (position in the list of an enumerated type) which correspond
with a string selected in a list.
- o
SetSelected(int)
- Set the value of the enumerate .
Methods
o GetList
| public virtual GetList( | | oList) |
-
Retrieves the list of strings defined in the enumerate.
- Parameters:
-
- oList
- : List of string inside an enumerated type
o GetMode
| public virtual GetMode( | | oMode) |
-
Retrieves the mode of the selection.
- Parameters:
-
- oMode
- : oMode = SAM_OR if only the selected element is present oMode = SAM_AND if all elements are present
o GetResult
| public virtual GetResult( | const | iString, |
| | oFeatureName, |
| | oFeatureType, |
| | oListOfCATICkeType) |
-
Retrieves the list of features.
- Parameters:
-
- iString
- : input string from the list
- oFeatureName
- : features instance name
- oFeatureType
- : features type
- oListOfCATICkeType
- : type of the instance to create if Literal
o GetSelected
| public virtual GetSelected( | | oString, |
| | oIndex) |
-
Retrieves the string and the index (position in the list of an enumerated type) which correspond
with a string selected in a list.
- Parameters:
-
- oString
- : selected element as string
- oIndex
- : Index of the selected element in the list
o SetSelected
| public virtual SetSelected( | | iIndex) |
-
Set the value of the enumerate .
- Parameters:
-
- iIndex
- : Index of the selected element in the list
This object is included in the file: CATISamEnumManager.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface