All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPDMBaseInterfaces Interface CATIPDMUECreate

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

Usage: you can freely reimplement this interface.


interface CATIPDMUECreate

Interface to allow the user to provide informations and allow Data customization when creating PDM Object from CATIA in the PDM Role: This interface is a user exit, that allows an user to provide informations and allow customization when creating Part and Document from CATIA in the PDM
You should implement it on the CATUEPDMCreate component by using the CATObject mechanism.


Method Index


o GetDocumentAttributesValue(CATDocument*,int&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,void**&,CATBoolean&)
Allow the user to valuate the Document attributes All mandattory attributes for Document creation in the PDM must be valuated
o GetDocumentAttributesValue(char*,int&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,void**&)
o GetDocumentEnvironment(CATDocument*,CATUnicodeString&,CATUnicodeString&)
Allow the user to give the name of the Environment and Table he wants its Document to be created in.
o GetDocumentEnvironment(char*,CATUnicodeString&,CATUnicodeString&)
o GetProductAttributesValue(CATBaseUnknown*,CATUnicodeString&,int&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,void**&,CATBoolean&)
Allow the user to valuate the Part attributes All mandattory attributes for Part creation in the PDM must be valuated
o GetProductAttributesValue(char*,int&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,void**&)
o GetProductEnvironment(CATBaseUnknown*,CATUnicodeString&,CATUnicodeString&)
Allow the user to give the name of the Environment/Domain he wants its Part to be created in.

Methods


o GetDocumentAttributesValue
public virtual HRESULT GetDocumentAttributesValue( const CATDocument* iDoc,
int& oNbAttr,
CATListOfCATUnicodeString& oAttrName,
CATListOfCATUnicodeString& oAttrType,
void**& oAttrValues,
CATBoolean& oCreateOrUpdate)=0
Allow the user to valuate the Document attributes All mandattory attributes for Document creation in the PDM must be valuated
Parameters:
iDoc
The document to create in the PDM number of attributes
oAttrName
List of the attributes name
oAttrType
List of the attributes type Allowed Type : Integer, Double, String, Boolean
oAttrValues
List of the attributes value oAttrName,oAttrType and oAttrValues are corresponding list TRUE : create a brand new part in VPM FALSE : Update a part in VPM. The COID and COMPID of the Document to Update must be provided in the Attribute List as First and Second Attribute.
Returns:
HRESULT Error code of function. S_OK : The Attributes list and values have been provided E_FAIL : Attributes list and values are incomplete, Document will not be created in PDM
o GetDocumentAttributesValue
public virtual HRESULT GetDocumentAttributesValue( const char* Filepath,
int& oNbAttr,
CATListOfCATUnicodeString& oAttrName,
CATListOfCATUnicodeString& oAttrType,
void**& oAttrValues)=0
Deprecated:
V5R16 Allow the user to valuate the Document attributes for creation All mandattory attributes for Document creation in the PDM must be valuated This method is used for documents not loaded or not in CATIA Format
Parameters:
Filepath
The path of the document to create in the PDM number of attributes
oAttrName
List of the attributes name
oAttrType
List of attributes type Allowed Type : Integer, Double, String, Boolean
oAttrValues
List of the attributes value oAttrName,oAttrType and oAttrValues are corresponding list
Returns:
HRESULT Error code of function. S_OK : The Attributes list and values have been provided E_FAIL : Attributes list and values are incomplete, Document will not be created in PDM
o GetDocumentEnvironment
public virtual HRESULT GetDocumentEnvironment( const CATDocument* iDoc,
CATUnicodeString& oEnv,
CATUnicodeString& oTable)=0
Allow the user to give the name of the Environment and Table he wants its Document to be created in.
Parameters:
iDoc
The document to create in the PDM
oEnv
The Environment/Domain the document must be created in
oTable
The Table the document must be created in can be used in others methods to make iObj treatment more simple
Returns:
HRESULT Error code of function. S_OK : The Environment and Table have been provided by the user exit E_FAIL : Environment and Table have not been provided, Document will not be created in PDM
o GetDocumentEnvironment
public virtual HRESULT GetDocumentEnvironment( const char* Filepath,
CATUnicodeString& oEnv,
CATUnicodeString& oTable)=0
Deprecated:
V5R16 Allow the user to give the name of the Environment and Table he wants its Document to be created in. This method is used for documents not loaded or not in CATIA Format
Parameters:
Filepath
The path of the document to create in the PDM
oEnv
The Environment/Domain the document must be created in
oTable
The Table the document must be created in can be used in others methods to make iObj treatment more simple
Returns:
HRESULT Error code of function. S_OK : The Environment and Table have been provided by the user exit E_FAIL : Environment and Table have not been provided, Document will not be created in PDM
o GetProductAttributesValue
public virtual HRESULT GetProductAttributesValue( const CATBaseUnknown* iObj,
const CATUnicodeString& iType,
int& oNbAttr,
CATListOfCATUnicodeString& oAttrName,
CATListOfCATUnicodeString& oAttrType,
void**& oAttrValues,
CATBoolean& oCreateOrUpdate)=0
Allow the user to valuate the Part attributes All mandattory attributes for Part creation in the PDM must be valuated
Parameters:
iObj
The CATIA object to create in the PDM (can be a CATDocument,an ASMPRODUCT,...)
iType
(optional) The Type of iObj provided by GetProductEnvironment method
oNbAttr
number of attributes
oAttrName
List of the attributes name
oAttrType
List of the attributes type Allowed Type : Integer, Double, String, Boolean
oAttrValues
List of the attributes value oAttrName,oAttrType and oAttrValues are corresponding list
oCreateOrUpdate
TRUE : create a brand new part in VPM FALSE : Update a part in VPM. The COID and COMPID of the part to Update must be provided in the Attribute List as First and Second Attribute.
Returns:
HRESULT Error code of function. S_OK : The Attributes list and values have been provided E_FAIL : Attributes list and values are incomplete, Part will not be created in PDM
o GetProductAttributesValue
public virtual HRESULT GetProductAttributesValue( const char* Filepath,
int& oNbAttr,
CATListOfCATUnicodeString& oAttrName,
CATListOfCATUnicodeString& oAttrType,
void**& oAttrValues)=0
Deprecated:
V5R16 Allow the user to valuate the part attributes All mandattory attributes for Part creation in the PDM must be valuated This method is used for documents not loaded or not in CATIA Format he wants its Document to be created in.
Parameters:
Filepath
The path of the document to create in the PDM
oNbAttr
number of attributes
oAttrName
List of the attributes name
oAttrType
List of the attributes type Allowed Type : Integer, Double, String, Boolean
oAttrValues
List of the attributes value oAttrName,oAttrType and oAttrValues are corresponding list
Returns:
HRESULT Error code of function. S_OK : The Attributes list and values have been provided E_FAIL : Attributes list and values are incomplete, Part will not be created in PDM
o GetProductEnvironment
public virtual HRESULT GetProductEnvironment( const CATBaseUnknown* iObj,
CATUnicodeString& oEnv,
CATUnicodeString& oType)=0
Allow the user to give the name of the Environment/Domain he wants its Part to be created in.
Parameters:
iObj
The CATIA object to create in the PDM (can be a CATDocument,an ASMPRODUCT,...)
oEnv
The Environment/Domain the Part must be created in
oType
(optional) The Type of iObj can be used in others methods to make iObj treatment more simple
Returns:
HRESULT Error code of function. S_OK : The Environment has been provided by the user exit E_FAIL : No Environment has been provided, Part will not be created in PDM

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

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