All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctRepresentationInstances

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

interface CATIFctRepresentationInstances

Interface dedicated to manage the collections of Functional Representation Instances aggregated by a Functional Reference.

These Representation Instances can come from mono or multi-instantiable Representation References.

Method Index

o Add(CATIFctRepresentationReference*,CATListValCATICkeParm_var&,CATIFctRepresentationInstance*&): Instantiates a Functional Representation Reference under this Functional Reference.
o Count(int&): Retrieves the number of Functional Representation Instances aggregated by this Functional Reference.
o List(CATListValCATIFctRepresentationInstance_var&): Lists the collection of Functional Representation Instances aggregated by this Functional Reference.
o Remove(CATIFctRepresentationInstance*): Removes the given Functional Representation Instance that is aggregated by this Functional Reference.

Methods

o Add

public virtual Add(		`ipFunctionalRepReferenceToInstantiate`,
		`iLFctAttributesValues`,
		`opFunctionalRepInstance`)

Instantiates a Functional Representation Reference under this Functional Reference.
Role: This method creates a Functional Representation Instance from the given Functional Representation Reference and aggregates it under this Functional Reference.
The deployment type used to create the Functional Representation Instance corresponds to the same than the Functional Representation Reference to instantiate.

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:

ipFunctionalRepReferenceToInstantiate: The Functional Representation Reference to instantiate.
This Representation Reference must be multi-instantiable.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
iLFctAttributesValues: A list of Functional attributes values (of the Functional representation instance 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.
opFunctionalRepInstance: [out, CATBaseUnknown#Release]
The created Functional Representation Instance.
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 Functional Representation Instances aggregated by this Functional Reference.

Parameters:

oSize: The number of Functional Representation Instances.

Returns:

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

o List

public virtual List( oLFctRepInstances)

Lists the collection of Functional Representation Instances aggregated by this Functional Reference.

Parameters:

oLFctRepInstances: A list of Functional Representation Instances.
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 Functional Representation Instances (if exist) are retrieved.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipFunctionalRepInstanceToRemove)

Removes the given Functional Representation Instance that is aggregated by this Functional Reference.
Role: This method removes and deletes the given representation instance from the representation instances aggregated by the Functional Reference.
The given representation instance must be aggregated by this Functional Reference.

Parameters:

ipFunctionalRepInstanceToRemove: The Functional Representation Instance 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 Instance has been successfully removed.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

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