All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecSchematicItf Interface CATIEdiPlug

System.IUnknown
  |
  +---CATIEdiPlug
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIEdiPlug

Interface to manage an electrical schematic Plug.
Role:This interfaces describes the electrical object Plug.


Method Index


o Disconnect()
Disconnect Plug & Device.
o GetMatingCtr(CATIEdiMatingConnector**)
Get the Mating Connector.
o ListAssociatedCables(CATIUnknownList**)
Gets Associated Cables.
o ListAssociatedDevice(IUnknown**)
Gets Associated Device.
o ListPins(CATIUnknownList**)
List of Pin connectors.
o ListWidePins(CATIUnknownList**)
List of Wide Pin connectors.

Methods


o Disconnect
public virtual HRESULT Disconnect()= 0
Disconnect Plug & Device.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetMatingCtr
public virtual HRESULT GetMatingCtr(CATIEdiMatingConnector** oMatingCtr) = 0
Get the Mating Connector.
Parameters:
oMatingCtrs
The Mating Connector
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAssociatedCables
public virtual HRESULT ListAssociatedCables(CATIUnknownList** oLEdiCables) = 0
Gets Associated Cables.
Parameters:
oLEdiCables
The connected cables
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAssociatedDevice
public virtual HRESULT ListAssociatedDevice(IUnknown** oEdiDevice) = 0
Gets Associated Device.
Parameters:
oLEdiDevice
The connected Device
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListPins
public virtual HRESULT ListPins(CATIUnknownList** oLPins) = 0
List of Pin connectors.
Parameters:
oLPins
The Pin connectors
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListWidePins
public virtual HRESULT ListWidePins(CATIUnknownList** oLWidePins) = 0
List of Wide Pin connectors.
Parameters:
oLWidePins
The Wide Pin connectors
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIEdiPlug.h

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