All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATLogicalModelerUseItf Interface CATILogReferenceFactory

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

interface CATILogReferenceFactory

Interface to create Logical References objects.
Role: This interface is a factory to allowing to create logical references.

Example:

  CATILogReferenceFactory *pLogicalReferenceFactory = NULL; 

  HRESULT Hr = CATLogFactoriesProvider::GetReferenceFactory(pLogicalReferenceFactory); 

  if(SUCCEEDED(Hr) && pLogicalReferenceFactory) 

  { 

    ...

See also:

, ,

Method Index

o CreateDemultiplexer(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogTypeReference*,CATILogMuxDemuxReference*&): Builds a Logical Demutiplexer Reference.
o CreateMultiplexer(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogTypeReference*,CATILogMuxDemuxReference*&): Builds a Logical Mutiplexer Reference.
o CreateReference(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogReference*&): Creates a Logical Reference.
o CreateTypeReference(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATILogTypeReference*&): Creates a Logical Type Reference.

Methods

o CreateDemultiplexer

public virtual CreateDemultiplexer(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`ipStructuredLogicalType`,
		`opLogicalDemultiplexerReference`)

Builds a Logical Demutiplexer Reference.
Role: This method builds a Logical Demultiplexer Reference using the specified structured Logical Type Reference.

This API invokes the following Business Logic Openness:

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, RFLVPMLogicalCommunicationReference, 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 demultiplexer reference 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.
ipStructuredLogicalType: A structured Logical Type Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
opLogicalDemultiplexerReference: [out, CATBaseUnknown#Release]
The created Logical Multiplexer 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.

o CreateMultiplexer

public virtual CreateMultiplexer(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`ipStructuredLogicalType`,
		`opLogicalMultiplexerReference`)

Builds a Logical Mutiplexer Reference.
Role: This method builds a Logical Multiplexer Reference using the specified structured Logical Type Reference.

This API invokes the following Business Logic Openness:

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, RFLVPMLogicalCommunicationReference, 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 multiplexer reference 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.
ipStructuredLogicalType: A structured Logical Type Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns an error otherwise.
opLogicalMultiplexerReference: [out, CATBaseUnknown#Release]
The created Logical Multiplexer 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.

o CreateReference

public virtual CreateReference(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`opLogicalReference`)

Creates a Logical Reference.
Role: This method creates a Logical Reference.

This API invokes the following Business Logic Openness:

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, RFLVPMLogicalReference, 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 reference 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.
opLogicalReference: [out, CATBaseUnknown#Release]
The created 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.

o CreateTypeReference

public virtual CreateTypeReference(	const	`ispType`,
	const	`ipEnvtForProject`,
		`iLFctAttributesValues`,
		`opLogicalTypeReference`)

Creates a Logical Type Reference.
Role: This method creates a Logical Type Reference.

This API invokes the following Business Logic Openness:

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, RFLVPMSystemTypeReference, 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 type reference 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.
opLogicalTypeReference: [out, CATBaseUnknown#Release]
The created 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.
E_INVALIDARG if parameters provided are unexpected.
E_FAIL otherwise.

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