All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecSchematicItf Interface CATIEdiCable

System.IUnknown
  |
  +---CATIEdiCable
 

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


interface CATIEdiCable

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


Method Index


o GetExtremities(CATIEdiCableExtremity**,CATIEdiCableExtremity**)
Gets cable extremities.
o ListAssociatedDevices(CATIUnknownList**)
List Associated Devices.
o ListWires(CATIUnknownList**)
List Cable's conductors.

Methods


o GetExtremities
public virtual HRESULT GetExtremities(CATIEdiCableExtremity** oExtremity1,
CATIEdiCableExtremity** oExtremity2) = 0
Gets cable extremities. If a cable extremity does not exist, she will be created on the fly, on the first instance level.
Parameters:
oCableExtremity1
First Cable extremity
oCableExtremity2
Second Cable extremity
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAssociatedDevices
public virtual HRESULT ListAssociatedDevices(CATIUnknownList** oLDevices) = 0
List Associated Devices.
Parameters:
oLDevices
List of connected devices
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListWires
public virtual HRESULT ListWires(CATIUnknownList** oLWires) = 0
List Cable's conductors.
Parameters:
oLWires
List of wires
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIEdiCable.h

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