All Frameworks Class Hierarchy This Framework Indexes Previous Next

ProductStructureUseItf Interface CATIPrdReferenceFactory

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

interface CATIPrdReferenceFactory

Interface to create PLM Product Reference.
Role: This interface is the factory to create PLM Product Reference objects.
A pointer on this interface can be retrieved using the class.

Method Index

o CreatePrdReference(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIPLMProducts*&)
o CreatePrdReference(CATIType_var&,CATListValCATICkeParm_var&,CATIPLMProducts*&,CATIAdpEnvironment*): Creates a new PLM Product Reference.

Methods

o CreatePrdReference

public virtual CreatePrdReference(		`ipEnv`,
		`iPrdAttributesValues`,
		`opReference`)

Deprecated:

R215 Creates a new PLM Product Reference. Please use CreatePrdReference method with CATIType argument *****
Role: This method creates a Product 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.
iPrdAttributesValues: A list of Product attributes values. This list must be empty.
opReference: [out, CATBaseUnknown#Release]
The created Product Reference.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

Returns:

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

o CreatePrdReference

public virtual CreatePrdReference(	`iType`,
	`iPrdAttributesValues`,
	`opReference`,
	`ipEnv`	`=NULL`)

Creates a new PLM Product Reference.
Role: This method creates a Product 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
iPrdAttributesValues: A list of Product attributes values. This list must be empty.
opReference: [out, CATBaseUnknown#Release]
The created Product 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 Reference has been successfully created.
E_FAIL if internal error occurred, the Product Reference object is not created.
INVALIDARG at least one argument is either missing or invalid.

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