All Frameworks Class Hierarchy This Framework Indexes
ElecRoutingItf Interface CATIEwrFilter
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEwrFilter
Interface dedicated to filtering.
Role: This interface is used to filter a session
Method Index
- o
Filter(CATListValCATUnicodeString*,CATListValCATUnicodeString*,CATEwrFilterOption)
- Filter a session for a given list of systems, a given list of criteria and a filtering option.
- o
ResetFilter()
- Reset the session by reactivating every filtered objects.
Methods
o Filter
| public virtual Filter( | const | iListOfSystems, |
| const | iListOfCriteria, |
| | iOption) |
-
Filter a session for a given list of systems, a given list of criteria and a filtering option.
- Parameters:
-
- iListOfSystems
- The list of systems.
- iListOfCriteria
- The list of criteria. This argument can be used to list the wires for a configuration.
- iOption
- Filtering option
Legal values:
- ElecFilterBundleSegment
- Filtering of bundle segment activated.
- ElecFilterDevice
- Filtering of device activated.
- ElecFilterSupport
- Filtering of support activated.
- ElecFilterProtection
- Filtering of protective covering activated.
- Or a combination of thosee value using '|' operator
- Example : ElecFilterBundleSegment|ElecFilterDevice to activate filtering of bundle segment and device.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The session is filtered.
- E_FAIL
- Error while filtering.
o ResetFilter
| public virtual ResetFilter( | ) |
-
Reset the session by reactivating every filtered objects.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The wires have been retrieved.
- E_FAIL
- Error while retrieving the wires.
This object is included in the file: CATIEwrFilter.h
If needed, your Imakefile.mk should include the module: CATEwrInterfaces