All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecSchematicItf Interface CATIEdiWidePin

System.IUnknown
  |
  +---CATIEdiWidePin
 

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


interface CATIEdiWidePin

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


Method Index


o CheckIdNumber(wchar_t*,int*)
Checks WidePin's IdNumber unicity on the current level (IdNumber can be checked and changed on all instance levels).
o Connect(CATIEdiWidePin*)
Connects a plug and a Device through WidePin connectors.
o GetDevice(IUnknown**)
Gets Associated Device.
o GetIdNumber(wchar_t**)
Gets Pin's IdNumber on the current level.
o GetNumber(int*)
Gets Pin's Number on the current level.
o ListAssociatedWidePins(CATIUnknownList**)
List the Wide Pins Connected to this Wide Pin.
o ListConnectedCableExtremities(CATIUnknownList**)
Gets Associated Cables Extremities.
o Remove()
Removes WidePin connector.
o SetIdNumber(wchar_t*)
Sets WidePin's IdNumber on the current level (IdNumber can be checked and changed on all instance levels).

Methods


o CheckIdNumber
public virtual HRESULT CheckIdNumber( const wchar_t* iEdiIdNumber,
int* oEdiIsUnique) = 0
Checks WidePin's IdNumber unicity on the current level (IdNumber can be checked and changed on all instance levels).
Parameters:
iEdiIdNumber
identification number
oEdiIsUnique
= 0 : is not unique = 1 : is unique
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Connect
public virtual HRESULT Connect(CATIEdiWidePin* iEdiWidePin) = 0
Connects a plug and a Device through WidePin connectors.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetDevice
public virtual HRESULT GetDevice(IUnknown** oEdiDevice) = 0
Gets Associated Device.
Parameters:
oEdiDevice
The Device application object
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetIdNumber
public virtual HRESULT GetIdNumber(wchar_t** oEdiIdNumber) = 0
Gets Pin's IdNumber on the current level.
Parameters:
oEdiIdNumber
The identification number
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetNumber
public virtual HRESULT GetNumber(int* oEdiNumber) = 0
Gets Pin's Number on the current level.
Parameters:
oEdiNumber
The identification number
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAssociatedWidePins
public virtual HRESULT ListAssociatedWidePins(CATIUnknownList** oLAssociatedWidePins) = 0
List the Wide Pins Connected to this Wide Pin.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListConnectedCableExtremities
public virtual HRESULT ListConnectedCableExtremities(CATIUnknownList** oLCableExtremities) = 0
Gets Associated Cables Extremities.
Parameters:
oLEdiCableExtremities
The connected cable extremities
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Remove
public virtual HRESULT Remove()= 0
Removes WidePin connector.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetIdNumber
public virtual HRESULT SetIdNumber( const wchar_t* iEdiIdNumber) = 0
Sets WidePin's IdNumber on the current level (IdNumber can be checked and changed on all instance levels).
Parameters:
iEdiIdNumber
identification number
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIEdiWidePin.h

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