Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogPort

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

interface CATILogPort

Interface designating a Logical Port and providing means to manage the Logical Port properties.

Method Index

o Connect(CATILogInstance*,CATILogPort*,CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogConnection*&): Connects this Logical Port (of a logical system) to an instance of logical subsystem through a specific port.
o GetConnectedSubSystems(CATListValCATILogInstance_var&,CATListValCATILogPort_var&,CATListValCATILogConnection_var&): Retrieves the instances of logical subsystems connected to this Logical Port.
o GetDirection(PortDirection&): Retrieves the direction of this Logical Port.
o GetParent(void**,IID&): Retrieves the Logical Reference aggregating this Logical Port.
o GetType(CATILogTypeReference*&): Retrieves the Logical Type Reference associated to this Logical Port.
o GetTypeInstance(CATILogTypeInstance*&): Retrieves the Logical Type Instance associated to this Logical Port.
o RemoveType(): Removes the Logical Type associated to this Logical Port.
o SetDirection(PortDirection): Sets the direction of this Logical Port.
o SetType(CATILogTypeReference*): Sets the Logical Type associated to this Logical Port.

o PortDirection: Defines the direction of a Logical Port.

Methods

o Connect

public virtual Connect(		`ipLogicalInstance`,
		`ipLogicalPort`,
	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`opLogicalConnection`)

Connects this Logical Port (of a logical system) to an instance of logical subsystem through a specific port.
Role: This method connects this Logical Port to a Logical Instance through a specific Logical Port (of a Logical Reference the instance comes from) by creating a Logical Connection. The Logical Instance must be aggregated by the Logical Reference this Logical Port belongs.
It corresponds to the Parent-Child 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:

ipLogicalInstance: The instance of logical subsystem to be connected with.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
ipLogicalPort: The specific Logical Port of 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.
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:

o GetConnectedSubSystems

public virtual GetConnectedSubSystems(		`oLConnectedLogicalInstances`,
		`oLConnectedLogicalPorts`,
		`oLLogicalConnections`)

Retrieves the instances of logical subsystems connected to this Logical Port.
Role: This method retrieves the Logical Instances (and the specific Logical Ports) connected to this Logical Port through Logical Connections.
It corresponds to the Parent-Child connectivity pattern.

Parameters:

oLConnectedLogicalInstances: A list of Logical Instances of systems connected to this 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).
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) metarializing the link between this Logical Port and the connected instances of logical systems.
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 exposed logical systems (if exist) are retrieved.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetDirection

public virtual GetDirection( oDirection)

Retrieves the direction of this Logical Port.

Parameters:

oDirection: The Logical Port direction.
Output parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o GetParent

public virtual GetParent(		`oppParent`,
	const	`iIID`	`= IID_CATILogReference`)

Retrieves the Logical Reference aggregating this Logical Port.

Parameters:

oppParent: A Logical Reference or a Logical Mux/Demux Reference.
Output parameter.
iIID: The desired interface. CATILogReference by default.

Returns:

S_OK if the method succeeds.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

o GetType

public virtual GetType( opLogicalTypeReference)

Retrieves the Logical Type Reference associated to this Logical Port.

Parameters:

opLogicalTypeReference: [out, CATBaseUnknown#Release]
A Logical Type 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. opLogicalTypeReference may be NULL if there is no associated type.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o GetTypeInstance

public virtual GetTypeInstance( opLogicalTypeInstance)

Retrieves the Logical Type Instance associated to this Logical Port.

Parameters:

opLogicalTypeInstance: [out, CATBaseUnknown#Release]
A Logical Type 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. opLogicalTypeInstance may be NULL if there is no associated type.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

o RemoveType

public virtual RemoveType(

)

Removes the Logical Type associated to this Logical Port.

Returns:: S_OK if the method succeeds and the associated Logical Type if exists has been removed.
E_FAIL otherwise.

o SetDirection

public virtual SetDirection( iDirection)

Sets the direction of this Logical Port.

Parameters:

iDirection: The new Logical Port direction.
Input parameter.

Returns:

S_OK if the method succeeds.
E_FAIL otherwise.

o SetType

public virtual SetType( ipLogicalTypeReference)

Sets the Logical Type associated to this Logical Port.
Role: This method associates the given Logical Type Reference by instantiating it and associating it to the Logical Port.

This API invokes the following Business Logic Openness:

FLTypeAssociationCheck
PLMIdentificationInitialization

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

Parameters:

ipLogicalTypeReference: A Logical Type Reference.
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.
E_INVALIDARG if the provided parameter is unexpected.
E_FAIL otherwise.

Enumerated Types

o PortDirection

enum PortDirection {
  In,
  Out,
  InOut,
  NoDirection
}

Defines the direction of a Logical Port.

Parameters:

In: Port In.
Out: Port Out.
InOut: Port In/Out
NoDirection: No direction defined yet.

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

CATLogicalModelerUseItf Interface CATILogPort

Method Index

Enumerated Type Index

Methods

Enumerated Types