All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecSchematicItf Interface CATIEdiWire

System.IUnknown
  |
  +---CATIEdiWire
 

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


interface CATIEdiWire

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


Method Index


o GetCable(CATIEdiCable**)
Gets Cable.
o GetExtremities(CATIEdiWireExtremity**,CATIEdiWireExtremity**)
Gets wire extremities.
o Remove()
Removes Wire.

Methods


o GetCable
public virtual HRESULT GetCable(CATIEdiCable** oEdiCable) = 0
Gets Cable.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetExtremities
public virtual HRESULT GetExtremities(CATIEdiWireExtremity** oExtremity1,
CATIEdiWireExtremity** oExtremity2) = 0
Gets wire extremities.
Parameters:
oWireExtremity1
First wire extremity
oWireExtremity2
Second wire extremity
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Remove
public virtual HRESULT Remove()= 0
Removes Wire.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIEdiWire.h

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