All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalImplementLinkUseItf Interface CATILogicalImplementLinkManager

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

interface CATILogicalImplementLinkManager

Interface representing the Logical to Functional Implement Link Manager.

Role: The Logical to Functional Implement Link Manager is dedicated to the manipulation of Implement Links.

It is a component instanciated thanks to the .
Code sample:

   ...
   CATILogicalImplementLinkManager* pImplementLinkManager = NULL;
   rc = CATLogicalImplementLinkManagerProvider::GetImplementLinkManager(pImplementLinkManager);
   if (SUCCEEDED(rc) && NULL != pImplementLinkManager)
   {
     ...
     pImplementLinkManager->Release();
     pImplementLinkManager = NULL;
   }
   ...

Notes:

An Implement Link is a PLMConnection that links a Logical entity and a Functional entity.
All the methods of this interface are working on the session which content, in term of loaded entities, is tuned by an option at Open. Refer to .

Method Index

o CreateImplementRelation(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATOmbObjectInContext*,CATOmbObjectInContext*,CATILogicalImplementLink*&): Creates an Implement Link Relation between a Logical entity (Mux/Demux excluded) and a Functional Entity (Mux/Demux excluded).
o DeleteImplementRelation(CATOmbObjectInContext*,CATOmbObjectInContext*): Deletes an Implement Link Relation between a Logical entity and a Functional Entity.
o GetImplementRelationSources(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&,CATLISTP(CATILogicalImplementLink)&): Get the Logical entities (Sources) from a Functional entity.
o GetImplementRelationTargets(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&,CATLISTP(CATILogicalImplementLink)&): Get the Functional entities (Targets) from a Logical entity.

Methods

o CreateImplementRelation

public virtual CreateImplementRelation(	const	`ispType`,
	const	`ipEnvironment`,
		`iLAttributesValues`,
		`ipLogicalSource`,
		`ipFunctionalTarget`,
		`opImplementLinkConnection`)

Creates an Implement Link Relation between a Logical entity (Mux/Demux excluded) and a Functional Entity (Mux/Demux excluded).
Authorized combinations:
- ipLogicalSource is a Logical Reference and ipFunctionalTarget is a Functional Reference
- ipLogicalSource is a Logical Type Reference and ipFunctionalTarget is a Functional Flow Reference
- ipLogicalSource is a Path of Logical Instances and ipFunctionalTarget is a Path of Functional Instances.
- ipLogicalSource is Logical port with its context (path of Logical instances) and ipFunctionalTarget is Functional port with its context (path of Functional instances).
- ipLogicalSource is path of Logical instances and ipFunctionalTarget is Functional connection with its context (path of Functional instances).
Role: This method creates an Implement Link Relation between a Logical entity and a Functional Entity.

Parameters:

ispType: The type of the Implement Link to create (optional).
It must be a subtype of the Implement Link type (RFLPLMImplementConnection).
If NULL, a standard Logical Implement Link will be created.
ipEnvironment: The PLM environment in which must be created the Logical Port.
If NULL, the current PLM environment will be used.
iLAttributesValues: A list of functional attributes values (of the implement link to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
This list must be empty.
ipLogicalSource: Represents the Source entity.
Source entity can be :
- a Logical Reference
- or a Logical Type Reference
- or a path of Logical Instances
- or a Logical port with or without its context (path of Logical Instances).
When ipLogicalSource is a Logical Reference , ipFunctionalTarget must be a Functional Reference.
When ipLogicalSource is a Logical Type Reference , ipFunctionalTarget must be a Functional Flow Reference.
When ipLogicalSource is a Path of Logical Instances, ipFunctionalTarget must be a Path of Functional Instances
or a Functional connection with or without its context (path of Functional instances ).
When ipLogicalSource is a Logical port with or without its context (path of Logical Instances), ipFunctionalTarget must be a a Functional port with or without its context (path of Functional Instances).
ipFunctionalTarget: Represents the Target entity.
Target entity can be :
- either a Functional Reference
- or a Functional Flow Reference
- or a path of Functional Instances
- or a Functional port with or without its context (path of Functional instances)
- or a Functional connection with or without its context (path of Functional instances).
opImplementLinkConnection: Represents the created Implement Link connection.

Returns:

S_OK if the Implement Link Relation has been created.
E_INVALIDARG if the input arguments are not valid.

ipLogicalSource is NULL
ipFunctionalTarget is NULL
Target in context of the Source is not valid
The given Implement Link connection pointer is not NULL

E_FAIL if an error occured. The possible returned errors (listed by their identifier) are:

ImplementLinkERR_01:
ImplementLinkERR_02:
ImplementLinkERR_03:
Otherwise : Internal error.

o DeleteImplementRelation

public virtual DeleteImplementRelation(		`ipLogicalSource`,
		`ipFunctionalTarget`)

Deletes an Implement Link Relation between a Logical entity and a Functional Entity. Authorized combinations:
- ipLogicalSource is a Logical Reference and ipFunctionalTarget is a Functional Reference
- ipLogicalSource is a Logical Type Reference and ipFunctionalTarget is a Functional Flow Reference
- ipLogicalSource is a Path of Logical Instances and ipFunctionalTarget is a Path of Functional Instances.
- ipLogicalSource is Logical port with its context (path of Logical instances) and ipFunctionalTarget is Functional port with its context (path of Functional instances).
- ipLogicalSource is Logical path of instances and ipFunctionalTarget is Functional connection with its context (path of Functional instances).
Role: This method deletes an Implement Link Relation between a Logical entity and a Functional Entity.

Parameters:

ipLogicalSource: Represents the Source entity.
Source entity can be :
- a Logical Reference
- or a Logical Type Reference
- or a path of Logical Instances
- or a Logical port with its context (path of Logical Instances).
When ipLogicalSource is a Logical Reference, ipFunctionalTarget must be a Functional Reference.
When ipLogicalSource is a Logical Type Reference, ipFunctionalTarget must be a Functional Flow Reference.
When ipLogicalSource is a Path of Logical Instances, ipFunctionalTarget must be a Path of Functional Instances
or a Functional connection with its context (path of Functional instances).
When ipLogicalSource is a Logical port with its context (path of Logical Instances), ipFunctionalTarget must be a a Functional port with its context (path of Functional Instances).
ipFunctionalTarget: Represents the Target entity.
Target entity can be :
- either a Functional Reference
- or a Functional Flow Reference
- or a path of Functional Instances
- or a Functional port with its context (path of Functional instances)
- or a Functional connection with its context (path of Functional instances).

Returns:

S_OK if the Implement Link Relation has been deleted.
E_INVALIDARG if the input arguments are not valid.

ipLogicalSource is NULL
ipFunctionalTarget is NULL
Target in context of the Source is not valid

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationSources

public virtual GetImplementRelationSources(		`ipFunctionalTarget`,
		`oListOfLogicalSources`,
		`oListOfImplementLinks`)

Get the Logical entities (Sources) from a Functional entity.
Role: This method gets, from the current session, the Logical entities (Sources) from a Functional entity.
The session content depends on the option used during the open. Refer to the ExpandMode argument described in .

Parameters:

ipFunctionalTarget: Represents the Functional Target entity.
oListOfLogicalSources: Represents the list of Logical Source entities implementing the Functional Target entity.
oListOfImplementLinks: Represents the list of the implement links

Returns:

S_OK if the Source entities have been found
E_INVALIDARG if the input arguments are not valid.

ipFunctionalTarget is NULL.
oListOfLogicalSources is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationTargets

public virtual GetImplementRelationTargets(		`ipLogicalSource`,
		`oListOfFunctionalTargets`,
		`oListOfImplementLinks`)

Get the Functional entities (Targets) from a Logical entity.
Role: This method gets, from the current session, the Functional entities (Sources) from a Logical entity.
The session content depends on the option used during the open. Refer to the ExpandMode argument described in .

Parameters:

ipLogicalSource: Represents the Logical Source entity.
oListOfFunctionalTargets: Represents the list of Functional Target entities implemented by the Logical Source entity.
oListOfImplementLinks: Represents the list of the implement links

Returns:

S_OK if the Source entities have been found
E_INVALIDARG if the input arguments are not valid.

ipLogicalSource is NULL.
oListOfFunctionalTargets is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

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