All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecSchematicItf Interface CATIEdiWireCtr

System.IUnknown
  |
  +---CATIEdiWireCtr
 

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


interface CATIEdiWireCtr

Interface to manage an electrical schematic Wire connector.
This interface will replace CATIEdiWireExtremity. Role:This interfaces describes the electrical object Wire connector.


Method Index


o Connect(CATIEdiCableExtremity*,CATIEdiPin*)
Connects the wire connector to a Pin Connector.
o Disconnect(CATIEdiPin*)
Disconnects the cable extremity.
o GetCableExtremity(CATIEdiCableExtremity**,CATIEdiCableExtremity**)
Gets the cable extremity connectors.
o GetConnectedPin(CATIEdiCableExtremity*,CATIEdiPin**)
Gets Connected Pin connector.
o GetNumber(int*)
Get the number of the wire extremity connector.

Methods


o Connect
public virtual HRESULT Connect( const CATIEdiCableExtremity* iEdiCableExtrCtr,
const CATIEdiPin* iEdiPin) = 0
Connects the wire connector to a Pin Connector.
Parameters:
iEdiCableExtrCtr
The Cable extremity connector whoes connection includes the next input: iEdiPin
iEdiPin
The Pin Connector to connect
o Disconnect
public virtual HRESULT Disconnect( const CATIEdiPin* iEdiPin) = 0
Disconnects the cable extremity.
Parameters:
iEdiPin
The Pin Connector to disconnect
o GetCableExtremity
public virtual HRESULT GetCableExtremity(CATIEdiCableExtremity** oCableExtremity1,
CATIEdiCableExtremity** oCableExtremity2) = 0
Gets the cable extremity connectors.
Parameters:
oCableExtremity1
The Cable extremities connector 1
oCableExtremity1
The Cable extremities connector 2
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetConnectedPin
public virtual HRESULT GetConnectedPin( const CATIEdiCableExtremity* iEdiCableExtrCtr,
CATIEdiPin** oEdiPin) = 0
Gets Connected Pin connector.
Parameters:
iEdiCableExtrCtr
The Cable extremity connector whoes connection includes this wire connector
oEdiPin
The Pin object
o GetNumber
public virtual HRESULT GetNumber(int* oNumber) = 0
Get the number of the wire extremity connector.
Parameters:
oNumber
The number of the wire extremity connector.

This object is included in the file: CATIEdiWireCtr.h

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