All Frameworks Class Hierarchy This Framework Indexes Previous Next

ProductStructureUseItf Interface CATIPrdRepresentationReferenceFactory

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

interface CATIPrdRepresentationReferenceFactory

Interface to create PLM Product Representation Reference.

Role: This interface is the factory to create different kind of Product Representation Reference objects .
A pointer on this interface can be retrieved using the class.

Method Index

o Create3DShape(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIPsiRepresentationReference*&)
o Create3DShape(CATIType_var&,CATListValCATICkeParm_var&,CATIPsiRepresentationReference*&,CATIAdpEnvironment*): Creates a new 3DShape.
o CreateNonCATIA(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATUnicodeString&,CATUnicodeString&,CATIPsiRepresentationReference*&): Creates a new Product Representation Reference with an existing non CATIA V5 file.

Methods

o Create3DShape

public virtual Create3DShape(		`ipEnv`,
		`iPrdRepAttributesValues`,
		`oRepReference`)

Deprecated:

R215 Creates a new 3DShape. Please use Create3DShape method with CATIType argument
Role: This method creates a 3DShape Product Representation Reference.

This API invokes the following Business Logic Openness:

PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

ipEnv: The environment defining the project. The project determines the deployment type to associate (or not) to the new PLM Object.
If the argument is NULL, the current environment is used.
iPrdRepAttributesValues: A list of Product Representation Reference attributes values.
This list must not contain deployment attributs. This list must be empty.
oRepReference: [out, CATBaseUnknown#Release] The created Product Representation Reference.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

Returns:

S_OK if the Product Representation Reference has been successfully created.
E_FAIL if internal error occurred, the PLM object is not created.
INVALIDARG at least one argument is either missing or invalid.

o Create3DShape

public virtual Create3DShape(	`iType`,
	`iPrdRepAttributesValues`,
	`oRepReference`,
	`ipEnv`	`=NULL`)

Creates a new 3DShape.
Role: This method creates a 3DShape Product Representation Reference.

This API invokes the following Business Logic Openness:

PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

iType: The Knowledge type (can be a modeler type, a discipline at creation of a functional specialization) derived from 3DShape
iPrdRepAttributesValues: A list of Product Representation Reference attributes values.
This list must not contain deployment attributs. This list must be empty.
oRepReference: [out, CATBaseUnknown#Release] The created Product Representation Reference.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.
ipEnv: The environment defining the project. The project determines the deployment type to associate (or not) to the new PLM Object.
If the argument is NULL, the current environment is used.

Returns:

S_OK if the Product Representation Reference has been successfully created.
E_FAIL if internal error occurred, the PLM object is not created.
INVALIDARG at least one argument is either missing or invalid.

o CreateNonCATIA

public virtual CreateNonCATIA(		`ipEnv`,
		`iPrdRepAttributesValues`,
	const	`iFileExtension`,
	const	`iDocumentPath`,
		`opRepReference`)

Creates a new Product Representation Reference with an existing non CATIA V5 file.
Role: This method creates a Product Representation Reference with an existing non CATIA V5 file document attached as Authoring Stream Descriptor.

This API invokes the following Business Logic Openness:

PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

ipEnv: The environment defining the project. The project determines the deployment type to associate (or not) with the new PLM Object.
If the argument is NULL, the current environment is used.
iPrdRepAttributesValues: A list of Product Representation Reference attributes values.
This list must not contain deployment attributs. This list must be empty.
iFileExtension: The type of the existing non CATIA V5 file to add as Authoring Stream Descriptor.
For any information about extension type, refer to the CAA Encyclopedia documentation: PLM Representation Reference Overview section.
iDocumentPath: The file path of the existing non CATIA V5 file (including the extension).
This parameter MUST NOT be provided by caller as NULL. This method returns E_INVALIDARG otherwise.
opRepReference: [out, CATBaseUnknown#Release] The created Product Representation Reference.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

Returns:

S_OK if the Product Representation Reference has been successfully created.
E_FAIL if internal error occurred, the Product Representation Reference object is not created.
INVALIDARG at least one argument is either missing or invalid.

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