All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ProductStructure Interface CATIProduct

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

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


interface CATIProduct

Interface to manage products.
Role: this interface concerns components ( references products ) or instances ( reuse of existing references ) agregated in upperproducts.


Method Index


o AddConnector(CATILinkableObject_var&,CATIConnector_var&)
Adds connector by agregating it to the product.
o AddProduct(CATIProduct_var&,CATIContainer_var&)
Adds subproduct.
o AddProduct(CATUnicodeString&,CATIContainer_var&)
Creates new product and adds it as subproduct.
o AddProducts(CATListValCATBaseUnknown_var&,CATIContainer_var&,CATListValCATBaseUnknown_var*&)
Adds subproducts.
o AddShapeRepresentation(CATILinkableObject_var&,CATUnicodeString&,CATRepMode&,CATBoolean)
Adds a representation to the product with a specific behavior.
o AddShapeRepresentation(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATRepMode&,CATBoolean)
Adds a representation to the product with a specific behavior.
o FindInstance(CATIProduct_var&)
Returns the instance of this in context.
o GetAllChildren(char*)
Returns list of all subproducts.
o GetChildren(char*)
Returns list of subproducts directly concerned.
o GetChildrenCount()
Returns number of direct subproducts.
o GetConnector(CATILinkableObject_var&)
Returns connector.
o GetFatherProduct()
Returns the owning product.
o GetPartNumber()
Returns the name of a product reference.
o GetPrdInstanceName(CATUnicodeString&)
Returns the name of a product instance.
o GetReferenceProduct()
Returns the reference product.
o GetShapeRep(CATILinkableObject_var&,CATUnicodeString&,CATRepMode&,CATBoolean,CATBoolean)
Retrieves the product's representation by its name.
o IsAssociatedToShape(CATUnicodeString&,CATRepMode&,CATBoolean)
Returns whether the product has a representation of the given name with a given behavior.
o IsReference()
Determine whether a product is a reference or not.
o ListShapeRep(CATListValCATUnicodeString*&,CATRepMode&,CATBoolean)
Lists the product's representations.
o RemoveProduct(CATIProduct_var&)
Removes an instance of product.
o RemoveShapeRep(CATUnicodeString&,CATRepMode&,CATBoolean)
Removes a specific representation from the product.
o SetPartNumber(CATUnicodeString&)
Sets the name on a product reference.
o SetPrdInstanceName(CATUnicodeString)
Sets a name on a product instance.

Methods


o AddConnector
public virtual CATIConnector_var AddConnector(CATILinkableObject_var& iObj,
const CATIConnector_var& iConnectorDefinition= NULL_var)=0
Adds connector by agregating it to the product.
Parameters:
iObj
object refered by the connector.
iConnectorDefinition
optionnal argument.
reference of the created connector.
Returns:
the connector.
o AddProduct
public virtual CATIProduct_var AddProduct(CATIProduct_var& iProduct,
const CATIContainer_var& iCont=NULL_var) = 0
Adds subproduct.
Role:Instanciates existing product and agregates it to this.
Parameters:
iProduct
reference product to add. the reference has to be in the same document.
iCont
do not use.
Returns:
the instance product added.
o AddProduct
public virtual CATIProduct_var AddProduct( const CATUnicodeString& iString,
const CATIContainer_var& cont= NULL_var) = 0
Creates new product and adds it as subproduct.
Parameters:
iString
part number of the subproduct to create.
cont
do not use.
Returns:
the instance product added.
o AddProducts
public virtual HRESULT AddProducts( const CATListValCATBaseUnknown_var& iReferences,
CATIContainer_var& iCont,
CATListValCATBaseUnknown_var*& oResult)= 0
Adds subproducts.
Role:Instanciates them and agregates them to this.
Parameters:
iReferences
list of reference products to add.
the references have to be in the same document.
iCont
do not use.
oResult
list of instance products added.
o AddShapeRepresentation
public virtual int AddShapeRepresentation(CATILinkableObject_var& iObj,
const CATUnicodeString& iShapeName= NULL_string,
const CATRepMode& Id= CATPrd3D,
const CATBoolean iInCtxt= TRUE)=0
Adds a representation to the product with a specific behavior.
Role:A representation is the object that gives a geometric shape and allows the visualization of the product. It can be a CATIA V4 model, a VRML or CGR file , or the part feature of a part document ( in this case we are just allowed to browse it, not to add ).
Parameters:
iObj
Geometric shape referenced by the representation
iShapeName
The name that is given to the representation
This name is a user free choice
Id
The behavior of the added representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
iInCtxt
do not use
o AddShapeRepresentation
public virtual int AddShapeRepresentation( const CATUnicodeString& iType,
const CATUnicodeString& iPath,
const CATUnicodeString& iAltShapeName= NULL_string,
const CATRepMode& Id= CATPrd3D,
const CATBoolean iInCtxt= TRUE)=0
Adds a representation to the product with a specific behavior.
Role: the representation is defined here by a document.
Parameters:
iType
type of file where the representation can be found.
Legal values: model, VRML, cgr, but not CATPart.
iPath
The path name where the representation can be found
iAltShapeName
The name that is given to the representation This name is a user free choice
Id
The behavior of the added representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
iInCtxt
do not use
o FindInstance
public virtual CATIProduct_var FindInstance( const CATIProduct_var& iProduct)= 0
Returns the instance of this in context.
Parameters:
iProduct
product context where to seek instance.
Returns:
the instance of this in the given context.
o GetAllChildren
public virtual CATListValCATBaseUnknown_var* GetAllChildren( const char* iIntfId= "CATIProduct") const = 0
Returns list of all subproducts.
Note:Agregation management.
Parameters:
iIntfId
name of the expected interface as handle for the children.
o GetChildren
public virtual CATListValCATBaseUnknown_var* GetChildren( const char* iIntfId= "CATIProduct") const = 0
Returns list of subproducts directly concerned.
Note:Agregation management.
Parameters:
iIntfId
name of the expected interface as handle for the children.
o GetChildrenCount
public virtual int GetChildrenCount()const = 0
Returns number of direct subproducts.
Note:Agregation management.
o GetConnector
public virtual CATIConnector_var GetConnector(CATILinkableObject_var& iObj)=0
Returns connector.
Note: The connector returned is one of all connectors owned by the product which refers obj.
Parameters:
iObj
object refered by the searched connector.
o GetFatherProduct
public virtual CATIProduct_var GetFatherProduct()= 0
Returns the owning product.
Note:Agregation management.
o GetPartNumber
public virtual CATUnicodeString GetPartNumber()const = 0
Returns the name of a product reference.
Note: PartNumber is valid for reference products only.
Returns:
name of the reference.
o GetPrdInstanceName
public virtual HRESULT GetPrdInstanceName(CATUnicodeString& oName)= 0
Returns the name of a product instance.
Note: InstanceName is valid for instance products only.
Parameters:
oName
name of the instance.
o GetReferenceProduct
public virtual CATIProduct_var GetReferenceProduct()= 0
Returns the reference product.
Note:Instance-reference management.
o GetShapeRep
public virtual HRESULT GetShapeRep(CATILinkableObject_var& oLinkShape,
const CATUnicodeString& iShapeName="Default",
const CATRepMode& Id= CATPrd3D,
const CATBoolean InCtxt= TRUE,
const CATBoolean ILoadIfNecessary= FALSE) =0
Retrieves the product's representation by its name.
Parameters:
oLinkShape
geometry associated to the given representation.
iShapeName
The name of the representation of the product.
Id
The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
InCtxt
do not use
Returns:
an HRESULT
Legal values: S_OK if the shape is found.
o IsAssociatedToShape
public virtual HRESULT IsAssociatedToShape( const CATUnicodeString& iShapeName,
const CATRepMode& Id= CATPrd3D,
const CATBoolean InCtxt= TRUE)=0
Returns whether the product has a representation of the given name with a given behavior.
Parameters:
iShapeName
The name of the representation of the product we search for.
Id
The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
InCtxt
do not use
Returns:
an HRESULT
Legal values:S_OK if the product has such a representation.
o IsReference
public virtual HRESULT IsReference()= 0
Determine whether a product is a reference or not.
Returns:
S_OK if this is a reference
E_FAIL if not.
o ListShapeRep
public virtual HRESULT ListShapeRep(CATListValCATUnicodeString*& oList,
const CATRepMode& Id= CATPrd3D,
const CATBoolean InCtxt= TRUE)=0
Lists the product's representations.
Parameters:
oList
list of names of the representations associated to the product.
Id
The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
InCtxt
do not use
Returns:
an HRESULT
Legal values: S_OK if there is representation.
o RemoveProduct
public virtual void RemoveProduct(CATIProduct_var& iInstance) = 0
Removes an instance of product.
Parameters:
iInstance
instance of product to remove.
Note: It also removes the reference if it is the last instance of a local reference .
o RemoveShapeRep
public virtual HRESULT RemoveShapeRep( const CATUnicodeString& iShapeName,
const CATRepMode& Id= CATPrd3D,
const CATBoolean InCtxt= TRUE)=0
Removes a specific representation from the product.
Parameters:
iShapeName
The name of the representation to remove.
Id
The behavior of the representation.
Legal values:
CATPrd3D if the representation is a 3D one,
CATPrd2D if the representation is a 2D one,
or CATPrdText if the representation is a text one.
InCtxt
do not use
o SetPartNumber
public virtual void SetPartNumber( const CATUnicodeString& iPartNumber)= 0
Sets the name on a product reference.
Note: PartNumber is valid for reference products only.
Parameters:
iPartNumber
name of the reference.
o SetPrdInstanceName
public virtual HRESULT SetPrdInstanceName( const CATUnicodeString iName)= 0
Sets a name on a product instance.
Note: InstanceName is valid for instance products only.
Parameters:
iName
name of the instance.
Returns:
E_FAIL if the father of this ever has an instance with iName name.

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

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