All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctPorts

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

interface CATIFctPorts

Interface dedicated to Functional Ports management.

Role: This interface manages the collection of Functional Ports aggregated by a Functional Reference.
This collection actually defines the functional interface of the Functional Reference as a component.

Method Index

o Add(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctFlowReference*,CATIFctPort*&): Creates a Functional Port.
o Count(int&): Retrieves the number of Functional Ports aggregated by this Functional Reference.
o List(CATListValCATIFctPort_var&): Retrieves the collection of Functional Ports aggregated by this Functional Reference.
o Remove(CATIFctPort*): Removes the given Functional Port.

Methods

o Add

public virtual Add(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`ipFunctionalFlowReference`,
		`opFunctionalPort`)

Creates a Functional Port.
Role: This method creates a Functional Port that will be aggregated by this Functional Reference.

This API invokes the following Business Logic Openness:

PLMPortAggregationCheck
FLTypeAssociationCheck
PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

ispType: The type of the Functional Port to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalConnector will be used by default for creation.
Input Parameter.
ipEnvtForProject: The environment defining the project. The project determines the deployment type to associate (or not) with the new PLM Object.
If the argument is NULL, the current environment is used.
Input Parameter.
iLFctAttributesValues: A list of Functional attributes values (of the Functional port to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
The direction of the Functional Port must be valuated (V_Direction attribute).
Input Parameter.
ipFunctionalFlowReference: The Functional Flow that must be associated to this Functional Port (Optional).
This parameter can be provided by caller as NULL.
Input Parameter.
opFunctionalPort: [out, CATBaseUnknown#Release]
The created Functional Port.
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 Ports aggregated by this Functional Reference.

Parameters:

oSize: The number of Functional Ports.

Returns:

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

o List

public virtual List( oLFunctionalPorts)

Retrieves the collection of Functional Ports aggregated by this Functional Reference.

Parameters:

oLFunctionalPorts: A list of Functional ports.
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 Functional Ports (if exist) aggregated by this Functional Reference are retrieved.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipFunctionalPortToRemove)

Removes the given Functional Port.
Role: This method removes and deletes the given Functional Port from the Functional ports aggregated by the Functional Reference.
The given Functional port must be aggregated by this Functional Reference.

Parameters:

ipFunctionalPortToRemove: The Functional port 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 Port has been successfully removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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