All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecFunctionalItf Interface CATIEfdSignal
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEfdSignal
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEfdSignal
Interface to manage the electrical Signal .
Role:An electrical signal is a logical
connection between two or more components.May
be of the following types: ground, shielding,
video, power, command or grouped.
Method Index
- o
AddExtremity(CATBaseUnknown*,wchar_t*,CATIEfdSignalExtremity**)
- Creates an EfdSignalExtremity.
- o
AddOffSheet(wchar_t*,wchar_t*,CATIEfdOffSheet**)
- Creates an offsheet.
- o
GetEfdSystem(CATIEfdSystem**)
- Retrieves the System in which it is contained.
- o
GetMultiSheetSignal(CATIEfdMultiSheetSignal**)
- Retrieves the MultiSheetSignal Object which solves the offsheets.
- o
ListExtremities(CATListValCATBaseUnknown_var**)
- List EfdSignalExtremities objects directly referenced within the
signal.
- o
ListOffSheets(wchar_t*,CATListValCATBaseUnknown_var**)
- Lists ElecSignalOffSheet objects directly referenced within the
signal.
- o
RemoveExtremity(CATBaseUnknown**)
- Removes a connector.
Methods
o AddExtremity
-
Creates an EfdSignalExtremity.
- Parameters:
-
- iConnector
- Connector to be linked with a new signal extremity
the iConnector may be an EfdEquipment, an EfdConnector
or a EfdContactPoint
- iObjectId
- SignalExtremity user identifier.
- oExtremity
- The EfdSignalExtremity object.
o AddOffSheet
public virtual HRESULT AddOffSheet( | const wchar_t* | iOffSheetSubType, |
| const wchar_t* | iObjectId, |
| CATIEfdOffSheet** | oOffSheet)=0 |
-
Creates an offsheet.
- Parameters:
-
- iOffSheetSubType
- offsheet sub type. User type associated to the offsheet. May be used
in list services to filtrate the offsheets.
- iObjectId
- offsheet user identifier.
- oOffSheet
- EfdOffSheet created.
o GetEfdSystem
-
Retrieves the System in which it is contained.
- Parameters:
-
- oSystem
- The parent system.
o GetMultiSheetSignal
-
Retrieves the MultiSheetSignal Object which solves the offsheets.
- Parameters:
-
- oMulti
- the MultiSheetSignal object
o ListExtremities
public virtual HRESULT ListExtremities( | CATListValCATBaseUnknown_var** | oExtremities)=0 |
-
List EfdSignalExtremities objects directly referenced within the
signal.
- Parameters:
-
- oExtremities
- The list of EfdSignalExtremity objects
Legal values: NULL if the list
is created from scratch, orNOT NULL if you want to
append new elements to the list
o ListOffSheets
public virtual HRESULT ListOffSheets( | const wchar_t* | iOffSheetSubType, |
| CATListValCATBaseUnknown_var** | oOffSheets)=0 |
-
Lists ElecSignalOffSheet objects directly referenced within the
signal.
- Parameters:
-
- iOffSheetSubType
- OffSheet Sub type. To have all the OffSheets
you must use
Legal values: "ALL"
as sub type. For more information see CATIEfdOffSheetLink
or CATIEfdSignal.
- oOffSheets
- The list of offsheet objects
Legal values: NULL if the list
is created from scratch, orNOT NULL if you want to
append new elements to the list
o RemoveExtremity
-
Removes a connector.
- Parameters:
-
- iConnector
- connector to be removed.
This object is included in the file: CATIEfdSignal.h
If needed, your Imakefile.mk should include the module: CATEFDInterfaces