All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDataExchControlUseItf Interface CATIDECProductToProduct

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

interface CATIDECProductToProduct

Create a new Product from a Product.

Role: This service is used to convert a Product into a new Product in session.
Usage:

Create conversion operator by QueryInterface on CATIPLMProducts*
Set conversion options.
Run conversion.
GetResult to retrieve the CATIPLMProducts* result.

Method Index

o GetError(): Error message if run failed.
o GetRep(): Result.
o GetResult(): Result.
o ResetAll(): Reset all data for multiple uses of this interface on the same PLMProduct.
o Run(): Convert the product according to the options.
o SetOption(CATUnicodeString,CATBoolean): Set or unset options.

Methods

o GetError

public virtual GetError(

)

Error message if run failed.

Returns:: returns message error.

o GetRep

public virtual GetRep(

)

Result.

Returns:: returns the resulting Representation.

o GetResult

public virtual GetResult(

)

Result.

Returns:: returns the resulting Product.

o ResetAll

public virtual ResetAll(

)

Reset all data for multiple uses of this interface on the same PLMProduct.

Returns:: returns S_OK if done.

o Run

public virtual Run(

)

Convert the product according to the options. This function can be called only one time.
This function creates a new Product in session.

Returns:: returns S_OK if done.

o SetOption

public virtual SetOption(	const	`iOpt`,
	const	`iMode`)

Set or unset options. This function must be called before RUN.

Parameters:

iOpt

iOpt = "KeepProductProperties" for keeping PLM product properties.
iOpt = "KeepSubColors" for keeping sub color elements.
iOpt = "NoKeepColor" for keeping default color of element. This option is priority on keepSubColors
iOpt = "KeepPublications" for keeping publication.
iOpt = "KeepLayerFilter" for keeping Layer and filter on elements.
iOpt = "KeepSelectionSet" for keeping selection set.
iOpt = "KeepAnnotations" for keeping 3D Functional Tolerancing & Annotation elements.
iOpt = "CaptureNameFilter=xxxxx" for keeping only annotations included in the FTA capture features whose name contains the string provided.
iOpt = "Keep2DLayout" for keeping 2D Layout element.
iOpt = "NoKeepSketchSpec" for keeping sketch as result. (default=keep sketch as specification)
iOpt = "Suffix=xxxxx" for setting suffix xxxx used in the user exit to define mandatory identifier.

iMode

TRUE to set the option on.

Returns:

returns S_OK if done.

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