All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecSchematicItf Interface CATIEdiPin
System.IUnknown
|
+---CATIEdiPin
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEdiPin
Interface to manage an electrical schematic Pin.
Role:This interfaces describes the electrical object Pin.
Method Index
- o
CheckIdNumber(wchar_t*,int*)
- Checks Pin's IdNumber unicity on the current level
(IdNumber can be checked and changed on all instance levels).
- 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
GetPotential(wchar_t**)
- Gets Potential Name.
- o
ListAssociatedPins(CATIUnknownList**)
- Gets Associated Pins throw Id_Numbers Mapping & Connectivity (Potential).
- o
ListConnectedWireExtremities(CATIUnknownList**)
- Gets Associated Wires Extremities.
- o
Remove()
- Removes Pin connector.
- o
SetIdNumber(wchar_t*)
- Sets Pin's IdNumber on the current level
(IdNumber can be checked and changed on all instance levels).
- o
UnsetPotential()
- Unset Potential (The potential will be unset on current level and references).
Methods
o CheckIdNumber
public virtual HRESULT CheckIdNumber( | const wchar_t* | iEdiIdNumber, |
| int* | oEdiIsUnique) = 0 |
-
Checks Pin'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 GetDevice
-
Gets Associated Device.
- 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 GetPotential
public virtual HRESULT GetPotential( | wchar_t** | oPotential) = 0 |
-
Gets Potential Name.
- Parameters:
-
- oPotential
- The potential
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListAssociatedPins
-
Gets Associated Pins throw Id_Numbers Mapping & Connectivity (Potential).
- Parameters:
-
- oLEdiAssociatedPins
- The associated pins
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListConnectedWireExtremities
-
Gets Associated Wires Extremities.
- Parameters:
-
- oLEdiWireExtremities
- The connected wire extremities
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Remove
-
Removes Pin 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 Pin'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
o UnsetPotential
public virtual HRESULT UnsetPotential( | )= 0 |
-
Unset Potential (The potential will be unset on current level and references).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIEdiPin.h