ElecFlatteningItf Interface CATIEhfLengthTolerance

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


interface CATIEhfLengthTolerance

This Interface CATIEhfLengthTolerance allows to manage the Length Tolerance object.
Interface CATIEhfLengthTolerance is implemented on the Length Tolerance feature and should be used by user.


Method Index


o GetFixExtremity(CATBaseUnknown*&)
Retrieves the Fix extremity of the Length Tolerance.
o GetMoveExtremity(CATBaseUnknown*&)
Retrieves the Move extremity of the Length Tolerance.
o GetName(CATUnicodeString&)
Retrieves the name of the Length Tolerance.
o GetPortionLength(CATICkeInst*&)
Retrieves the length of the segment portion where the Length Tolerance was applied.
o GetToleranceValue(CATICkeInst*&)
Retrieves the value of applied Length Tolerance.
o SetToleranceValue(CATICkeInst*,CATIPrdObject*)
to set the value of Length Tolerance.

Methods


o GetFixExtremity
public virtual GetFixExtremity( opIUnkFixExtremity)
Retrieves the Fix extremity of the Length Tolerance.
Parameters:
opIUnkFixExtremity
(Output): Pointer on the Fix extremity of the Length Tolerance.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute
o GetMoveExtremity
public virtual GetMoveExtremity( opIUnkMoveExtremity)
Retrieves the Move extremity of the Length Tolerance.
Parameters:
opIUnkMoveExtremity
(Output): Pointer on the Move extremity of the Length Tolerance.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute
o GetName
public virtual GetName( oLengthToleranceName)
Retrieves the name of the Length Tolerance.
Parameters:
oLengthToleranceName
(Output): CATUnicodeString which contains the Name of Length Tolerance.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute
o GetPortionLength
public virtual GetPortionLength( opICkeInstPortionLength)
Retrieves the length of the segment portion where the Length Tolerance was applied.
Parameters:
opICkeInstPortionLength
(Output): Pointer on CATICkeInst which contains the curvilinear length between the two extremities.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute
o GetToleranceValue
public virtual GetToleranceValue( opICkeInstToleranceValue)
Retrieves the value of applied Length Tolerance.
Parameters:
opICkeInstToleranceValue
(Output): Pointer on CATICkeInst which contains the value of the Length Tolerance applied between the two extremities.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute
o SetToleranceValue
public virtual SetToleranceValue( const ipICkeInstToleranceValue,
ipIProdRoot)
to set the value of Length Tolerance.
Parameters:
ipICkeInstToleranceValue
(Input): Pointer on CATICkeInst which contains the value of the Length Tolerance to be applied between the two defined extremities
ipIProdRoot
(Input): Pointer on the "Root" Product of Flattened document.
Returns:
An HRESULT value
Legal values:
S_OK
The attribute is successfully retrieved
E_FAIL
An error occurred while retrieving the attribute

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.