All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATDataExchControlAlgo Class CATDECProductToPartConvertor

CATDECProductToPartConvertor
 

Usage: you must use this class as is. You should never derive it.


public class CATDECProductToPartConvertor

Create a new CATPart from a CATProduct
Role: This service is used to convert a Product into a Part file.


Usage:



Constructor and Destructor Index


o CATDECProductToPartConvertor()

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 CATDECProductToPartConvertor
public virtual ~ CATDECProductToPartConvertor()

Methods


o GetError
public virtual CATUnicodeString GetError()const = 0
Error message if run failed.
Returns:
returns message error.
o GetResult
public virtual CATDocument * GetResult()const = 0
Result.
Returns:
returns result CATPart.
o Run
public virtual HRESULT Run()= 0
Convert the product according to the options. This function can be called only one time.
This function load the input CATProduct, create a new CATPart and unload the input CATProduct and output CATPart.
Returns:
returns S_OK if done.
o SetOption
public virtual HRESULT SetOption( const CATUnicodeString iOpt,
const CATBoolean iMode) = 0
Set or unset options. This function must be called before RUN.
Parameters:
iOpt
  • iOpt = "MergeAllBodies" for "Merge all bodies of each part in one body"
  • iOpt = "KeepSubColors" for keeping sub color elements
  • 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: CATDECProductToPartConvertor.h
If needed, your Imakefile.mk should include the module: CATDECProductToPartCAA

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