All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctInstances

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

interface CATIFctInstances

Interface dedicated to Functional Instances management.

Role: This interface provides means to manage the collection of Functional Instances aggregated by this Functional Reference.

Method Index

o Add(CATIFctReference*,CATListValCATICkeParm_var&,CATIFctInstance*&): Instantiates a Functional Reference under this Functional Reference.
o Count(int&): Retrieves the number of Functional Instances aggregated by this Functional Reference.
o List(CATListValCATIFctInstance_var&): Retrieves the collection of instances aggregated by this Functional Reference.
o Remove(CATIFctInstance*): Removes the given instance that is aggregated by this Functional Reference.

Methods

o Add

public virtual Add(		`ipReferenceToInstantiate`,
		`iLFctAttributesValues`,
		`opFunctionalInstance`)

Instantiates a Functional Reference under this Functional Reference.
Role: This method creates a Functional Instance from the given Functional Reference and aggregates it under this Functional Reference.
The deployment type used to create the Functional Instance corresponds to the same than the Functional 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:

ipReferenceToInstantiate: The reference to instantiate. 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 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.
opFunctionalInstance: [out, CATBaseUnknown#Release]
The created 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 Instances aggregated by this Functional Reference.

Parameters:

oSize: The number of Functional Instances.

Returns:

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

o List

public virtual List( oLInstances)

Retrieves the collection of instances aggregated by this Functional Reference.

Parameters:

oLInstances: A list of Functional 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.
S_FALSE if the method succeeds but there is no aggregated instance.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipInstanceToRemove)

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

Parameters:

ipInstanceToRemove: The Functional 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.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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