All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElectricalInterfaces Interface CATIEleUipFilteringCriteria
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEleUipFilteringCriteria
Usage: you can freely reimplement this interface.
interface CATIEleUipFilteringCriteria
Interface dedicated to configuration management.
Role: This interface is used to list the criteria that can be applied to routed wires.
Method Index
- o
ListCriteria(CATListValCATUnicodeString*,CATListValCATUnicodeString*&)
- Retrieves the list of criteria for a given list of systems.
- o
ListWires(CATListValCATUnicodeString*,CATListValCATUnicodeString*,CATListValCATUnicodeString*&)
- Retrieves the list of wires for a given list of systems and a given list of criteria.
Methods
o ListCriteria
-
Retrieves the list of criteria for a given list of systems.
- Parameters:
-
- iListOfSystems
- The list of systems (It is possible to give no systems. In this case, all criteria for the whole project will be
returned).
- oListOfCriteria
- The list of criteria.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The criteria have been retrieved.
- E_FAIL
- Error while retrieving the criteria.
o ListWires
-
Retrieves the list of wires for a given list of systems and a given list of criteria.
- Parameters:
-
- iListOfSystems
- The list of systems (It is possible to give no systems)
- oListOfCriteria
- The list of criteria.
- oListOfWires
- The list of wires' identifiers available for the given list of criteria.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The wire identifiers have been retrieved.
- E_FAIL
- Error while retrieving the wire identifiers.
This object is included in the file: CATIEleUipFilteringCriteria.h
If needed, your Imakefile.mk should include the module: CATElectricalInterfaces