All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPhysicalImplementLinkUseItf Interface CATIPhysicalImplementLinkManager

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

interface CATIPhysicalImplementLinkManager

Interface representing the Physical to Logical Implement Link Manager.

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

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

...
   CATIPhysicalImplementLinkManager* piImplementLinkManager = NULL;
   rc = CATPhysicalImplementLinkProvider::GetImplementLinkManager(piImplementLinkManager);
   if(SUCCEEDED(rc) && NULL != piImplementLinkManager)
   {
     ...
     piImplementLinkManager->Release(); piImplementLinkManager = NULL;
   }
   ...

Notes:

An Implement Link is a PLMConnection that links a Physical entity and a Logical 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(CATOmbObjectInContext*,CATOmbObjectInContext*)
o CreateImplementRelation(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATOmbObjectInContext*,CATOmbObjectInContext*,CATIPhysicalImplementLink*&): Creates an Implement Link Relation between a Physical entity and a Logical Entity.
o DeleteImplementRelation(CATOmbObjectInContext*,CATOmbObjectInContext*): Deletes an Implement Link Relation between a Physical entity and a Logical Entity.
o GetImplementRelationSources(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&)
o GetImplementRelationSources(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&,CATLISTP(CATIPhysicalImplementLink)&): Get the Physical entities (Sources) from a Logical entity.
o GetImplementRelationTargets(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&)
o GetImplementRelationTargets(CATOmbObjectInContext*,CATLISTP(CATOmbObjectInContext)&,CATLISTP(CATIPhysicalImplementLink)&): Get the Logical entities (Targets) from a Physical entity.

Methods

o CreateImplementRelation

public virtual CreateImplementRelation(		`ipiSourcePhysical`,
		`ipiTargetLogical`)

Deprecated:

R211 Creates an Implement Link Relation between a Physical entity and a Logical Entity.
Role: This method creates an Implement Link Relation between a Physical entity and a Logical Entity. The current environment is used to create the Implement Link. Please refer to to set the environment.

Parameters:

ipiSourcePhysical: Represents the Source entity.
Source entity can be a Physical Reference or a path of Physical Instances.
When ipiSourcePhysical is a Physical Reference, ipiTargetLogical must be a Logical Reference.
When ipiSourcePhysical is a Path of Physical Instances, ipiTargetLogical must be a Path of Logical Instances.
ipiTargetLogical: Represents the Target entity.
Target entity can be a Logical Reference or a path of Logical Instances.

Returns:

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

ipiSourcePhysical is NULL
ipiTargetLogical is NULL
Source is a Reference and Target is a path of Instances.
Source is a path of Instances and Target is a Reference.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o CreateImplementRelation

public virtual CreateImplementRelation(	const	`ispType`,
	const	`ipEnvironment`,
		`iLAttributesValues`,
		`ipiSourcePhysical`,
		`ipiTargetLogical`,
		`opImplementLinkConnection`)

Creates an Implement Link Relation between a Physical entity and a Logical Entity.
Role: This method creates an Implement Link Relation between a Physical entity and a Logical 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 Implement Link.
If NULL, the current PLM environment will be used. Please refer to
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.
ipiSourcePhysical: Represents the Source entity.
Source entity can be a Physical Reference or a path of Physical Instances.
When ipiSourcePhysical is a Physical Reference, ipiTargetLogical must be a Logical Reference.
When ipiSourcePhysical is a Path of Physical Instances, ipiTargetLogical must be a Path of Logical Instances.
ipiTargetLogical: Represents the Target entity.
Target entity can be a Logical Reference or a path of Logical 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.

ipiSourcePhysical is NULL or isn't a Physical entity
ipiTargetLogical is NULLor isn't a Logical entity
Source is a Reference and Target is a path of Instances.
Source is a path of Instances and Target is a Reference.

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(		`ipiSourcePhysical`,
		`ipiTargetLogical`)

Deletes an Implement Link Relation between a Physical entity and a Logical Entity.
Role: This method deletes an Implement Link Relation between a Physical entity and a Logical Entity.

Parameters:

ipiSourcePhysical: Represents the Source entity.
Source entity can be a Physical Reference or a path of Physical Instances.
When ipiSourcePhysical is a Physical Reference, ipiTargetLogical must be a Logical Reference.
When ipiSourcePhysical is a Path of Physical Instances, ipiTargetLogical must be a Path of Logical Instances.
ipiTargetLogical: Represents the Target entity.
Target entity can be a Logical Reference or a path of Logical Instances.

Returns:

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

ipiSourcePhysical is NULL
ipiTargetLogical is NULL
Source is a Reference and Target is a path of Instances.
Source is a path of Instances and Target is a Reference.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationSources

public virtual GetImplementRelationSources(		`ipiTargetLogical`,
		`oListOfSourcesPhysical`)

Deprecated:

R211 Get the Physical entities (Sources) from a Logical entity.
Role: This method gets, from the current session, the Physical 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:

ipiTargetLogical: Represents the Target entity.
Target entity can be a Logical Reference or a path of Logical Instances.
oListOfSourcesPhysical: Represents the Source entities.
Source entities can be a Physical Reference or a path of Physical Instances.

Returns:

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

ipiTargetLogical is NULL.
oListOfSourcesPhysical is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationSources

public virtual GetImplementRelationSources(		`ipiTargetLogical`,
		`oListOfSourcesPhysical`,
		`oListOfImplementLinks`)

Get the Physical entities (Sources) from a Logical entity.
Role: This method gets, from the current session, the Physical 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:

ipiTargetLogical: Represents the Target entity.
Target entity can be a Logical Reference or a path of Logical Instances.
oListOfSourcesPhysical: Represents the Source entities.
Source entities can be a Physical Reference or a path of Physical Instances.
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.

ipiTargetLogical is NULL.
oListOfSourcesPhysical is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationTargets

public virtual GetImplementRelationTargets(		`ipiSourcePhysical`,
		`oListOfTargetsLogical`)

Deprecated:

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

Parameters:

ipiSourcePhysical: Represents the Source entity.
Source entity can be a Physical Reference or a path of Physical Instances.
oListOfTargetsLogical: Represents the Target entities.
Target entities can be a Logical Reference or a path of Logical Instances.

Returns:

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

ipiSourcePhysical is NULL.
oListOfTargetsLogical is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

o GetImplementRelationTargets

public virtual GetImplementRelationTargets(		`ipiSourcePhysical`,
		`oListOfTargetsLogical`,
		`oListOfImplementLinks`)

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

Parameters:

ipiSourcePhysical: Represents the Source entity.
Source entity can be a Physical Reference or a path of Physical Instances.
oListOfTargetsLogical: Represents the Target entities.
Target entities can be a Logical Reference or a path of Logical Instances.
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.

ipiSourcePhysical is NULL.
oListOfTargetsLogical is not empty.

E_FAIL if an error occured.

Licensing authorization not granted.
Internal error.

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