All Frameworks  Class Hierarchy  This Framework  Next  Indexes

MechanicalCommands Interface CATIUdfFactory

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

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


interface CATIUdfFactory

Interface to create a User Feature reference or a Power Copy reference.
Role: This interface enables to create a User Feature (Power Copy) reference or to retrieve existing one.
This interface is implemented by the Part container.
With this interface, there are another in relationship:


Method Index


o CreateDocumentTemplate(int)
Creates a document template feature.
o CreatePowerCopy()
Creates a Power Copy reference.
o CreateUserFeature(CATUnicodeString&)
Creates a User Feature reference.
o GetDocumentTemplateList()
Retrieves all Document Templates references.
o GetFeatureSet(int)
Retrieves the feature set.
o GetPowerCopyList()
Retrieves all Power Copy references.
o GetUserFeatureList()
Retrieves all User Feature references.

Methods


o CreateDocumentTemplate
public virtual CATISpecObject_var CreateDocumentTemplate(int iAppendToRelSet= 1) = 0
Creates a document template feature.
Parameters:
iAppendToRelSet
if not set to 0, appends this feature to the related relation set.
Returns:
the created feature
o CreatePowerCopy
public virtual CATIUdfFeature_var CreatePowerCopy()= 0
Creates a Power Copy reference.
Role:After the creation, you use the CATIUdfFeature to fill the reference and at least you set it in the Power Copy set thanks to CATIUdfFeatureSet.AppendFeature .
Use the GetFeatureSet method with 0 as argument to retrieve the set dedicated to the Power Copy.
As long as the Power Copy reference is not added in its specific set, it is not considered as a Power Copy reference of the container: The list given by GetPowerCopyList doesn't contain the new reference.
Returns:
The created Power Copy reference or NULL_var if failed.
o CreateUserFeature
public virtual CATIUdfFeature_var CreateUserFeature( const CATUnicodeString& iName) = 0
Creates a User Feature reference.
Role:After the creation, you use the CATIUdfFeature to fill the reference and at least you set it in the User Feature set thanks to CATIUdfFeatureSet.AppendFeature .
Use the GetFeatureSet method with 1 as argument to retrieve the set dedicated to the User Feature.
As long as the User Feature reference is not added in its specific set, it is not considered as a User Feature reference of the container: The list given by GetUserFeatureList doesn't contain the new reference.
Parameters:
iName
The name of the User Feature reference.
Returns:
The created User Feature reference or NULL_var if failed.
o GetDocumentTemplateList
public virtual CATListValCATISpecObject_var* GetDocumentTemplateList()= 0
Retrieves all Document Templates references.
Returns:
The list of Document Templates references added in the Knowledge Template set.
o GetFeatureSet
public virtual CATIUdfFeatureSet_var GetFeatureSet(int iMode=0) = 0
Retrieves the feature set.
Parameters:
iMode
0 : the set for Power Copy, 1 : the set for User Feature
Returns:
The feature set or NULL_var is failed.
o GetPowerCopyList
public virtual CATListValCATISpecObject_var* GetPowerCopyList()= 0
Retrieves all Power Copy references.
Returns:
The list of Power Copy references added in the Power Copy set.
o GetUserFeatureList
public virtual CATListValCATISpecObject_var* GetUserFeatureList()= 0
Retrieves all User Feature references.
Returns:
The list of User Feature references added in the User Feature set.

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

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