All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecHarnessItf Interface CATIEhiBundleSegment
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIEhiBundleSegment
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiBundleSegment
Interface to manage bundle segment.
Role:A bundle segment is a subdivision of
geometrical bundle . Bundle segment route may be
defined by electrical flexible curve ( computed
under geometrical and physical constraints ).
Method Index
- o
AddSupport(CATIProduct*,CatEhiSupportMode,int*,CatEhiInsertMode)
- Add support to bundle segment.
- o
CreatePositionPoint(CATBaseUnknown*,CATIEhiPositionPoint**)
- Create harness position point from point.
- o
GetElecCurve(CATIGSMSpline**)
- Retrieve flexible curve of bundle segment.
- o
GetExtremities(CATIEhiBnlSegmentExtremity**,CATIEhiBnlSegmentExtremity**)
- Retrieve bundle segment extremities ( connector points ).
- o
GetLocationSupport(CATIEhiBnlSegmentExtremity*,CATIProduct*,double&)
- Retrieve the location of the bundle segment's support.
- o
GetRepresentation(CATBaseUnknown**)
- Retrieve geometrical representation of bundle segment.
- o
ListLinkedProtections(CATListValCATBaseUnknown_var**)
- List Protections Linked to the Bundle Segment.
- o
ListLinkedSupports(CATListValCATBaseUnknown_var**)
- Retrieve list of support linked to bundle segment.
- o
Merge(CATIEhiBundleSegment*)
- Merge two bundle segment.
- o
Split(CATIGSMPointOnCurve*,CATIEhiBundleSegment*&)
- Split a bundle segment.
Methods
o AddSupport
-
Add support to bundle segment.
- Parameters:
-
- iSupport
- The instance of the support
- iSupportMode
- direction of entrance of the bns in the support
= catEhiDirectMode
= catEhiInvertMode
- num
- point number on the curve
- iInsertMode
- insertion mode
= catEhiInsertBefore : insertion of support before the given point
= catEhiInsertAfter : insertion of support after the given point
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while adding support.
o CreatePositionPoint
-
Create harness position point from point.
. Add electrical properties to any point or external reference to point.
. Enable to add extra length or cancel slack between two points of bundle segment.
- Parameters:
-
- ipPoint
- The point.
- opEhiPoint
- The harness position point.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Creation of position point failed.
o GetElecCurve
-
Retrieve flexible curve of bundle segment.
Role:Flexible curve defines bundle segment route.
- Parameters:
-
- oFlexibleCurve
- Flexible curve.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The flexible curve is found .
- E_FAIL
- The curve cannot be found or bundle segment
route is defined by an external curve .
o GetExtremities
-
Retrieve bundle segment extremities ( connector points ).
- Parameters:
-
- opBnlSegmentExt1
- connector point at extremity 1.
- opBnlSegmentExt2
- connector point at extremity 2.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- The bundle segment representation does not exist.
o GetLocationSupport
-
Retrieve the location of the bundle segment's support.
- Parameters:
-
- ipBnsExtremity
- The extremity of the bundle segment from where the location is computed.
- ipSupport
- The support from which the location is computed.
- oLocationSupport
- The distance between the extremity chosen and the support.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while computing location.
o GetRepresentation
-
Retrieve geometrical representation of bundle segment.
Role:the current bundle segment representation is a part feature : Rib .
- Parameters:
-
- opBundleSegmentBody
- Bundle segment representation (Rib).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- The bundle segment representation does not exist.
o ListLinkedProtections
public virtual HRESULT ListLinkedProtections( | CATListValCATBaseUnknown_var** | opListProtections)= 0 |
-
List Protections Linked to the Bundle Segment.
- Parameters:
-
- oListProtections
- The list of Protections linked to the Bundle Segment
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while searching supports.
o ListLinkedSupports
public virtual HRESULT ListLinkedSupports( | CATListValCATBaseUnknown_var** | oSupports)= 0 |
-
Retrieve list of support linked to bundle segment.
- Parameters:
-
- oSupports
- List of supports linked to bundle segment.
Method returns NULL value if no support is linked.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while searching supports.
o Merge
-
Merge two bundle segment.
- Parameters:
-
- ipBundleSegment
- The bundle segment to merge.
o Split
-
Split a bundle segment.
- Parameters:
-
- ipGSMPoint
- The point of the curve where we split the bundle segment.
- opBundleSegment
- The bundle segment created by split of bundle segment.
This object is included in the file: CATIEhiBundleSegment.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces