All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecHarnessItf Interface CATIEhiPositionPoint

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

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


interface CATIEhiPositionPoint

Interface to manage bundle segment position point.


Method Index


o GetLocalSlack(CATICkeInst**)
Retrieve extra length value.
o GetType(CATUnicodeString&)
Retrieve bundle segment position point type.
o SetLocalSlack(CATICkeInst*)
Set extra length value.
o Straighten()
Enable to create straight segment from this point to next point.

Methods


o GetLocalSlack
public virtual HRESULT GetLocalSlack(CATICkeInst** opValue)= 0
Retrieve extra length value.
Parameters:
opValue
.The value
for "Straight" type , value returned is NULL.
Returns:
An HRESULT value.
Legal values:
S_OK
no error.
E_FAIL
Error occured
o GetType
public virtual HRESULT GetType(CATUnicodeString& oPointType)= 0
Retrieve bundle segment position point type.
Parameters:
iPointType
.The point type
"Straight" : straight segment.
"LocalSlack" : extra length is added from this point to next point.
Returns:
An HRESULT value.
Legal values:
S_OK
no error.
E_FAIL
Error occured while managing point
o SetLocalSlack
public virtual HRESULT SetLocalSlack(CATICkeInst* ipValue= NULL )= 0
Set extra length value.
Parameters:
ipValue
.The value
Returns:
An HRESULT value.
Legal values:
S_OK
no error.
E_FAIL
Error occured
o Straighten
public virtual HRESULT Straighten()=0
Enable to create straight segment from this point to next point.
Returns:
An HRESULT value.
Legal values:
S_OK
no error.
E_FAIL
Error occured

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

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