PLMDictionaryNavServices CATCkePLMNavSpecializationAccessPublicServices

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


public class CATCkePLMNavSpecializationAccessPublicServices

Services enabling the access to PLM types that correspond to specialization types (or specialization extensions) created by a customer with KWD tool.

These services make sense only if you're operating in Unified Typing mode.
Small introduction to the different kinds of PLM types.
- top modeler types: for instance VPMReference. It corresponds to types delivered by our software out of the box
- discipline types: for instance Drawing. They correspond to sub types of top modeler types for a given application.
- custo types: it is the types defined by the customers with DMC tool, in Former typing system.
- specialization types: it is the types defined by the customers with the new KWD tool. They are different from custo types.
- extension types: An extension is put on an object by an application to extend its data model and its behaviors.
- specialization extension types: it correspond to a sub type of an extension defined by the customer with the new KWD tool.
- customer extension types: they correspond to an extension defined by a customer with the new KWD tool.
- deployment extension types: they are not available in CAA public APIs. A deployment extension is put on an object with a business rule to extend automatically its data model. Deployment extension are created with the DMA tool.
A PLM object has a primary type (modeler, discipline, specialization, custo) and potentially several secondary types (extension, specialization extension, customer extension, and deployment extensions).
The services of this CATCkePLMNavSpecializationAccessPublicServices header are aimed at manipulating specialization types, specialization extension types, customer extension types created with KWD tool.
If you want to list attributes of a specialization type or extension, please use .
If you want to access custo types, please use .
If you want to access out of the box types, please use .
If you want to read attributes on an object, please use .
If you want to write attributes on an object, please use .

See also:
, , , , , ,


Method Index


o IsACustomerExtension(CATIType_var&,CATBoolean&)
Indicates if the type is a secondary type (extension) and if it is a customer extension (not inheriting from DS type)
o IsASpecializationType(CATIType_var&)
Indicates if a type is a specialization type, a specialization extension or a customer extension.
o RetrieveSpecializationType(char*,CATIType_var&)
Returns the Specialization type from a type name.

Methods


o IsACustomerExtension
public static IsACustomerExtension( const iType,
oResult)
Indicates if the type is a secondary type (extension) and if it is a customer extension (not inheriting from DS type)
Parameters:
iType
The type in input
oResult
TRUE if customer extension, FALSE if not
Returns:
  1. E_INVALIDARG if the type is NULL
  2. S_FALSE if the type is not an extension
  3. S_OK
o IsASpecializationType
public static IsASpecializationType( const iType)
Indicates if a type is a specialization type, a specialization extension or a customer extension.
Usage: Only for CAA customers. Do not use it internally.
Parameters:
iType
The type in input
Returns:
  1. E_INVALIDARG if the type is not found
  2. S_FALSE if the type is not a specialization type, specialization extension or customer extension
  3. S_OK if the type has been found
o RetrieveSpecializationType
public static RetrieveSpecializationType( const iTypeName,
oType)
Returns the Specialization type from a type name.
Usage: Only for CAA customers. Do not use it internally.
Works for specialization types, specialization extensions and customer extensions.
Parameters:
iTypeName
The type name in input. Only specialization types, specialization extension types and customer extensions are authorized.
oType
the type found
Returns:
  1. E_INVALIDARG if the type is not found or type name is not a specialization type.
  2. S_OK if the type has been found

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

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