PLMBatchDataAccessInterfaces CATPLMBatchXMLToolBox

Usage: you must use this class as is. You should never derive it.

public class CATPLMBatchXMLToolBox

Class to provide methods to decode V5 documents-PLM Components mapping existing in the input xml file as per the possible mapping formats (File-TST or TST-File).

Role: This class mainly Serves following purposes.

Method Index


o ReadPathQueryMappingFile(CATUnicodeString&,int&,CATUnicodeString&,CATLISTP(CATIAdpPLMIdentificator)&)
Decodes the input xml file where in the File-PLM kind of objects mapping exists.
o ReadQueryPathMappingFile(CATUnicodeString&,int&,CATIAdpPLMIdentificator*&,CATListOfCATUnicodeString&)
Decodes the input xml file where in the PLM-File kind of objects mapping exists.

Methods


o ReadPathQueryMappingFile
public static ReadPathQueryMappingFile( const iXmlFileName,
const irecnumber,
oPathOrigin,
oListofMappedPLMObject)
Decodes the input xml file where in the File-PLM kind of objects mapping exists.

Role: In a more global view, this service is dedicated to retrieve the mapping of V5 document to PLM Component(s) from the mapping xml file which is an input to this API. For eg. this API can be used to decode the mapping xml file which is an output of the PLMBatchFBDI batch application.
Sample of objects mapping in xml:
<ID_Object_Origin> Origin-V5-document
<ID_Object_Mapped> Mapped-PLM Component1 </ID_Object_Mapped>
<ID_Object_Mapped> Mapped-PLM Component2 </ID_Object_Mapped>
<ID_Object_Mapped> Mapped-PLM-Component3 </ID_Object_Mapped>
</ID_Object_Origin>
Parameters:
iXmlFileName
The full path of the xml file to be decoded.
irecnumber
The position of the record to decode [from 1 to the end].
oPathOrigin
Path of V5 document.
oListofMappedPLMObject
List of PLM Components mapped to oPathOrigin (V5 document). This list will be emptied before adding new data.
Returns:
S_OK
Mapping file successfully decoded.
E_FAIL
Mapping file could not be decoded. File doesnot exist, No read access or Not a valid format. OR
Either or both of the output parameters, oPathOrigin and oListofMappedPLMObject, is NULL.
S_FALSE
End of the scan. No more objects to decode (Application has to loop on the method until it reaches the end of the file).
E_INVALIDARG
  • Recnumber does not fit an object in the xml file.
  • iXmlFileName is null.
    • o ReadQueryPathMappingFile
    public static ReadQueryPathMappingFile( const iXmlFileName,
    const irecnumber,
    oPLMOrigin,
    oListofMappedPath)
    Decodes the input xml file where in the PLM-File kind of objects mapping exists.

    Role: In a more global view, this service is dedicated to retrieve the mapping of PLM Components to V5 document(s) from the mapping xml file which is an input to this API. For eg.this API can be used to decode the mapping xml file which is an output of the DownwardCompatibility batch application.
    Sample of objects mapping in xml:
    <ID_Object_Origin> Origin-PLM Component
    <ID_Object_Mapped> Mapped-V5-doc1 </ID_Object_Mapped>
    <ID_Object_Mapped> Mapped-V5-doc2 </ID_Object_Mapped>
    <ID_Object_Mapped> Mapped-V5-doc3 </ID_Object_Mapped>
    </ID_Object_Origin>
    Parameters:
    iXmlFileName
    The full path of the input mapping xml file that is to be decoded.
    irecnumber
    The position of the record to decode [from 1 to the end].
    oPLMOrigin
    PLM Component.
    oListofMappedPath
    List of V5 document(s) mapped to oPLMOrigin (PLM Component). This list will be emptied before adding new data.
    Returns:
    S_OK
    Mapping file successfully decoded.
    E_FAIL
    Mapping file could not be decoded. File does not exist, No read access or Not a valid format. OR
    Either or both of the output parameters, oPLMOrigin and oListofMappedPath, is NULL.
    S_FALSE
    End of the scan. No more objects to decode (Application has to loop on the method until it reaches the end of the file).
    E_INVALIDARG
  • Recnumber does not fit an object in the xml file.
  • iXmlFileName argument is null.
    • This object is included in the file: CATPLMBatchXMLToolBox.h
    If needed, your Imakefile.mk should include the module: CATPLMBatch

    Copyright © 1999-2014, Dassault Systèmes. All rights reserved.