All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctFlowReference

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

interface CATIFctFlowReference

Interface dedicated to Functional Flow Reference.

Role: This interface designates a Functional Flow Reference and provides means to manage its subflows (Functional Flow Instances collection aggregated by this Functional Flow Reference).

Method Index

o AddSubFlow(CATIFctFlowReference*,CATListValCATICkeParm_var&,CATIFctFlowInstance*&): Adds a (Functional) Subflow to this Functional Flow.
o CountSubFlows(int&): Retrieves the number of subflows.
o ListSubFlows(CATListValCATIFctFlowInstance_var&): Lists the subflows of this Functional Flow.
o RemoveSubFlow(CATIFctFlowInstance*): Removes a subflow from this Functional Flow.

Methods

o AddSubFlow

public virtual AddSubFlow(		`ipFunctionalFlowReference`,
		`iLFctAttributesValues`,
		`opFunctionalFlowInstance`)

Adds a (Functional) Subflow to this Functional Flow.
Role: This method adds a subflow to this flow by instantiating a given Functional Flow Reference under this Functional Flow Reference.

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:

ipFunctionalFlowReference: A Functional Flow Reference.
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 flow 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 contain V_Identifier attribute.
opFunctionalFlowInstance: [out, CATBaseUnknown#Release]
The created Functional Flow 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 CountSubFlows

public virtual CountSubFlows( oSize)

Retrieves the number of subflows.

Parameters:

oSize: The number of subflows.

Returns:

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

o ListSubFlows

public virtual ListSubFlows( oLSubFlows)

Lists the subflows of this Functional Flow.

Parameters:

oLSubFlows: A list of Functional Flow 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 subflows of this Functional Flow (if exist) are retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o RemoveSubFlow

public virtual RemoveSubFlow( ipFunctionalFlowInstanceToRemove)

Removes a subflow from this Functional Flow.
Role: This method removes and deletes the given flow instance from the flow instances aggregated by this Functional Flow Reference.
The given flow instance must be aggregated by this Functional Flow Reference.

Parameters:

ipFunctionalFlowInstanceToRemove: The subflow to remove (identified by its Functional Flow Instance).
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 subflow has been removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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