ProductStructureInterfaces Interface CATIPLMRepresentations

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

interface CATIPLMRepresentations

Deprecated:: R211 Use or
Interface to manage collection of mono-instantiable Product Representation References.
Role: This interface enables to create, remove, browse or seek mono-instanciated Representation References under the given Product.
A mono-instantiated Representation Reference cannot be re-instantiated under any Product.
This interface is implemented on Product References. All methods must be called on a PLM Product Reference.

Method Index

o AddRepresentation(CATListValCATICkeParm_var&,CATListValCATICkeParm_var&,CATIAdpEnvironment*,CATUnicodeString&,CATIPsiRepresentationReference*&)
o AddRepresentationInitializedWithContentOf(CATListValCATICkeParm_var&,CATListValCATICkeParm_var&,CATIAdpEnvironment*,CATUnicodeString&,CATUnicodeString&,CATIPsiRepresentationReference*&)
o Count(int&)
o Iterator(CATIPrdIterator_var&)
o RemoveRepresentation(CATIPsiRepresentationReference_var&)

Methods

o AddRepresentation

public virtual AddRepresentation(		`iPublicListValues`,
		`iControlledListValues`,
		`ipEnv`,
	const	`iAuthoringType`,
		`oRepRef`)

Deprecated:

R211 Use or
Creates a new Representation Reference (with an Authoring Stream Descriptor) and instantiated it under this Product.
Role: This method creates a mono instantiable Representation Reference and instantiates it under this Product Reference(this).
Note: Created mono-instantiable Representation Reference and its Representation Instance are always removed at the same time.

Parameters:

iPublicListValues: All Public writable attributes. This list must contain at least all mandatory attributes and one of IdentifierSet.
iControlledListValues: Useless.
ipEnv: The input PLM environment. This environment defines the Representation Reference customization type.
iAuthoringType: Main Stream Descriptor type associated to the created Representation Reference. Refer to
oRepRef: [out, CATBaseUnknown#Release] The created Representation Reference.
Note: the pointer should be RELEASED.

Returns:

S_OK if the Representation Reference has been successfully created and instantiated.
E_FAIL if an unexpected error occured.

o AddRepresentationInitializedWithContentOf

public virtual AddRepresentationInitializedWithContentOf(		`iPublicListValues`,
		`iControlledListValues`,
		`ipEnv`,
	const	`iLateType`,
	const	`iSDPath`,
		`oRepRef`)

Deprecated:

R211 Use
Creates a new Representation Reference (with an existing non CATIA V5 file document attached as Authoring Stream Descriptor) and instantiated it under this Product.
Role: This method creates a mono instantiable Representation Reference and instantiates it under this Product Reference(this).
Note: Created mono-instantiable Representation Reference and its Representation Instance are always removed at the same time.

Parameters:

iPublicListValues: All Public writable attributes. This list must contain at least all mandatory attributes and one of IdentifierSet.
iControlledListValues: Useless.
ipEnv: The input PLM environment. This environment defines the Representation Reference customization type.
iLateType: The type of the existing non CATIA V5 document to add as Authoring Stream Descriptor.
For instance: txt, cgr, model, etc. Refer to
iSDPath: The file path of the existing non CATIA V5 document.
oRepRef: [out, CATBaseUnknown#Release] The created Representation Reference.
Note: the pointer should be RELEASED.

Returns:

S_OK if the Representation Reference has been successfully created and instantiated.
E_FAIL if an unexpected error occured.

o Count

public virtual Count( oCount)

Deprecated:

R211 Use
Retrieves number of mono-instantiable Representation References.

Parameters:

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

Returns:

S_OK if this Product has at least one Representation Reference.
E_FAIL if this Product is not a Product Reference or has no Representation Reference.

o Iterator

public virtual Iterator( ohIterator)

Deprecated:

R211 Use
Retrieves an iterator on all mono-instantiable Representation References under this Product Reference.

Parameters:

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

Returns:

S_OK if the iterator was successfully created.
E_FAIL if this Product is not a Product Reference or if the iterator creation failed.

o RemoveRepresentation

public virtual RemoveRepresentation( const iRepRef)

Deprecated:

R211 Use
Removes a mono-instantiable Representation Reference under this Product Reference.

Parameters:

iRepRef: The mono-instantiable 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: CATIPLMRepresentations.h
If needed, your Imakefile.mk should include the module: CATProductStructureInterfaces