All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecSchematicItf Interface CATIEdiWireExtremity
System.IUnknown
|
+---CATIEdiWireExtremity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEdiWireExtremity
Interface to manage an electrical schematic Wire Extremity.
Role:This interfaces describes the electrical object Wire Extremity.
Method Index
- o
Connect(CATIEdiPin*)
- Connects the wire extremity to a Pin Connector.
- o
Disconnect()
- Disconnects the cable extremity.
- o
GetCableExtremity(CATIEdiCableExtremity**)
- Gets the calbe extremity in accordance with
this wire extremity.
- o
GetConnectedPin(CATIEdiPin**)
- Gets Connected Pin connector.
- o
GetNumber(int*)
- Get the number of the wire extremity.
- o
GetWire(CATIEdiWire**)
- Gets Wire electrical object.
Methods
o Connect
-
Connects the wire extremity to a Pin Connector.
- Parameters:
-
- iEdiPin
- The Pin Connector to connect
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Disconnect
public virtual HRESULT Disconnect( | )= 0 |
-
Disconnects the cable extremity.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetCableExtremity
-
Gets the calbe extremity in accordance with
this wire extremity. The filter is based on Id_Number
Attribut value.
- Parameters:
-
- oLCableExtremities
- The Cable extremities
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetConnectedPin
-
Gets Connected Pin connector.
- Parameters:
-
- oEdiPin
- The Pin object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetNumber
public virtual HRESULT GetNumber( | int* | oNumber) = 0 |
-
Get the number of the wire extremity.
- Parameters:
-
- oNumber
- The number of the wire extremity.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetWire
-
Gets Wire electrical object.
- Parameters:
-
- oEdiWire
- The Wire object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIEdiWireExtremity.h