DataExchangeBaseRepsItf Interface CATIExchangeProduct
Usage: you can freely reimplement this interface.
interface CATIExchangeProduct
Interface to exchange products.
Role: The product is the part of a product structure representation describing the structure of one product;
This interface is used to represent root products as well as sub-products (references).
A product is either a document, that will be used for the further queries, or a list of product instances
that are the "components" of this product.
Available from CATIA V5R11.
- See also:
- ,
Method Index
- o
GetDocument(CATIExchangeInputDocument_var&)
- Retrieves the document enclosed in the product (Product document or Part document).
- o
GetFilePath(FilePath&)
- Retrieves the filepath associated to the product when it is a document.
- o
GetGeometricProperties(double[],double&,double&,double&)
- Retrieves the geometric properties of the product.
- o
GetInstanceList(CATLISTV(CATIExchangeProductInstance_var)&)
- Retrieves the list of product instances referrenced by this product (its components).
- o
GetProductAttributes(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,SourceTypes&)
- Retrieves the product's attributes.
- o
GetUID(CATLONG32&)
- Retrieves the UID associated to the product (shortcut to UID of the product).
Enumerated Type Index
- o
SourceTypes
- Product source types.
Methods
o GetDocument
| public virtual GetDocument( | | oDocument) |
-
Retrieves the document enclosed in the product (Product document or Part document).
There may be no document: in such case, the browse of the product structure will continue thru GetInstanceList.
- Parameters:
-
- oDocument
- Get the input document.
o GetFilePath
| public virtual GetFilePath( | | oDocumentFilePath) |
-
Retrieves the filepath associated to the product when it is a document.
Generally used on external references when GetDocument cannot return a
because the format is unsupported.
- Parameters:
-
- oDocumentFilePath
- Get the document filepath.
o GetGeometricProperties
| public virtual GetGeometricProperties( | | oCentroid, |
| | oVolume, |
| | oWetArea, |
| | oTolerance) |
-
Retrieves the geometric properties of the product.
- Parameters:
-
- oCentroid
- Get the product's centroid.
- oVolume
- Get the product's volume.
- oWetArea
- Get the product's wet area.
- oTolerance
- Get the tolerance used to compute wet area in the product.
o GetInstanceList
| public virtual GetInstanceList( | | oInstances) |
-
Retrieves the list of product instances referrenced by this product (its components).
- Parameters:
-
- oInstances
- Get the list of product instances.
o GetProductAttributes
| public virtual GetProductAttributes( | | oName, |
| | oRevision, |
| | oDefinition, |
| | oDescription, |
| | oNomenclature, |
| | oProductSource) |
-
Retrieves the product's attributes.
- Parameters:
-
- oName
- Product identifier, or part number.
- oRevision
- Product revision.
- oDefinition
- Product definition.
- oDescription
- Product description.
- oNomenclature
- Nomenclature.
- oProductSource
- See SourceTypes (Made, Bought, or unknown).
o GetUID
| public virtual GetUID( | | oProductUID) |
-
Retrieves the UID associated to the product (shortcut to UID of the product).
The UID is used as an identifier of the product; it is a non persistent ID, which lifecycle is mapped
on the document lifecycle. This UID is used to detect products already converted during the transfer.
- Parameters:
-
- oProductUID
- Get the product UID.
Enumerated Types
o SourceTypes
-
enum SourceTypes {
Made,
Bought,
Unknown
}
Product source types.
Legal values:
Made,
Bought,
Unknown.
This object is included in the file: CATIExchangeProduct.h
If needed, your Imakefile.mk should include the module: DataExchangeBaseRepsItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.