All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogPorts

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

interface CATILogPorts

Interface dedicated to Logical Ports management.

Role: This interface manages the collection of Logical Ports aggregated by a Logical Reference.
This collection defines the logical interface of the Logical Reference as a component.

Method Index

o Add(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogTypeReference*,CATILogPort*&): Creates a Logical Port.
o Count(int&): Retrieves the number of Logical Ports aggregated by this Logical Reference.
o List(CATListValCATILogPort_var&): Retrieves the collection of Logical Ports aggregated by this Logical Reference.
o Remove(CATILogPort*): Removes the given Logical Port.

Methods

o Add

public virtual Add(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`ipLogicalTypeReference`,
		`opLogicalPort`)

Creates a Logical Port.
Role: This method creates a Logical Port that will be aggregated by this Logical Reference.

This API invokes the following Business Logic Openness:

PLMPortAggregationCheck
FLTypeAssociationCheck
PLMIdentificationInitialization

For any information about Business Logic Openness, refer to the CAA Encyclopedia documentation: Reference \ Business Logic Openness section.

Parameters:

ispType: The functional type. If the argument is NULL, the modeler type, RFLVPMLogicalPort, 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 port to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
The direction of the Logical Port must be valuated (V_Direction attribute).
Input Parameter.
ipLogicalTypeReference: The Logical System Type that must be associated to this Logical Port (Optional).
This parameter can be provided by caller as NULL.
Input Parameter.
opLogicalPort: [out, CATBaseUnknown#Release]
The created Logical Port.
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 Count

public virtual Count( oSize)

Retrieves the number of Logical Ports aggregated by this Logical Reference.

Parameters:

oSize: The number of Logical Ports.

Returns:

S_OK The method succeeds and the number of Logical Ports is retrieved.
E_FAIL otherwise.

o List

public virtual List( oLLogicalPorts)

Retrieves the collection of Logical Ports aggregated by this Logical Reference.

Parameters:

oLLogicalPorts: A list of logical ports.
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 Logical Ports (if exist) aggregated by this Logical Reference are retrieved.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o Remove

public virtual Remove( ipLogicalPortToRemove)

Removes the given Logical Port.
Role: This method removes and deletes the given Logical Port from the logical ports aggregated by the Logical Reference.
The given logical port must be aggregated by this Logical Reference.

Parameters:

ipLogicalPortToRemove: The logical port to remove.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.

Returns:

S_OK if the method succeeds and the Logical Port has been successfully removed.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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