All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogInstances

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

interface CATILogInstances

Interface dedicated to Logical Instances management.

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

Method Index

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

Methods

o Add

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

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

Parameters:

oSize: The number of Logical Instances.

Returns:

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

o List

public virtual List( oLInstances)

Retrieves the collection of instances aggregated by this Logical Reference.

Parameters:

oLInstances: A list of logical 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 Logical Reference.
Role: This method removes and deletes the given instance from the instances aggregated by the Logical Reference.
The given instance must be aggregated by this Logical Reference.

Parameters:

ipInstanceToRemove: The logical 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: CATILogInstances.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerUseItf