CATLogicalModelerUseItf Interface CATILogInstance

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

interface CATILogInstance

Interface designating a Logical Instance.

Role: This interface is implemented on logical instances.

Method Index

o Connect(CATILogPort*,CATILogInstance*,CATILogPort*,CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogConnection*&): Connects two instances of logical systems together.
o GetConnectedParentPorts(CATILogPort*,CATListValCATILogPort_var&,CATListValCATILogConnection_var&): Retrieves the Logical Ports exposing at the upper level a specific port of this instance of logical system.
o GetConnectedSiblingSystems(CATILogPort*,CATListValCATILogInstance_var&,CATListValCATILogPort_var&,CATListValCATILogConnection_var&): Retrieves the instances of sibling logical systems connected to this instance of logical system.
o GetFather(CATILogReference*&): Retrieves the Logical Reference which aggregates this Logical Instance.
o GetReferenceInstanceOf(CATILogReference*&): Retrieves the instanciated Logical Reference.

Methods

o Connect

public virtual Connect(		`ipFromLogicalPort`,
		`ipToLogicalInstance`,
		`ipToLogicalPort`,
	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`opLogicalConnection`)

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

ipFromLogicalPort: A Logical Port of the Logical Reference this instance comes from.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
ipToLogicalInstance: The instance of logical system to be connected with.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
ipToLogicalPort: The specific Logical Port (of the Logical 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 functional type. If the argument is NULL, the modeler type, RFLVPMLogicalConnection, is used as functional type.
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 logical 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.
opLogicalConnection: [out, CATBaseUnknown#Release]
The created Logical Connection that connects the two instances of logical 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(		`ipLogicalPort`,
		`oLConnectedLogicalPorts`,
		`oLLogicalConnections`)

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

Parameters:

ipLogicalPort: A Logical Port of the Logical Reference this instance comes from.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
oLConnectedLogicalPorts: A list of Logical Ports exposing the specified Logical Port of this Logical 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.
oLLogicalConnections: A list of Logical Connections (related to the previous list of Logical Ports) materializing the link between the specified port of this instance and the Logical Ports of the upper logical 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(		`ipLogicalPort`,
		`oLConnectedLogicalInstances`,
		`oLConnectedLogicalPorts`,
		`oLLogicalConnections`)

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

Parameters:

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

o GetFather

public virtual GetFather( opLogicalReference)

Retrieves the Logical Reference which aggregates this Logical Instance.

Parameters:

opLogicalReference: [out, CATBaseUnknown#Release]
The Logical Reference aggregating this Logical 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 unexpected.
E_FAIL otherwise.

o GetReferenceInstanceOf

public virtual GetReferenceInstanceOf( opLogicalReference)

Retrieves the instanciated Logical Reference.

Parameters:

opLogicalReference: [out, CATBaseUnknown#Release]
The instantiated Logical 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: CATILogInstance.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerUseItf