DataExchangeBaseRepsItf Interface CATIExchangeProductInstance
Usage: you can freely reimplement this interface.
 interface CATIExchangeProductInstance
 Interface to exchange product instances.
 Role: This interface describes an instance of product.
 An instance is a space location in the context of a tree of a reference;
 the reference is either a product, or a part, both cases are handled thru a document.
 If available, presentation properties (color, layer, etc.) can be retrieved on the object using
  interface (use QueryInterface on the CATIExchangeProductInstance pointer). 
Available from CATIA V5R10.
 
  -  See also: 
  
 -  , 
 
 Method Index
 
 -  o 
    GetGeometricProperties(double[],double&,double&,double&)
 -   Retrieves the instance's geometric properties.
 
 -  o 
    GetInstanceAttributes(CATUnicodeString&,CATUnicodeString&)
 -   Retrieves the attributes of the instance.
 
 -  o 
    GetReferenceProduct(CATIExchangeProduct_var&)
 -   Retrieves the reference of this instance.
 
 -  o 
    GetTransformation(double[3][3],double[3])
 -   Retrieves the spatial transformation of the instance.
 
 -  o 
    GetUID(CATLONG32&)
 -   Retrieves the UID associated to the instance.
 
 Methods
 
  o GetGeometricProperties
  |   public virtual   GetGeometricProperties( |   | oCentroid, | 
 |   | oVolume, | 
 |   | oWetArea, | 
 |   | oTolerance)   | 
  - 
 Retrieves the instance's geometric properties.
 
  -  Parameters:
  
 - 
    
    -  oCentroid
   
 - 				Get the instance's centroid.
 
 
    -  oVolume
   
 - 				Get the instance's volume.
 
 
    -  oWetArea
   
 - 				Get the instance's wet area.
 
 
    -  oTolerance
   
 - 				Get the tolerance used to compute wet area in the instance.
 
 
 
  o GetInstanceAttributes
  |   public virtual   GetInstanceAttributes( |   | oName, | 
 |   | oDescription)   | 
  - 
 Retrieves the attributes of the instance. 
 
  -  Parameters:
  
 - 
    
    -  oName
   
 - 				Get the instance's name.
 
 
    -  oDescription
   
 - 				Get the instance's description.
 
 
 
  o GetReferenceProduct
  |   public virtual   GetReferenceProduct( |   | oProduct)   | 
  - 
 Retrieves the reference of this instance.
 It's always a product.
 
  -  Parameters:
  
 - 
    
    -  oProduct
   
 - 				Get the product reference.
 
 
 
  o GetTransformation
  |   public virtual   GetTransformation( |   | oRot, | 
 |   | oTrans)   | 
  - 
 Retrieves the spatial transformation of the instance.
 The matrix must be isometric in case of conversion in V5 or V6. 
 Includes mirroring, scaling, etc.
 
  -  Parameters:
  
 - 
    
    -  oRot
   
 - 				Get the rotation parameters.
 
 
    -  oTrans
   
 - 				Get the translation parameters.
 
 
 
  o GetUID
  |   public virtual   GetUID( |   | oInstanceUID)   | 
  - 
 Retrieves the UID associated to the instance. 
 The UID is used as an identifier of the instance; it is a non persistent ID,
 which lifecycle is mapped on the document lifecycle.
 
  -  Parameters:
  
 - 
    
    -  oInstanceUID
   
 - 				Get the instance's UID.
 
 
 
 This object is included in the file: CATIExchangeProductInstance.h
If needed, your Imakefile.mk should include the module: DataExchangeBaseRepsItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.