All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ElecDeviceItf Interface CATIElbUipDevices

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIElbUipDevices
 

Usage: you can freely reimplement this interface.


interface CATIElbUipDevices

Interface dedicated to devices.
Role: This interface is used to list the devices and their compositions.


Method Index


o GetMatingConnector(CATUnicodeString,CATUnicodeString&)
Retrieves the mating connector of a given connector.
o ListDeviceComposition(CATUnicodeString,CATLONG32&,CATElbDevice*&)
Retrieves for a given device the list of its sub-elements.
o ListDevices(CATListValCATUnicodeString*,CATLONG32&,CATElbDevice*&)
Retrieves the list of devices to install related to the given list of systems.

Methods


o GetMatingConnector
public virtual HRESULT GetMatingConnector( const CATUnicodeString iConnectorId,
CATUnicodeString& oMatingConnectorId) = 0
Retrieves the mating connector of a given connector.
Parameters:
iConnectorId
The identifier of the connector.
oMatingConnectorId
The identifier of the mating connector.
Returns:
An HRESULT value.
Legal values:
S_OK
The identifier of the mating connector has been retrieved.
E_FAIL
Error while retrieving the identifier of the mating connector.
o ListDeviceComposition
public virtual HRESULT ListDeviceComposition( const CATUnicodeString iDeviceId,
CATLONG32& oDevicesCount,
CATElbDevice*& oListOfDevices) = 0
Retrieves for a given device the list of its sub-elements.
Parameters:
iDeviceId
The identifier of the device.
oDevicesCount
The number of devices.
oListOfDevices
The list of devices under the given device.
Returns:
An HRESULT value.
Legal values:
S_OK
The composition of the device has been retrieved.
E_FAIL
Error while retrieving the composition of the device.
o ListDevices
public virtual HRESULT ListDevices( const CATListValCATUnicodeString* iListOfSystems,
CATLONG32& oDevicesCount,
CATElbDevice*& oListOfDevices) = 0
Retrieves the list of devices to install related to the given list of systems.
Parameters:
iListOfSystems
The list of systems.
oDevicesCount
The number of devices.
oListOfDevices
The list of devices to place in the 3D mockup.
Returns:
An HRESULT value.
Legal values:
S_OK
The devices have been retrieved.
E_FAIL
Error while retrieving the devices.

This object is included in the file: CATIElbUipDevices.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.