All Frameworks Class Hierarchy This Framework Indexes
ElecHarnessItf Interface CATIEhiBranchable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEhiBranchable
Interface to manage Branchable .
Role:A Branchable is a group of bundle segments.
Method Index
- o
AddSupport(CATIProduct*,CatEhiSupportMode,int*,CatEhiInsertMode)
- Add support to bundle segment.
- o
GetElecCurve(CATBaseUnknown**)
- Retrieves the Curve of the Branchable.
- o
GetMultiBranchable(CATIEhiMultiBranchable**)
- Retrieves the MultiBranchable of the Branchable.
- o
InsertSupport(CATIProduct*,CatEhiSupportMode,int,CatEhiInsertMode,int)
- Insert support to Branchable.
- o
ListBundleSegments(CATListValCATBaseUnknown_var**)
- Lists Bundle Segments contained in the Branchable in an ordered list.
- o
ListObjectsInRoute(CATListValCATBaseUnknown_var**,CATListOfInt**)
- Retrieves the objects pointed by the Curve of the Branchable.
Methods
o AddSupport
| public virtual AddSupport( | | iSupport, |
| | iSupportMode, |
| | num, |
| | iCurveMode | = catEhiInsertAfter) |
-
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 GetElecCurve
| public virtual GetElecCurve( | | opCurve) |
-
Retrieves the Curve of the Branchable.
- Parameters:
-
- opCurve
- The curve object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o GetMultiBranchable
| public virtual GetMultiBranchable( | | opMultiBranchable) |
-
Retrieves the MultiBranchable of the Branchable.
- Parameters:
-
- opMultiBranchable
- the MultiBranchable.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o InsertSupport
| public virtual InsertSupport( | | ipSupportInstance, |
| | iSupportMode, |
| | iPointIndex, |
| | iCurveMode, |
| | isection_number | = 1 ) |
-
Insert support to Branchable.
- Parameters:
-
- ipSupportInstance
- The product instance of the support
- iSupportMode
- direction of entrance of the Branchable route in the support
= catEhiDirectMode : from entry plane to output plane
= catEhiInvertMode : from output plane to entry plane
- iPointIndex
- point position in the ordered list of points of the branchable route
- iCurveMode
- insertion mode
= catEhiInsertBefore : insertion of support before the given point
= catEhiInsertAfter : insertion of support after the given point
- isection_number
- section of the support
default value is 1
not used for retainer support
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- no error.
- E_FAIL
- Error occured while adding support.
o ListBundleSegments
| public virtual ListBundleSegments( | | oBundleSegments) |
-
Lists Bundle Segments contained in the Branchable in an ordered list.
- Parameters:
-
- oBundleSegments
- The List of Bundle Segments
is in the Branchable.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error occured while searching bundle segments.
- E_FAIL
- Error.
o ListObjectsInRoute
| public virtual ListObjectsInRoute( | | oObjects, |
| | oPositionOnCurve) |
-
Retrieves the objects pointed by the Curve of the Branchable.
Objects are product instance pointed by external reference and supports from the curve and their respective position in the curve.
The position on curve will enable you to retrieve absissa along the curve.
- Parameters:
-
- oObjects
- The object list.
- oPositionOnCurve
- The position on curve.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
This object is included in the file: CATIEhiBranchable.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces