All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecDeviceItf Interface CATIElbMountingEquipment
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIElbMountingEquipment
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIElbMountingEquipment
Interface to manage Mounting Equipments.
Method Index
- o
AddDevice(CATIElbCavity*,CATBaseUnknown*,int&)
- Adds a device on a mounting equipment cavity.
- o
GetFatherMountingEquipmentCavity(CATIElbCavity*&)
- Retrieves the cavity of the parent mounting equipment.
- o
ListBundleCnctPts(CATListValCATBaseUnknown_var*&)
- Retrieves the list of bundle connection points.
- o
ListCavities(CATListValCATBaseUnknown_var*&)
- Retrieves the list the cavities.
- o
ListDeviceComposition(CATListValCATBaseUnknown_var*&)
- Retrieves the list of device composition.
- o
ListTerminations(CATListValCATBaseUnknown_var*&)
-
Methods
o AddDevice
-
Adds a device on a mounting equipment cavity.
- Parameters:
-
- ipElecCavity
- The cavity of the mounting equipment
- ipElecDevice
- The device to be connected to the mounting equipment cavity
(only connector or equipment are authorized at the moment)
- StatusOfGeometricalConstraint
- The geometrical constraint status.
Legal values:
- 0 if all geometrical constraint are correctly created
- 1 if a geometrical constraint is over constraint
- 2 if no geometrical constraint was defined to constraint the device between them.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o GetFatherMountingEquipmentCavity
-
Retrieves the cavity of the parent mounting equipment.
- Parameters:
-
- oCavity
- The cavity of the parent mounting equipment occupied by this mounting equipment
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o ListBundleCnctPts
public virtual HRESULT ListBundleCnctPts( | CATListValCATBaseUnknown_var*& | oBundleCnctPts) = 0 |
-
Retrieves the list of bundle connection points.
- Parameters:
-
- oBundleCnctPts
- The retrieved list of bundle connection points
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o ListCavities
public virtual HRESULT ListCavities( | CATListValCATBaseUnknown_var*& | oCavities) = 0 |
-
Retrieves the list the cavities.
- Parameters:
-
- oCavities
- The retrieved list of cavities
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o ListDeviceComposition
public virtual HRESULT ListDeviceComposition( | CATListValCATBaseUnknown_var*& | oDevices) = 0 |
-
Retrieves the list of device composition.
- Parameters:
-
- oDevices
- The retrieved list of device composition.
It is made up of ElecConMountingEquipment, ElecSicCon, ElecStud, ElecTermBlock, ElectermStrip, Equipment and MountingEquipment.
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
o ListTerminations
public virtual HRESULT ListTerminations( | CATListValCATBaseUnknown_var*& | oTerminations) = 0 |
-
- Deprecated:
- V5R15 - There are no Terminations on a MountingEquipment so this method is
Retrieves the list of terminations.
- Parameters:
-
- oTerminations
- The retrieved list of terminations
- Returns:
- S_OK if the method succeeds, or E_FAIL otherwise
This object is included in the file: CATIElbMountingEquipment.h
If needed, your Imakefile.mk should include the module: CATElbInterfaces