All Frameworks Class Hierarchy This Framework Indexes Previous Next

ElecFlatteningItf Interface CATIEhfManageLengthTolerance

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

interface CATIEhfManageLengthTolerance

This Interface CATIEhfManageLengthTolerance allows to manage the creation, removal and retrieve of Length Tolerance objects on a Branch.
This interface is implemented on a Branch (Branchable) bundle segment.

Method Index

o CreateLengthTolerance(CATIEhfLengthTolerance**,CATBaseUnknown*,CATBaseUnknown*,CATIPrdObject*,CATBaseUnknown*,CATICkeInst*): This method allows to create Length Tolerance on a Branch.
o ListOfLengthTolerance(CATListValCATBaseUnknown_var**): This method allows to provide the list of Length Tolerance on the selected branch.
o RemoveLengthTolerance(CATListValCATBaseUnknown_var*,CATIPrdObject*,CATBoolean): This method allows to remove the applied Length Tolerance on branch.

Methods

o CreateLengthTolerance

public virtual CreateLengthTolerance(		`opILengthTolerance`,
	const	`ipFixExtremity`,
	const	`ipMoveExtremity`,
		`ipIProdRoot`,
	const	`ipDimension`,
	const	`ipLengthTolerance`)

This method allows to create Length Tolerance on a Branch.

Parameters:

opILengthTolerance: (Output): Return a pointer on the new Length Tolerance.
ipFixExtremity: (Input): First extremity for the definition of the portion on bundle segment. It is considered as the FIX point. Following elements are authorized for the selection: - Bundle Segment extremity (device connection point, branch point) - Route Definition point (including Support) - Protection Extremity Point
ipMoveExtremity: (Input): Second extremity for the definition of the portion on bundle segment. It is considered as the MOVE point. Elements authorised for selection are same as Fixed extremity
ipIProdRoot: (Input): Pointer on the "Root" Product of Flattened document.
ipDimension: (Input): Pointer to a Dimension which will allow to show the ‘dual value’ in the selected Dimension after applying the Length Tolerance. This input is optional, it can be NULL.
ipLengthTolerance: (Input): Length Tolerance value to apply (mm).

Returns:

An HRESULT value
Legal values:

S_OK: The Length Tolerance is successfully applied
E_INVALIDARG: If the two inputs “ipFixExtremity” and “IpMoveExtremity” do not belong to the same branchable bundle OR the type of those inputs are different from the authorized one
E_FAIL: An error occurred while applying the Length Tolerance

o ListOfLengthTolerance

public virtual ListOfLengthTolerance( oListLengthTolerances)

This method allows to provide the list of Length Tolerance on the selected branch.

Parameters:

oListLengthTolerances: (Output): List of pointers of the Length Tolerance objects on the branch.

Returns:

An HRESULT value
Legal values:

S_OK: The Length Tolerance features successfully retrieved
E_FAIL: An error occurred while retrieving the Length Tolerance features

o RemoveLengthTolerance

public virtual RemoveLengthTolerance(	`ipListLengthTolerances`,
	`ipIProdRoot`,
	`iKeepExtraLength`	`= FALSE` )

This method allows to remove the applied Length Tolerance on branch.

Parameters:

ipListLengthTolerances: (Input): List of pointer on the Length Tolerance object which will be removed.
ipIProdRoot: (Input): Pointer on the "Root" Product of Flattened document.
iKeepExtraLength: (Input, Optional): Optional setting during the removal of Length Tolerance: If TRUE, the result of the length adjustment applied by the ‘Length Tolerance’ command will be kept. In this case, the network which links to the MOVE extremity will NOT be moved. The Length Tolerance value will be added to the Design Length attribute of the bundle segment to make the bundle segment in standard mode (not in scale mode). If FALSE (this is the Default value), the added or reduced length on the given portion by the Length Tolerance command will be removed, and the network which links to the MOVE extremity will be moved back to the original position.

Returns:

An HRESULT value
Legal values:

S_OK: Length Tolerance features successfully removed
E_FAIL: An error occurred while removing the Length Tolerance features

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