CATPLMIntegrationAccess CATAdpDictionaryServices

Usage: you must use this class as is. You should never derive it.

public class CATAdpDictionaryServices

Class to manage PLM dictionary.

Role: This class provides all basic functions to browse and navigate on PLM dictionaries A repository contains many environments. In a repository, can be declared differents modelers. The types of differents modelers are describe in metadata files.

Method Index


o GetEnvironment(char*,CATString&,CATIAdpEnvironment**)
Retrieves an environment by its name.
o GetModeler(char*,CATString&,CATListPtrCATBaseUnknown&)
o ListEnvironments(char*,CATListValCATString&,CATListValCATUnicodeString&)
Gets the available environments.
o ListModelers(char*,CATListValCATString&,CATListValCATUnicodeString&)

Methods


o GetEnvironment
public static GetEnvironment( const iRepository,
const iEnvId,
oEnvironment)
Retrieves an environment by its name.
Role: This will result in the loading of the corresponding modelers describe in the metadata file.
Parameters:
iRepository
The repository name.
iEnvId
[in] The environment name.
oEnvironment
[out, CATBaseUnknown#Release] The loaded environment. Release the pointer when useless.
Returns:
S_OK
The provided environment was successfully loaded.
E_FAIL
A problem occurs during the operation.
o GetModeler
public static GetModeler( const iRepository,
const iModId,
oTypes)
Deprecated:
R213 Use CATITypeDictionary#ListTypesForPackage instead
Retrieves the modeler identified through the provided identifier.
Role: This will result in the loading of the corresponding modeler.
Parameters:
iRepository
The repository which load the Modeler from.
iModId
[in] The modeler name.
oTypes
[out] The types of components that can be examined in this modeler. Release the returned objects when useless.
Returns:
S_OK
The provided modeler was successfully loaded.
E_FAIL
Failure. A problem occurs during the operation.
o ListEnvironments
public static ListEnvironments( const iRepository,
oEnvId,
oEnvAlias)
Gets the available environments.
Role: This method provides the different available environments.
Parameters:
iRepository
The repository name.
oEnvId
[out] The environment name list. When calling method, this list should be empty.
oEnvAlias
[out] The environment display name list.When calling method, this list should be empty.
Returns:
S_OK
At least one environment is available.
S_FALSE
No environment available.
E_FAIL
Failure.
o ListModelers
public static ListModelers( const iRepository,
oModId,
oModAlias)
Deprecated:
R213 Use CATITypeDictionary#ListTypesForPackage instead
Gets the available modelers.
Role: this method provides the different available modelers.
Parameters:
iRepository
The repository which load the modeler from.
oModId
[out] The modeler name list. When calling method, this list should be empty.
oModAlias
[out] The modeler display name list.When calling method, this list should be empty.
Returns:
S_OK
At least one modeler is available.
S_FALSE
No modeler available.
E_FAIL
Failure.
This object is included in the file: CATAdpDictionaryServices.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess

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