All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecRoutingItf Interface CATIEwrUipEquipotentials

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIEwrUipEquipotentials
 

Usage: you can freely reimplement this interface.


interface CATIEwrUipEquipotentials

Interface dedicated to equipotentials.
Role: This interface is used to list the equipotentials to route


Method Index


o ListEquipotentials(CATListValCATUnicodeString*,CATLONG32&,CATEwrEquipotential*&)
Retrieves the list of equipotentials for a given system.

Methods


o ListEquipotentials
public virtual HRESULT ListEquipotentials( const CATListValCATUnicodeString* iListOfSystems,
CATLONG32& oEquipotentialsCount,
CATEwrEquipotential*& oListOfEquipotentials) = 0
Retrieves the list of equipotentials for a given system.
Parameters:
iListOfSystems
The list of systems.
oEquipotentialsCount
The number of equipotentials
oListOfEquipotentials
The list of equipotentials
Returns:
An HRESULT value.
Legal values:
S_OK
The equipotentials have been retrieved.
E_FAIL
Error while retrieving the equipotentials.

This object is included in the file: CATIEwrUipEquipotentials.h
If needed, your Imakefile.mk should include the module: CATEwrInterfaces

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