CATFunctionalModelerUseItf Interface CATIFctReferenceFactory

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

interface CATIFctReferenceFactory

Interface to create Functional References objects.
Role: This interface is a factory for creation of Functional references.

Example:

  CATIFctReferenceFactory *pFunctionalReferenceFactory = NULL; 

  HRESULT Hr = CATFctFactoriesProvider::GetReferenceFactory(pFunctionalReferenceFactory); 

  if(SUCCEEDED(Hr) && pFunctionalReferenceFactory) 

  { 

    ... 

  } 

  if (NULL!=pFunctionalReferenceFactory) 

  { 

    pFunctionalReferenceFactory->Release(); 

    pFunctionalReferenceFactory=NULL; 

  } 


 

See also:

,

Method Index

o CreateDemultiplexer(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctFlowReference*,CATIFctMuxDemuxReference*&)

Builds a Functional Demultiplexer Reference.

o CreateFlowReference(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctFlowReference*&)

Creates a Functional Flow Reference.

o CreateMultiplexer(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctFlowReference*,CATIFctMuxDemuxReference*&)

Builds a Functional Mutiplexer Reference.

o CreateReference(CATIType_var&,CATIAdpEnvironment*,CATListValCATICkeParm_var&,CATIFctReference*&)

Creates a Functional Reference.

Methods

Builds a Functional Demultiplexer Reference.
Role: This method builds a Functional Demultiplexer Reference using the specified structured Functional Flow 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 type of the Functional Demultiplexer Reference to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalCommunicationReference will be used by default for creation.
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 Functional 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.

ipStructuredFunctionalFlow

A structured Functional Flow Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

opFunctionalDemultiplexerReference

[out, CATBaseUnknown#Release]
The created Functional Demultiplexer 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.

Creates a Functional Flow Reference.
Role: This method creates a Functional Flow 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 type of the Functional Flow Reference to create. If this argument is a NULL pointer, the modeler type RFLPLMFlowReference will be used by default for creation.
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 Functional flow reference to create).
The compliancy of attributes values will be checked relatively to their definition in metadata (mandatory, size, type).
Note that the mandatory attribute V_Category must be set either to Data (its purpose is to exchange data) or Control (its purpose is to order the activation/de-activation of a function).
Input Parameter.

opFunctionalFlowReference

[out, CATBaseUnknown#Release]
The created Functional Flow 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.

Builds a Functional Mutiplexer Reference.
Role: This method builds a Functional Multiplexer Reference using the specified structured Functional Flow 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 type of the Functional Multiplexer Reference to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalCommunicationReference will be used by default for creation.
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 Functional 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.

ipStructuredFunctionalFlow

A structured Functional Flow Reference.
Input Parameter.
This parameter MUST NOT be provided by caller as NULL. This method returns E_INVALIDARG otherwise.

opFunctionalMultiplexerReference

[out, CATBaseUnknown#Release]
The created Functional 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.

Creates a Functional Reference.
Role: This method creates a Functional 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 type of the Functional Reference to create. If this argument is a NULL pointer, the modeler type RFLPLMFunctionalReference will be used by default for creation.
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 Functional 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.

opFunctionalReference

[out, CATBaseUnknown#Release]
The created Functional Reference.
Output parameter.
This parameter MUST be provided by caller as NULL. This method returns E_INVALIDARG 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.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.