All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATImmENOVIAProvider Class CATPDMNavServices

CATPDMNavServices
 

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


public class CATPDMNavServices

Services to interface with VPMNav client Modeler.

Role:Provide various services to support the Nav client modeler


Method Index


o BindEnoviaIdToNav(CATIPLMIdentificator*,CATBaseUnknown**)
Enable the client to go from a CATIPLMIdentificator to a VPM Nav model object.
o ExtractEnoviaIdFromNav(CATBaseUnknown*,CATIPLMIdentificator**)
Enable the client to go from a Nav Model object and get its identificator.

Methods


o BindEnoviaIdToNav
public static HRESULT BindEnoviaIdToNav(CATIPLMIdentificator* ipId,
CATBaseUnknown** opObj)
Enable the client to go from a CATIPLMIdentificator to a VPM Nav model object.
Role:This method enables to bind a (new/existing) Nav model object from a CATIPLMIdentificator

Commonly supported ENOVIA ids are ENOVIA_VPMTPDocumentVersion, ENOVIA_VPMPartVersion, ENOVIA_VPMItemInstance, ENOVIA_VPMProductRootClass, ENOVIA_AflAction, ENOVIA_CFHANDLER
restrictions apply: not all ENOVIA ids can be binded to VPM Nav. The Bind mechanism may return a new temporary nav objects, thus Id comparison mechanism may be needed to assess if two nav objects are refering to the same ENOVIA object

Parameters:
ipId
Identificator of the object
opObj
VPMNav Model Temporary object
Returns:
  • S_OK: identificator converted to a VPMNav object
  • E_FAIL: object cannot be binded as a VPMnav object
o ExtractEnoviaIdFromNav
public static HRESULT ExtractEnoviaIdFromNav(CATBaseUnknown* ipObj,
CATIPLMIdentificator** opId)
Enable the client to go from a Nav Model object and get its identificator.
Role:This method enables to get a CATIPLMIdentificator from an existing Nav model object

Commonly supported Nav Object are CATDocument or CATIProduct (root being PRC, intermediate level II, leave PV)
restrictions apply: not all Nav Object correspond to ENOVIA persistant ids. Use CATImmIdentifierAcquisitionAgent to decode Nav view and get accurate ENOVIA ids.

Parameters:
ipObj
Nav model object
opId
identificator for ENOVIA
Returns:
  • S_OK: identificator build as a nav object
  • E_FAIL: object cannot convert to an ENOVIA persistant Ids

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

Copyright © 2003, Dassault Systèmes. All rights reserved.