CATFunctionalModelerUseItf Interface CATIFctInstance

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

interface CATIFctInstance

Interface designating a Functional Instance.

Role: This interface is implemented on Functional instances.

Method Index

o Connect(CATIFctPort*,CATIFctInstance*,CATIFctPort*,CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctConnection*&): Connects two instances of Functional systems together.
o GetConnectedParentPorts(CATIFctPort*,CATListValCATIFctPort_var&,CATListValCATIFctConnection_var&): Retrieves the Functional Ports exposing at the upper level a specific port of this instance of Functional system.
o GetConnectedSiblingSystems(CATIFctPort*,CATListValCATIFctInstance_var&,CATListValCATIFctPort_var&,CATListValCATIFctConnection_var&): Retrieves the instances of sibling Functional systems connected to this instance of Functional system.
o GetFather(CATIFctReference*&): Retrieves the Functional Reference which aggregates this Functional Instance.
o GetReferenceInstanceOf(CATIFctReference*&): Retrieves the instanciated Functional Reference.

Methods

o Connect

public virtual Connect(		`ipFromFunctionalPort`,
		`ipToFunctionalInstance`,
		`ipToFunctionalPort`,
	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`opFunctionalConnection`)

Connects two instances of Functional systems together.
Role: This method connects this Functional Instance (through a specific Functional Port) to a Functional Instance (through an other specific Functional Port) by creating a Functional Connection.
These two Functional Instances must be aggregated by the same Functional Reference.
It corresponds to the Sibling 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:

ipFromFunctionalPort: A Functional Port of the Functional Reference this instance comes from.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
ipToFunctionalInstance: The instance of Functional system to be connected with.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
ipToFunctionalPort: The specific Functional Port (of the 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 that connects the two instances of Functional systems.
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 GetConnectedParentPorts

public virtual GetConnectedParentPorts(		`ipFunctionalPort`,
		`oLConnectedFunctionalPorts`,
		`oLFunctionalConnections`)

Retrieves the Functional Ports exposing at the upper level a specific port of this instance of Functional system.
Role: This method retrieves the Functional Ports exposing a specified Functional Port of this Functional Instance.
The specified Functional Port must belong to the Functional Reference this Functional Instance comes from.
It corresponds to the Parent-Child connectivity pattern.

Parameters:

ipFunctionalPort: A Functional Port of the Functional Reference this instance comes from.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
oLConnectedFunctionalPorts: A list of Functional Ports exposing the specified Functional Port of this Functional Instance.
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 Ports) materializing the link between the specified port of this instance and the Functional Ports of the upper Functional system.
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 exposing port(s) (if exist(s)) is(are) retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetConnectedSiblingSystems

public virtual GetConnectedSiblingSystems(		`ipFunctionalPort`,
		`oLConnectedFunctionalInstances`,
		`oLConnectedFunctionalPorts`,
		`oLFunctionalConnections`)

Retrieves the instances of sibling Functional systems connected to this instance of Functional system.
Role: This method, given this Functional Instance and a Functional Port retrieves the instances of Functional systems (corresponding Functional Instances and Functional Ports) connected through Functional Connections.
The specified Functional Port must belong to the Functional Reference this Functional Instance comes from.
It corresponds to the Sibling connectivity pattern.

Parameters:

ipFunctionalPort: A Functional Port of the Functional Reference this instance comes from.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
oLConnectedFunctionalInstances: A list of Functional Instances corresponding to the systems connected to this instance of Functional system given the specified 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) designating on which port is connnected this instance of Functional system.
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) materializing the link between this instance of Functional system and the other connected instances of Functional system.
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 connected Functional systems (if exist) are retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetFather

public virtual GetFather( opFunctionalReference)

Retrieves the Functional Reference which aggregates this Functional Instance.

Parameters:

opFunctionalReference: [out, CATBaseUnknown#Release]
The Functional Reference aggregating this Functional 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 incorrect.
E_FAIL otherwise.

o GetReferenceInstanceOf

public virtual GetReferenceInstanceOf( opFunctionalReference)

Retrieves the instanciated Functional Reference.

Parameters:

opFunctionalReference: [out, CATBaseUnknown#Release]
The instantiated Functional 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.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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