All Frameworks Class Hierarchy This Framework Indexes Previous Next

ProductStructureUseItf Interface CATIPrdAggregatedRepresentations

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

interface CATIPrdAggregatedRepresentations

Interface to manage collection of mono-instantiable PLM Product Representation Reference.

Role: This interface enables to create, remove, browse or seek mono-instanciated Product Representation References under the given Product Reference.

Note: A mono-instantiated Representation Reference cannot be re-instantiated under another Product.
Created mono-instantiable Representation Reference and its Representation Instance are always removed at the same time.
This interface is implemented on Product References. All methods must be called on a PLM Product Reference.

Method Index

o Add3DShape(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIPsiRepresentationReference*&)
o Add3DShape(CATIType_var&,CATListValCATICkeParm_var&,CATIPsiRepresentationReference*&,CATIAdpEnvironment*): Creates a new 3DShape.
o AddNonCATIA(CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATUnicodeString&,CATUnicodeString&,CATIPsiRepresentationReference*&): Creates a new Product Representation Reference with a non CATIA V5 file.
o Count(int&): Retrieves number of mono-instantiable Product Representation References.
o Iterator(CATIPrdIterator_var&): Retrieves an iterator on all mono-instantiable Product Representation References.
o RemoveRepresentation(CATIPsiRepresentationReference_var&): Removes a mono-instantiable Product Representation Reference.

Methods

o Add3DShape

public virtual Add3DShape(		`ipEnv`,
		`iPrdRepAttributesValues`,
		`opRepReference`)

Deprecated:

R215 Creates a new 3DShape. Please use Add3DShape method with CATIType argument *****
Role: This method creates a mono instantiable 3DShape Product Representation Reference and instantiates it under this Product Reference(this).

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.
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 and instantiated.
E_FAIL if internal error occurred, the PLM object is not created.
INVALIDARG at least one argument is either missing or invalid.

o Add3DShape

public virtual Add3DShape(	`iType`,
	`iPrdRepAttributesValues`,
	`opRepReference`,
	`ipEnv`	`=NULL` )

Creates a new 3DShape.
Role: This method creates a mono instantiable 3DShape Product Representation Reference and instantiates it under this Product Reference(this).

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.
opRepReference: [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 and instantiated.
E_FAIL if internal error occurred, the PLM object is not created.
INVALIDARG at least one argument is either missing or invalid.

o AddNonCATIA

public virtual AddNonCATIA(		`ipEnv`,
		`iPrdRepAttributesValues`,
	const	`iLateType`,
	const	`iDocumentPath`,
		`opRepReference`)

Creates a new Product Representation Reference with a non CATIA V5 file.
Role: This method creates a mono instantiable Product Representation Reference and instantiates it under this Product Reference(this).

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 document 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 document (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 and instantiated.
E_FAIL if internal error occurred, the Product Representation Reference object is not created.
INVALIDARG at least one argument is either missing or invalid.

o Count

public virtual Count( oCount)

Retrieves number of mono-instantiable Product Representation References.

Parameters:

oCount: The number of mono-instantiable Product Representation References under this Product Reference.

Returns:

S_OK if this Product has at least one Representation Reference.
E_FAIL otherwise.

o Iterator

public virtual Iterator( ohIterator)

Retrieves an iterator on all mono-instantiable Product Representation References.

Parameters:

ohIterator: The iterator on all mono-instantiable Product Representation References under this Product.

Returns:

S_OK if the iterator was successfully created.
E_FAIL otherwise.

o RemoveRepresentation

public virtual RemoveRepresentation( const iRepReference)

Removes a mono-instantiable Product Representation Reference.

Parameters:

iRepReference: The mono-instantiable Product Representation Reference to be removed.

Returns:

S_OK if the Representation Reference has been successfully removed.
E_FAIL otherwise.

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