All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATxPDMInterfaces Interface CATIxPDMPartItem

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIxPDMPartItem
 

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


interface CATIxPDMPartItem

Interface to access any V5 Part item that can be stored in an external PDM system.
Role: Provide access to specific information on Part items.

This interface is available only on items (CATIxPDMItem ) of type CATPart loaded in session

All the methods pre-requisites the PX1 license

See also:
CATIxPDMItem, CATxPDMSessionServices


Method Index


o GetContextItems(CATListValCATIxPDMItem_var&)
Returns all necessary items for contextual edition of links.
o GetImportedItems(CATListValCATIxPDMItem_var&)
Returns all imported items in this item.
o HasExternalLinks(CATBoolean&)
Check if a Part has external links through imports (geometry or knowledge parameters).

Methods


o GetContextItems
public virtual HRESULT GetContextItems(CATListValCATIxPDMItem_var& oContextList) = 0
Returns all necessary items for contextual edition of links.
Role:This method retrieves the list of items that are necessary for edition of contextual links.
Parameters:
oContextList
The Product item list, they could be loaded or not.
Returns:
  • S_OK: The context list is successfully computed.
  • S_FALSE: There is no context.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1004:
    • Internal error.
    • InputERR_1124:
    • This part has contextual link(s) through Product(s) and it is impossible to load the Product context.
o GetImportedItems
public virtual HRESULT GetImportedItems(CATListValCATIxPDMItem_var& oImportedList) = 0
Returns all imported items in this item.
Role:This method retrieves all items pointed through an import (geometry or knowledge parameters) from the current one. This method requires that the file associated with the current item is loaded in session. To retrieve imported items, we have to load some complementary data (like Product Context) in session. To avoid loading useless data in memory, use CATIxPDMPartItem#HasExternalLinks before.
Parameters:
oImportedList
The imported item list, they could be loaded or not.
Returns:
  • S_OK: The children list is successfully computed.
  • S_FALSE: There is no children.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1004:
    • Internal error.
    • InputERR_1124:
    • This part has contextual link through a Product and it is impossible to load the Product context.
o HasExternalLinks
public virtual HRESULT HasExternalLinks(CATBoolean& oHasExternalLinks) = 0
Check if a Part has external links through imports (geometry or knowledge parameters).
Role:This method checks if there is some imported items (in a product context or without product context). Geometry and Knowledge parameters imports are checked.
Parameters:
oHasExternalLinks
TRUE if there is at least one imported item, FALSE if there is no imported item.
Returns:
  • S_OK: oHasContextualLinks is successfully computed.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1004:
    • Internal error.

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

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