All Frameworks Class Hierarchy This Framework Previous Indexes
CATDataExchControlAlgo Class CATDECProductToProductConvertor
CATDECProductToProductConvertor
Usage: you must use this class as is. You should never derive it.
public class CATDECProductToProductConvertor
Create a new CATProduct from a CATProduct
Role: This service is used to convert a Product into a Product.
Usage:
- Create convertion operator by CATCreateProductToProductConvertor (CATDocument *)
- Set convertion options
- Run convertion.
- GetResult to retrieve the CATDocument result.
Constructor and Destructor Index
- o
CATDECProductToProductConvertor()
-
Method Index
- o
GetError()
- Error message if run failed.
- o
GetResult()
- Result.
- o
Run()
- Convert the product according to the options.
- o
SetOption(CATUnicodeString,CATBoolean)
- Set or unset options.
Constructor and Destructor
o CATDECProductToProductConvertor
public virtual ~ CATDECProductToProductConvertor( | ) |
-
Methods
o GetError
-
Error message if run failed.
- Returns:
- returns message error.
o GetResult
-
Result.
- Returns:
- returns result CATProduct.
o Run
-
Convert the product according to the options. This function can be called only one time.
This function load the input CATProduct, create a new CATProduct.
- Returns:
- returns S_OK if done.
o SetOption
-
Set or unset options. This function must be called before RUN.
- Parameters:
-
- iOpt
-
- iOpt = "KeepProductProperties" for keeping Part product properties of reference Part.
- iOpt = "KeepSubColors" for keeping sub color elements of reference Part.
- iOpt = "KeepAnnotations" for keeping 3D Functional Tolerancing & Annotation elements of reference Part.
- iOpt = "KeepPublications" for keeping publication of reference Part.
- iOpt = "KeepSelectionSet" for keeping selection set of reference Part.
- iOpt = "KeepLayerFilter" for keeping Layer and filter on elements of reference Part.
- iOpt = "Keep2DLayout" for keeping 2D Layout element of reference Part.
- iOpt = "Suffix=xxxxx" for setting suffix to add to part numbers and display names.
- iOpt = "Trace" for log trace
- iMode
- TRUE to set the option on
- Returns:
- returns S_OK if done.
This object is included in the file: CATDECProductToProductConvertor.h
If needed, your Imakefile.mk should include the module: CATDECProductToPartCAA