All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecHarnessItf Interface CATIEhiGeoBundle

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIEhiGeoBundle
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIEhiGeoBundle

Interface to manage geometrical bundle .
Role:A geometrical bundle federates a group of bundle segments and/or devices.


Method Index


o ComputeBundleSegment(CATIEhiBundleSegment*)
Create or update geometrical representation of bundle segment .
o ComputeMultiBranchable(CATIEhiMultiBranchable*)
Create or update geometrical representation of multi branchable.
o CreateBundleSegment(CATIEhiBundleSegment**)
o CreateMultiBranchable(CATIEhiMultiBranchable**)
Add multi branchable in geometrical bundle.
o InstanciateProtection(CATIProduct*,CATListValCATBaseUnknown_var*,double,double,CATIEhiProtection*&)
Instantiates a Protection .
o ListBundleSegments(CATListValCATBaseUnknown_var**)
List electrical bundle segments contained in the geometrical bundle.

Methods


o ComputeBundleSegment
public virtual HRESULT ComputeBundleSegment(CATIEhiBundleSegment* ipBundleSegment) = 0
Create or update geometrical representation of bundle segment .
Role:the current bundle segment geometrical representation is a part feature : Rib .
If bundle segment representation already exists, only update is performed.
Parameters:
opBundleSegmentBody
Bundle segment representation (Rib).
Returns:
An HRESULT value.
Legal values:
S_OK
No error .
E_FAIL
The bundle segment representation creation failed.
o ComputeMultiBranchable
public virtual HRESULT ComputeMultiBranchable(CATIEhiMultiBranchable* ipMultiBranchable) = 0
Create or update geometrical representation of multi branchable.
Role:the current bundle segment geometrical representation is a part feature : Rib .
If bundle segment representation already exists, only update is performed.
Parameters:
opBundleSegmentBody
Bundle segment representation (Rib).
Returns:
An HRESULT value.
Legal values:
S_OK
No error .
E_FAIL
The bundle segment representation creation failed.
o CreateBundleSegment
public virtual HRESULT CreateBundleSegment(CATIEhiBundleSegment** opBundleSegment)= 0
Deprecated:
V5R15 Use CATIEhiGeoBundle.CreateMultiBranchable Add bundle segment in geometrical bundle. New CATPart document is created and instanciated under geometrical bundle.
Parameters:
oBundleSegment
The electrical bundle segment instance or NULL creation failed
Returns:
An HRESULT value.
Legal values:
S_OK
No error occured while creating bundle segment.
E_FAIL
Error.
o CreateMultiBranchable
public virtual HRESULT CreateMultiBranchable(CATIEhiMultiBranchable** opMultiBranchable)= 0
Add multi branchable in geometrical bundle. New CATPart document is created and instanciated under geometrical bundle.
Parameters:
opMultiBranchable
The multi branchable instance or NULL creation failed
Returns:
An HRESULT value.
Legal values:
S_OK
No error occured while creating multi branchable.
E_FAIL
Error.
o InstanciateProtection
public virtual HRESULT InstanciateProtection(CATIProduct* ipRefProtection,
CATListValCATBaseUnknown_var* ipListOfBundleSegments,
double iRatio1,
double iRatio2,
CATIEhiProtection*& opProtection) = 0
Instantiates a Protection .
Role: CATPart document is instanciated under geometrical bundle.
Parameters:
ipRefProtection
Reference of Protection to instanciate.
ipListOfBundleSegments
List Of Bundle segments that we want to protect.
iRatio1
ratio (distance Extremity1 of Join-Extremity1 of Split)/Length of Join
iRatio2
ratio (distance Extremity1 of Join-Extremity2 of Split)/Length of Join
opProtection
Protection Instance
Returns:
An HRESULT value.
Legal values:
S_OK
No error .
E_FAIL
The bundle segment representation creation failed.
o ListBundleSegments
public virtual HRESULT ListBundleSegments(CATListValCATBaseUnknown_var** oBundleSegments) = 0
List electrical bundle segments contained in the geometrical bundle.
Parameters:
oBundleSegments
The electrical bundle segments or NULL if no bundle segment is linked to geometrical bundle.
Returns:
An HRESULT value.
Legal values:
S_OK
No error occured while searching bundle segments.
E_FAIL
Error.

This object is included in the file: CATIEhiGeoBundle.h
If needed, your Imakefile.mk should include the module: CATEhiInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.