All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ElecFunctionalItf Interface CATIEfdSystem

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIEfdSystem

Interface to manage electrical system.
Role: an electrical system is a unit which accomplish a specific function. Consists of equipment, connectors and signals. For example, airplane radar system.Described in CATProduct document.


Method Index


o AddEfdEquipment(wchar_t*,CATIEfdEquipment**)
Adds a EfdEquipment in the system.
o AddMatingConnector(wchar_t*,wchar_t*,CATIEfdConnector**)
Creates an EfdConnector.
o AddSignal(wchar_t*,wchar_t*,CATIEfdSignal**)
Adds a signal in the system.
o ListEfdEquipments(CATListValCATBaseUnknown_var**)
Lists EfdEquipments objects directly referenced within the object.
o ListMatingConnectors(CATListValCATBaseUnknown_var**)
Lists MatingConnectors objects directly referenced within the object.
o ListSignals(CATListValCATBaseUnknown_var**)
Lists signals objects directly referenced within the object.
o Remove(CATIProduct**)
Removes a child from the system.

Methods


o AddEfdEquipment
public virtual HRESULT AddEfdEquipment( const wchar_t* iObjectId,
CATIEfdEquipment** oEquipment)=0
Adds a EfdEquipment in the system.
Parameters:
iObjectId
EfdEquipment user identifier.
oEquipment
EfdEquipment created.
o AddMatingConnector
public virtual HRESULT AddMatingConnector( const wchar_t* iObjectId,
const wchar_t* iIdNumber,
CATIEfdConnector** oConnector)=0
Creates an EfdConnector.
Parameters:
iObjectId
EfdConnector user identifier.
iIdNumber
EfdEquipment Identifier.Identifies the structure details of a sub-entity (as in V4 concept)
oConnector
EfdConnector created.
o AddSignal
public virtual HRESULT AddSignal( const wchar_t* iSignalType,
const wchar_t* iObjectId,
CATIEfdSignal** oSignal)=0
Adds a signal in the system.
Parameters:
iSignalType
Signal object type.
Legal values: GroundSignal for a ground signal GropSignal for a group signal ShieldingSignal for a shielding signal VideoSignal for a sideo signal PowerSignal for a power signal CommandSignal for a command signal
iObjectId
signal user identifier.
oSignal
signal created.
o ListEfdEquipments
public virtual HRESULT ListEfdEquipments(CATListValCATBaseUnknown_var** oEquipments)=0
Lists EfdEquipments objects directly referenced within the object.
Parameters:
oEquipments
the list of Equipments objects
Legal values: NULL if the list is created from scratch, orNOT NULL if you want to append new elements to the list.
o ListMatingConnectors
public virtual HRESULT ListMatingConnectors(CATListValCATBaseUnknown_var** oMatingConnectors)=0
Lists MatingConnectors objects directly referenced within the object.
Parameters:
oMatingConnectors
the list of MatingConnectors objects
Legal values: NULL if the list is created from scratch, orNOT NULL if you want to append new elements to the list.
o ListSignals
public virtual HRESULT ListSignals(CATListValCATBaseUnknown_var** oSignals)=0
Lists signals objects directly referenced within the object.
Parameters:
oSignals
the list of signals objects
Legal values: NULL if the list is created from scratch, orNOT NULL if you want to append new elements to the list.
o Remove
public virtual HRESULT Remove(CATIProduct** iChild)=0
Removes a child from the system.
Parameters:
iChild
the Child to be removed

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

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