All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecHarnessItf Interface CATIEhiProtection
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEhiProtection
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiProtection
Interface to manage Protections.
Method Index
- o
ComputeLength(double&)
- Computes the length of the protection.
- o
GetCurve(CATBaseUnknown**)
- Retrieve the center curve of a protection.
- o
GetInnerDiameter(CATICkeInst*&)
- Retrieve the inner diameter value of the protection.
- o
GetLocationExtremities(CATIEhiBnlSegmentExtremity*,double&,double&)
- Retrieve the distance between a bundle segment extremity and each extremity of protection.
- o
GetProtectionExtremities(CATISpecObject*&,CATISpecObject*&)
- Gets Extremities of a Protection.
- o
GetRepresentation(CATListValCATBaseUnknown_var**)
- Retrieve geometrical representation of a protection.
- o
ListBundleSegments(CATListValCATBaseUnknown_var*&)
- Lists BNS in a Protection.
- o
SetProtectionExtremities(double,double)
-
Sets Extremities of a Protection.
Methods
o ComputeLength
public virtual HRESULT ComputeLength( | double& | oLength)=0 |
-
Computes the length of the protection.
- Parameters:
-
- oLength
- Length of the protection (in meters)
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Length has been computed .
- E_FAIL
- Length has not been computed
o GetCurve
-
Retrieve the center curve of a protection.
Role:The curve defines the route of the protection.
- Parameters:
-
- opCurve
- The curve object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- The protection representation does not exist.
o GetInnerDiameter
-
Retrieve the inner diameter value of the protection.
- Parameters:
-
- Output
- : pCkeInnerDiameter is the value of the Inner Diameter of protection.
- Returns:
- An HRESULT value.
Legal values
S_OK : No error .
E_FAIL : The inner diameter value was’t found..
o GetLocationExtremities
public virtual HRESULT GetLocationExtremities( | CATIEhiBnlSegmentExtremity* | ipElecBundleSegmentExtremity, |
| double& | oPositionFirstExtremity, |
| double& | oPositionSecondExtremity) = 0 |
-
Retrieve the distance between a bundle segment extremity and each extremity of protection. NEW V5R14.
- Parameters:
-
- ipElecBundleSegmentExtremity
- Input : a Bundle Segment Extremity.
- Output
- : PositionFirstExtremity is the length between first extremity of Protection and Bundle Segment Extremity.
- Output
- : PositionFirstExtremity is the length between second extremity of Protection and Bundle Segment Extremity.
- Returns:
- An HRESULT value.
Legal values
S_OK : No error .
E_FAIL : The position of extremity was’t found..
o GetProtectionExtremities
-
Gets Extremities of a Protection.
- Parameters:
-
- opProtExt1
- First Extremity of the protection
- opProtExt1
- Second Extremity of the protection
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Extremities are found .
- E_FAIL
- Extremities cannot be found
o GetRepresentation
public virtual HRESULT GetRepresentation( | CATListValCATBaseUnknown_var** | opLReps)=0 |
-
Retrieve geometrical representation of a protection.
Role:the current protection representation are part features : Rib or rib and slot.
- Parameters:
-
- opLReps
- List containing the protection representation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- The protection representation does not exist.
o ListBundleSegments
public virtual HRESULT ListBundleSegments( | CATListValCATBaseUnknown_var*& | oBundleSegments)=0 |
-
Lists BNS in a Protection.
- Parameters:
-
- oBundleSegments
- Input : List of BNS included in the protection
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Bundle Segments are listed .
- E_FAIL
- Bundle Segments cannot be listed
o SetProtectionExtremities
public virtual HRESULT SetProtectionExtremities( | double | iL1, |
| double | iL2)=0 |
-
Sets Extremities of a Protection.
- Parameters:
-
- iL1
- distance Extremity1 of Join-Extremity1 of Split
- iL2
- distance Extremity1 of Join-Extremity2 of Split
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Extremities are updated .
- E_FAIL
- Extremities cannot be updated
This object is included in the file: CATIEhiProtection.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces