All Frameworks Class Hierarchy This Framework Previous Next Indexes
ElecHarnessItf Interface CATIEhiBranchable
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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
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
-
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
-
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
-
Retrieves the MultiBranchable of the Branchable.
- Parameters:
-
- opMultiBranchable
- the MultiBranchable.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- No error .
- E_FAIL
- Error.
o ListBundleSegments
public virtual HRESULT ListBundleSegments( | CATListValCATBaseUnknown_var** | oBundleSegments) = 0 |
-
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 HRESULT ListObjectsInRoute( | CATListValCATBaseUnknown_var** | oObjects, |
| CATListOfInt** | oPositionOnCurve)=0 |
-
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