All Frameworks  Class Hierarchy  This Framework  Indexes   

ElecSchematicItf Interface 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 Connect( const iEdiCableExtrCtr,
const iEdiPin)
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 Disconnect( const iEdiPin)
Disconnects the cable extremity.
Parameters:
iEdiPin
The Pin Connector to disconnect
o GetCableExtremity
public virtual GetCableExtremity( oCableExtremity1,
oCableExtremity2)
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 GetConnectedPin( const iEdiCableExtrCtr,
oEdiPin)
Gets Connected Pin connector.
Parameters:
iEdiCableExtrCtr
The Cable extremity connector whoes connection includes this wire connector
oEdiPin
The Pin object
o GetNumber
public virtual GetNumber( oNumber)
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.