All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecSchematicItf Interface CATIEdiCableExtremity
System.IUnknown
|
+---CATIEdiCableExtremity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEdiCableExtremity
Interface to manage an electrical schematic Cable Extremity.
Role:This interfaces describes the electrical object Cable Extremity.
Method Index
- o
Connect(CATIEdiWidePin*)
- Connects the cable extremity to a Wide Pin Connector.
- o
Disconnect()
- Disconnects the cable extremity.
- o
GetCable(CATIEdiCable**)
- Gets Cable electrical object.
- o
GetConnectedWidePin(CATIEdiWidePin**)
- Gets Connected Wide Pin connector.
- o
GetNumber(int*)
- Get the number of the cable extremity.
- o
ListWireExtremities(CATIUnknownList**)
- Gets the list of wire extremities in accordance with
this cable extremity.
Methods
o Connect
-
Connects the cable extremity to a Wide Pin Connector.
This method allows to connect :
- Cables to Equipments throw Sockets
- Cables to JunctionBoxes
- Cables to Plugs
- Cables to Switchs
- Parameters:
-
- iEdiWidePin
- The Wide 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 GetCable
-
Gets Cable electrical object.
- Parameters:
-
- oEdiCable
- The Cable object
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o GetConnectedWidePin
-
Gets Connected Wide Pin connector.
- Parameters:
-
- oEdiWidePin
- The Wide 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 cable extremity.
- Parameters:
-
- oNumber
- The number of the cable extremity.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListWireExtremities
-
Gets the list of wire extremities in accordance with
this cable extremity. The filter is based on Id_Number
Attribute value.
- Parameters:
-
- oLWireExtremities
- The Wire extremities
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIEdiCableExtremity.h