CATFunctionalModelerUseItf Interface CATIFctPort

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

interface CATIFctPort

Interface designating a Functional Port and providing means to manage the Functional Port properties.

Method Index

o Connect(CATIFctInstance*,CATIFctPort*,CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctConnection*&)

Connects this Functional Port (of a Functional system) to an instance of Functional subsystem through a specific port.

o GetConnectedSubSystems(CATListValCATIFctInstance_var&,CATListValCATIFctPort_var&,CATListValCATIFctConnection_var&)

Retrieves the instances of Functional subsystems connected to this Functional Port.

o GetDirection(PortDirection&)

Retrieves the direction of this Functional Port.

o GetFlow(CATIFctFlowReference*&)

Retrieves the Functional Flow Reference associated to this Functional Port.

o GetFlowInstance(CATIFctFlowInstance*&)

Retrieves the Functional Flow Instance associated to this Functional Port.

o GetParent(void**,IID&)

Retrieves the Functional Reference aggregating this Functional Port.

o RemoveFlow()

Removes the Functional Flow associated to this Functional Port.

o SetDirection(PortDirection)

Sets the direction of this Functional Port.

o SetFlow(CATIFctFlowReference*)

Sets the Functional Flow associated to this Functional Port.

Enumerated Type Index

o PortDirection

Defines the direction of a Functional Port.

Methods

Connects this Functional Port (of a Functional system) to an instance of Functional subsystem through a specific port.
Role: This method connects this Functional Port to a Functional Instance through a specific Functional Port (of a Functional Reference the instance comes from) by creating a Functional Connection. The Functional Instance must be aggregated by the Functional Reference this Functional Port belongs.
It corresponds to the Parent-Child connectivity pattern.

This API invokes the following Business Logic Openness:

• FLConnectionCreationCheck
• PLMIdentificationInitialization

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

Parameters:

ipFunctionalInstance

The instance of Functional subsystem to be connected with.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

ipFunctionalPort

The specific Functional Port of Functional Reference (the previous provided instance comes from) to be connected with.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

ispType

The type of the Functional Connection to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalConnection 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 connection 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.

opFunctionalConnection

[out, CATBaseUnknown#Release]
The created Functional Connection.
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:

Retrieves the instances of Functional subsystems connected to this Functional Port.
Role: This method retrieves the Functional Instances (and the specific Functional Ports) connected to this Functional Port through Functional Connections.
It corresponds to the Parent-Child connectivity pattern.

Parameters:

oLConnectedFunctionalInstances

A list of Functional Instances of systems connected to this Functional Port.
Output parameter.
This parameter MUST be provided by caller as empty. This method returns an error otherwise.
This parameter is valuated if method succeeds.

oLConnectedFunctionalPorts

A list of Functional Ports (related to the previous 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.

oLFunctionalConnections

A list of Functional Connections (related to the previous list of Functional Instances) metarializing the link between this Functional Port and the connected instances of Functional systems.
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 exposed Functional systems (if exist) are retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

Retrieves the direction of this Functional Port.

Parameters:

oDirection

The Functional Port direction.
Output parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

Retrieves the Functional Flow Reference associated to this Functional Port.

Parameters:

opFunctionalFlowReference

[out, CATBaseUnknown#Release]
A Functional Flow Reference.
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. opFunctionalFlowReference may be NULL if there is no associated flow.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

Retrieves the Functional Flow Instance associated to this Functional Port.

Parameters:

opFunctionalFlowInstance

[out, CATBaseUnknown#Release]
A 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. opFunctionalFlowInstance may be NULL if there is no associated flow.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

Retrieves the Functional Reference aggregating this Functional Port.

Parameters:

oppParent

A Functional Reference or a Functional Mux/Demux Reference.
Output parameter.

iIID

The desired interface. CATIFctReference by default.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

Removes the Functional Flow associated to this Functional Port.

Returns:

S_OK if the method succeeds and the associated Functional Flow if exists has been removed.
E_FAIL otherwise.

Sets the direction of this Functional Port.

Parameters:

iDirection

The new Functional Port direction.
Input parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

Sets the Functional Flow associated to this Functional Port.
Role: This method associates the given Functional Flow Reference by instantiating it and associating it to the Functional Port.

This API invokes the following Business Logic Openness:

• FLTypeAssociationCheck
• 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.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

Enumerated Types