All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATFunctionalModelerUseItf Interface CATIFctConnection

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

interface CATIFctConnection

Interface designating a Functional Connection.

Role: This interface designates a Functional Connection who is the element used to establish relations bewteen Functional systems (matching sibling or parent-child patterns).

Method Index

o GetConnectedElements(CATIFctInstance*&,CATIFctPort*&,CATIFctInstance*&,CATIFctPort*&): Retrieves the Functional Elements pointed by this Functional Connection.
o GetConnectedElements(CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&): Retrieves the Functional Elements pointed by this Functional Connection.
o GetParent(void**,IID&): Retrieves the Functional Reference aggregating this Functional Connection.

Methods

o GetConnectedElements

public virtual GetConnectedElements(		`opFirstInstance`,
		`opFirstPort`,
		`opSecondInstance`,
		`opSecondPort`)

Retrieves the Functional Elements pointed by this Functional Connection.
Role: This methods retrieves the Functional elements pointed by this Functional Connections.

Related to the two handled patterns:

Sibling: Every output arguments will be valuated.
Parent-Child:
- opFirstPort will correspond to the Port related to the parent Functional system.
- opFirstInstance will be not valuated.
- The two other arguments will correspond to the child Functional system.

In some case (deleted elements or partial loading), some elements pointed by the Functional connection will not be retrieved.

Parameters:

opFirstInstance: [out, CATBaseUnknown#Release]
The first pointed 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.
opFirstPort: [out, CATBaseUnknown#Release]
A port related to opFirstInstance.
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.
opSecondInstance: [out, CATBaseUnknown#Release]
The second pointed 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.
opSecondPort: [out, CATBaseUnknown#Release]
A port related to opSecondInstance.
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.
S_FALSE if the method succeeds but all the connected elements could not be retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetConnectedElements

public virtual GetConnectedElements(		`ospFromFunctionalConnectable`,
		`ospFromFunctionalConnectionPoint`,
		`ospToFunctionalConnectable`,
		`ospToFunctionalConnectionPoint`)

Retrieves the Functional Elements pointed by this Functional Connection.
Role: This method retrieves the functional elements pointed by this Functional Connection.

In some case (deleted elements or partial loading), some elements pointed by the functional connection will not be retrieved.

Parameters:

ospFromFunctionalConnectable: The first pointed Connectable.
Output parameter.
This parameter is a Functional Instance or a Functional Reference. It adheres to CATIFctConnectable.
This parameter MUST be provided by caller as NULL_var. This method returns an error otherwise.
This parameter is returned to caller as NULL_var if method fails.
This parameter is valuated if method succeeds.
ospFromFunctionalConnectionPoint: The Connection Point related to ospFromFunctionalConnectable.
Output parameter.
This parameter is a Functional Connection Point: CATFctConnectionPoint.
This parameter MUST be provided by caller as NULL_var. This method returns an error otherwise.
This parameter is returned to caller as NULL_var if method fails.
This parameter is valuated if method succeeds.
ospToFunctionalConnectable: The second pointed Connectable.
Output parameter.
This parameter is a Functional Instance or a Functional Reference. It adheres to CATIFctConnectable.
This parameter MUST be provided by caller as NULL_var. This method returns an error otherwise.
This parameter is returned to caller as NULL_var if method fails.
This parameter is valuated if method succeeds.
ospToFunctionalConnectionPoint: The Connection Point related to ospToFunctionalConnectable.
Output parameter.
This parameter is a Functional Connection Point: CATFctConnectionPoint.
This parameter MUST be provided by caller as NULL_var. This method returns an error otherwise.
This parameter is returned to caller as NULL_var if method fails.
This parameter is valuated if method succeeds.

Returns:

S_OK if the method succeeds.
S_FALSE if the method succeeds but all the connected elements could not be retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetParent

public virtual GetParent(		`oppParent`,
	const	`iIID`	`= IID_CATIFctReference`)

Retrieves the Functional Reference aggregating this Functional Connection.

Parameters:

oppParent: A Functional 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.

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