All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecFunctionalItf Interface CATIEfdEquipment
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEfdEquipment
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEfdEquipment
Interface to create electrical equipment.
Role: An electrical equipment has
a specific function, it is a functional electrical
component with one ore more associated connectors,
for example a lamp or a battery.
Method Index
- o
AddContactPoint(wchar_t*,wchar_t*,CATIEfdContactPoint**)
- Creates a contact point.
- o
AddEfdConnector(wchar_t*,wchar_t*,CATIEfdConnector**)
- Creates electrical connector.
- o
GetSystem(CATIEfdSystem**)
- Retrieves the electrical system in which it is contained.
- o
ListAssociatedSignals(CATListValCATBaseUnknown_var**)
- Lists all the signals connected to an EfdEquipment object.
- o
ListContactPoints(CATListValCATBaseUnknown_var**)
- Lists contact points objects directly referenced within the
EfdEquipment.
- o
ListEfdConnectors(CATListValCATBaseUnknown_var**)
- Lists functional connector objects directly referenced within the
EfdEquipment.
Methods
o AddContactPoint
-
Creates a contact point.
- Parameters:
-
- iObjectId
- contact point user identifier
- iIdNumber
- identification number
- oContactPoint
- contact point created
Legal values: NULL
o AddEfdConnector
-
Creates electrical connector.
- Parameters:
-
- iObjectId
- connector user identifier
- iIdNumber
- identification number
- oConnector
- the EfdConnector created
Legal values: NULL
o GetSystem
-
Retrieves the electrical system in which it is contained.
- Parameters:
-
- oSystem
- the EfdSystem object
o ListAssociatedSignals
public virtual HRESULT ListAssociatedSignals( | CATListValCATBaseUnknown_var** | oSignals)=0 |
-
Lists all the signals connected to an EfdEquipment object.
- Parameters:
-
- oSignals
- the list of ElecSignal objects
Legal values: NULL if the list
is created from scratch, orNOT NULL if you want to
append new elements to the list
o ListContactPoints
public virtual HRESULT ListContactPoints( | CATListValCATBaseUnknown_var** | oContacts)=0 |
-
Lists contact points objects directly referenced within the
EfdEquipment.
- Parameters:
-
- oContacts
- the list of Contact Points objects
Legal values: NULL if the list
is created from scratch, orNOT NULL if you want to
append new elements to the list
o ListEfdConnectors
public virtual HRESULT ListEfdConnectors( | CATListValCATBaseUnknown_var** | oConnectors)=0 |
-
Lists functional connector objects directly referenced within the
EfdEquipment.
- Parameters:
-
- oConnectors
- the list of functional connector objects
Legal values: NULL if the list
is created from scratch, orNOT NULL if you want to
append new elements to the list
This object is included in the file: CATIEfdEquipment.h
If needed, your Imakefile.mk should include the module: CATEFDInterfaces