All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTPSInterfaces Interface CATITPSIDServices

System.IUnknown
  |
  +---CATITPSIDServices
 

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


interface CATITPSIDServices

Interface to retrieve FTA object by identificator or to generate FTA identificator.
Role<\b>: This interface allows to retrieve a FTA feature by its identificator inside the input document. Use CATInstanciateComponent service to retrieve a pointer on this interface.


Method Index


o GetFTAKeyFromFeature(IUnknown*,CATUnicodeString&)
Retrieves the FTA key of the FTA Feature.
o GetFeatureFromFTAKey(CATUnicodeString&,CATDocument*,IUnknown**)
Retrieves the FTA feature with the FTA key in a document.

Methods


o GetFTAKeyFromFeature
public virtual HRESULT GetFTAKeyFromFeature( const IUnknown* ipiObj,
CATUnicodeString& oFtaKey) const = 0
Retrieves the FTA key of the FTA Feature.
Parameters:
ipiObj
FTA feature in the Document
oFtaKey
The unique identificator of the FTA object. If return code E_FAIL ipiObj is not found in the document. If return code S_OK and oFtaKey != "" ipiObj is a FTA object having an unique FTA key. If return code S_OK and oFtaKey == "" ipiObj is a FTA object not having an unique FTA key.
o GetFeatureFromFTAKey
public virtual HRESULT GetFeatureFromFTAKey( const CATUnicodeString& iFtaKey,
CATDocument* ipdoc,
IUnknown** opiObj) const = 0
Retrieves the FTA feature with the FTA key in a document.
Parameters:
iFtaKey
The unique identificator for a document
ipdoc
The document where the FTA feature is sought.
opiObj
The FTA object found. If return code E_FAIL opiObj is not found in the document. If return code S_OK opiObj is found in the document.

This object is included in the file: CATITPSIDServices.h

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