All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogConnection

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

interface CATILogConnection

Interface designating a Logical Connection.

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

Method Index

o GetConnectedElements(CATILogInstance*&,CATILogPort*&,CATILogInstance*&,CATILogPort*&): Retrieves the Logical Elements pointed by this Logical Connection.
o GetConnectedElements(CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&,CATBaseUnknown_var&): Retrieves the Logical Elements pointed by this Logical Connection.
o GetParent(void**,IID&): Retrieves the Logical Reference aggregating this Logical Connection.

Methods

o GetConnectedElements

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

Retrieves the Logical Elements pointed by this Logical Connection.
Role: This methods retrieves the logical elements pointed by this Logical 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 logical system.
- opFirstInstance will be not valuated.
- The two other arguments will correspond to the child logical system.

In some case (deleted elements or partial loading), some elements pointed by the logical 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 input parameters are unexpected.
E_FAIL otherwise.

o GetConnectedElements

public virtual GetConnectedElements(		`ospFromLogicalConnectable`,
		`ospFromLogicalConnectionPoint`,
		`ospToLogicalConnectable`,
		`ospToLogicalConnectionPoint`)

Retrieves the Logical Elements pointed by this Logical Connection.
Role: This method retrieves the logical elements pointed by this Logical Connection.

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

Parameters:

ospFromLogicalConnectable: The first pointed Connectable.
Output parameter.
This parameter is a Logical Instance or a Logical Reference. It adheres to CATILogConnectable.
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.
ospFromLogicalConnectionPoint: The Connection Point related to ospFromLogicalConnectable.
Output parameter.
This parameter is a Logical Connection Point: CATLogConnectionPoint.
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.
ospToLogicalConnectable: The second pointed Connectable.
Output parameter.
This parameter is a Logical Instance or a Logical Reference. It adheres to CATILogConnectable.
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.
ospToLogicalConnectionPoint: The Connection Point related to ospToLogicalConnectable.
Output parameter.
This parameter is a Logical Connection Point: CATLogConnectionPoint.
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 input parameters are unexpected.
E_FAIL otherwise.

o GetParent

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

Retrieves the Logical Reference aggregating this Logical Connection.

Parameters:

oppParent: A Logical Reference.
Output parameter.
iIID: The desired interface. CATILogReference by default.

Returns:

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

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