All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctRepresentations

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

interface CATIFctRepresentations

Interface dedicated to manage the collections of mono-instantiable Functional Representation References aggregated by a Functional Reference.

Method Index

o AddWithNonCATIAContent(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATUnicodeString&,CATIFctRepresentationReference*&): Creates a Functional Non DSContent Representation Reference with a non CATIA stream.
o Count(int&): Retrieves the number of mono-instantiable Functional Representation References aggregated by this Functional Reference.
o List(CATListValCATIFctRepresentationReference_var&): Lists the collection of mono-instantiable Functional Representation References aggregated by this Functional Reference.
o Remove(CATIFctRepresentationReference*): Removes the given Functional Representation Reference that is aggregated by this Functional Reference.

Methods

o AddWithNonCATIAContent

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

Creates a Functional Non DSContent Representation Reference with a non CATIA stream.
Role: This method creates a mono-instantiable Functional Non DSContent Representation Reference with an associated non CATIA stream (given the path of a document) that will be aggregated by this Functional Reference.
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:

PLMInstanceAggregationCheck
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.

o Count

public virtual Count( oSize)

Retrieves the number of mono-instantiable Functional Representation References aggregated by this Functional Reference.

Parameters:

oSize: The number of Functional Representation References.

Returns:

S_OK The method succeeds and the number of Functional Representation References is retrieved.
E_FAIL otherwise.

o List

public virtual List( oLFctRepReferences)

Lists the collection of mono-instantiable Functional Representation References aggregated by this Functional Reference.

Parameters:

oLFctRepReferences: A list of Functional Representation References.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds and the aggregated mono-instantiable Functional Representation References (if exist) are retrieved.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipFunctionalRepReferenceToRemove)

Removes the given Functional Representation Reference that is aggregated by this Functional Reference.
Role: This method removes the given representation reference aggregated by the Functional Reference.
The given representation reference must be mono-instantiable and aggregated by this Functional Reference.

Parameters:

ipFunctionalRepReferenceToRemove: The Functional Representation Reference to remove.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds and the Functional Representation Reference has been successfully removed.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

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