All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecSchematicItf Interface CATIEdiTerminalBoard
System.IUnknown
|
+---CATIEdiTerminalBoard
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEdiTerminalBoard
Interface to manage an electrical schematic Terminal Board.
Role:This interfaces describes the electrical object Terminal Board.
Method Index
- o
ListPins(CATIUnknownList**)
- List of Pin connectors.
- o
ListPotentials(CATICStringList**)
- List of Potentials.
- o
RemovePotential(wchar_t*)
- Unsets pins to a given potential.
- o
SetPotential(wchar_t*,CATIEdiPin*)
- Sets a pin to a given potential.
Methods
o ListPins
-
List of Pin connectors.
- Parameters:
-
- oLPins
- The Pin connectors
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListPotentials
-
List of Potentials.
- Parameters:
-
- oLPotentials
- The List of Potentials
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemovePotential
public virtual HRESULT RemovePotential( | wchar_t* | iPotential) = 0 |
-
Unsets pins to a given potential.
- Parameters:
-
- iPotential
- The Potential description (e.g. 0V or 10V)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetPotential
-
Sets a pin to a given potential.
- Parameters:
-
- iPotential
- The Potential description (e.g. 0V or 10V)
- iPin
- The pin connector to work on
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATIEdiTerminalBoard.h