All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTPSInterfaces Interface CATITPSServicesContainers

System.IUnknown
  |
  +---CATITPSServicesContainers
 

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


interface CATITPSServicesContainers

Interfaces dedicated to retreieve or create Tolerancing container and Tolerancing Set.


Method Index


o CheckReferenceProductInPath(CATPathElement*,CATIProduct**,CATBoolean*,CATPathElement**)
Check that the reference product is included in a path element.
o GetReferenceProductContext(CATIProduct**,CATFrmEditor*)
Retrieves the Reference Product.
o RetrieveOrCreateCurrentTPSSet(CATIProduct*,CATTPSSetObtentionMode,CATITPSSet**,CATBoolean*)
Retrieves or creates a TPSSet.

Methods


o CheckReferenceProductInPath
public virtual HRESULT CheckReferenceProductInPath(CATPathElement* ipPath,
CATIProduct** iopiRefProduct,
CATBoolean* obRetrievedFromPath,
CATPathElement** opUIActivePath) = 0
Check that the reference product is included in a path element.
Parameters:
ipPath
The context path.
iopiRefProduct
The reference product already computed (can be NULL). If the reference product is NULL or not in path a new one will be computed.
obRetrievedFromPath
If TRUE indicate that the reference product has been retrieved from Path.
opUIActivePath
The UI Active Path that must be provided to the TTRS agent when the reference product is retrieved from path.
o GetReferenceProductContext
public virtual HRESULT GetReferenceProductContext(CATIProduct** opiRefProduct,
CATFrmEditor* ipEditor= NULL) = 0
Retrieves the Reference Product.
Parameters:
opiRefProduct
[out, CATIProduct#Release] Return Reference Product.
ipEditor
The editor of the command, if not provided it is retrieved from the current active document.
o RetrieveOrCreateCurrentTPSSet
public virtual HRESULT RetrieveOrCreateCurrentTPSSet( const CATIProduct* ipiProduct,
const CATTPSSetObtentionMode iMode,
CATITPSSet** opiSet,
CATBoolean* oCreation= NULL) = 0
Retrieves or creates a TPSSet.
Parameters:
iProduct
Defines the search/creation context. It must be a reference product. The method returns E_FAIL if it is an instance product.
iMode
Defines the obtention mode. CreateIfMissing : search a TPSSet in context, if nothing found create a new one. NoCreation : search a TPSSet in context, if nothing found output value *opiSet is NULL. CreateNew : create a new TPSSet in context, even if some TPSSets already exist. The new created set become current.
opiSet
TPS set retrieved or created.
oCreation
TRUE if set has just been created. FALSE if set has been retrieved.

This object is included in the file: CATITPSServicesContainers.h

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