All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecFunctionalItf Interface CATIEfdGroupSignal

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

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


interface CATIEfdGroupSignal

Interface to manage group signals.
Role:The group signal is a signal that can agregate signals It groups signals that will be routed together, for example shielded or twisted signals.


Method Index


o AddSignal(wchar_t*,wchar_t*,CATIEfdSignal**)
Adds a signal in the group signal.
o GetEfdSystem(CATIEfdSystem**)
Retrieves the system in which is contained.
o ListSignals(CATListValCATBaseUnknown_var**)
Lists signals/group signals directly referenced within the group signal.
o Remove(CATIEfdSignal**)
Removes a signal from the group signal.

Methods


o AddSignal
public virtual HRESULT AddSignal( const wchar_t* iSignalType,
const wchar_t* iObjectId,
CATIEfdSignal** oSignal)=0
Adds a signal in the group signal.
Parameters:
iSignalType
the signal Object type.
Legal values: GroundSignal for a ground signal GropSignal for a group signal ShieldingSignal for a shielding signal VideoSignal for a video signal PowerSignal for a power signal CommandSignal for a command signal
iObjectId
the signal user identifier.
oSignal
the signal created.
o GetEfdSystem
public virtual HRESULT GetEfdSystem(CATIEfdSystem** oSystem)=0
Retrieves the system in which is contained.
Parameters:
oSystem
the system object.
o ListSignals
public virtual HRESULT ListSignals(CATListValCATBaseUnknown_var** oSignals)=0
Lists signals/group signals directly referenced within the group signal.
Parameters:
iClass
The Signal type (ALL for all types of Signals)
oChilden
The list of Signals found
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(CATIEfdSignal** iSignal)=0
Removes a signal from the group signal.
Parameters:
iSignal
the signal to be removed

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

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