All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctRepresentationReferenceFactory

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

interface CATIFctRepresentationReferenceFactory

Interface to create Functional Representation References objects.
Role: This interface is a factory to allowing to create Functional representation references.

Example:

  CATIFctRepresentationReferenceFactory *pFunctionalRepReferenceFactory = NULL; 

  HRESULT Hr = CATFctFactoriesProvider::GetRepresentationReferenceFactory(pFunctionalRepReferenceFactory); 

  if(SUCCEEDED(Hr) && pFunctionalRepReferenceFactory) 

  { 

    ...

See also:

, ,

Method Index

o CreateWith2DPicture(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATUnicodeString&,CATIFct2DPictureRepReference*&): Creates a Functional 2D Picture Representation Reference.
o CreateWithNonCATIAContent(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATUnicodeString&,CATIFctRepresentationReference*&): Creates a multi-instantiable Functional Non DSContent Representation Reference with a non CATIA stream.

Methods

o CreateWith2DPicture

public virtual CreateWith2DPicture(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
	const	`iPicturePath`,
		`op2DPictureRepReference`)

Creates a Functional 2D Picture Representation Reference.
Role: This method creates a Functional Representation Reference with an associated 2D Picture given the path of the picture file. Supported picture file types are the following ones: jpg, jpeg, bmp, tif, tiff and png.
The stream corresponding to the picture file will be saved into the database (without keeping any reference to the provided path).

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.

Once created, the 2D Picture Representation Reference can be associated to one or several Functional References using interface.

Parameters:

ispType: The type of the 2D Picture Representation Reference to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalRepReference will be used by default for creation.
Input Parameter.
ipEnvtForProject: 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.
Input Parameter.
iLFctAttributesValues: A list of Functional attributes values (of the Functional 2D representation reference to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
Input Parameter.
This list must be empty.
iPicturePath: A path corresponding to a picture file.
Input Parameter.
This parameter MUST NOT be provided by caller as empty. This method returns an error otherwise.
op2DPictureRepReference: [out, CATBaseUnknown#Release]
The created 2D Picture Representation Reference.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o CreateWithNonCATIAContent

public virtual CreateWithNonCATIAContent(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
	const	`iDocumentPath`,
		`opFunctionalRepReference`)

Creates a multi-instantiable Functional Non DSContent Representation Reference with a non CATIA stream.
Role: This method creates a Functional Non DSContent Representation Reference with an associated non CATIA stream (given the path of a document).
Main supported non CATIA documents are the following ones: xls, doc, txt, xml, pdf, jpg,...
The stream corresponding to the non CATIA document file will be saved into the database (without keeping any reference to the provided path).

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:

ispType: The type of the Functional Representation Reference to create. If this argument is a NULL pointer OR is not a a sort of FunctionalNonDSContentRepReference, the modeler type RFLPLMFunctionalRepReference will be used by default for creation.
Input Parameter.
ipEnvtForProject: 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.
Input Parameter.
iLFctAttributesValues: A list of Functional attributes values (of the Functional representation reference to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
Input Parameter.
This list must be empty.
iDocumentPath: The file path of the non CATIA document (including its extension).
Input Parameter.
This parameter MUST NOT be provided by caller as empty. This method returns an error otherwise.
opFunctionalRepReference: [out, CATBaseUnknown#Release]
The created Functional Representation Reference.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns an error otherwise.
This parameter is returned to caller as NULL if method fails.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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