xmtw_psk.hpp

Go to the documentation of this file.

#ifndef __INIT_WRITE_XMT
#define __INIT_WRITE_XMT
 
//! \brief Exported APIs for XMT Write Library
namespace xmtw
{
 
     //! \brief Initialize the Parasolid Writer  
     //! \return dtkNoError if it is OK.
    //! \param [in] inFileName : Output file
     //! \param [in] inLogFile : Log file
     //! \param [in] inLicFct : License function or Null
    //! \param [in] inMode : Internal use
    //! \remark This is the first function called for the writer.
    //! \remark : If you don't need to write a parasolid file on the disc, set inFileName to ""
     Dtk_ErrorStatus InitWrite(const Dtk_string &inFileName, const Dtk_string& inLogFile,const Dtk_string &inSchemaPath,Licence_dtk inLicFct,Dtk_Int32 inMode =0 );
    //! \brief Write the entity provided in parameter.and generates a parasolid file 
    //! \param [in] inEntity : The Entity to be written
    //! \param [in] inFileName : The name of the parasolid file
    //! \param [in] inType : 'T' (default) : text file (x_t), 'B' : binary file (x_b)
    //! \param [in] inTransmitversion : Parasolid file version
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities groups in a file and not in memory.
    DtkErrorStatus WriteEntity( const Dtk_EntityPtr &inEntity, Dtk_string &inFileName,Dtk_Char8 inType = 'T',Dtk_Int32 inTransmitversion=100);
    //! \brief Write the entity provided in parameter. 
    //! \param [in] inEntity : The Entity to be written
    //! \param [out] outTabIds : Corresponding parasolid identifiers
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities groups in the PSKERNEL session.
    Dtk_ErrorStatus WriteEntity(const Dtk_EntityPtr& inEntity, Dtk_tab<Dtk_ID> &outTabIds);
    //! \brief Write the entity provided in parameter using given sewing tolerances. 
    //! \param [in] inEntity : The Entity to be written
    //! \param [out] outTabIds : Corresponding parasolid identifiers
    //! \param [in] bSewing : Option to sew bodies
    //! \param [in] tolmin : Minimum sewing tolerance (in mm)
    //! \param [in] tolmax : Maximum sewing tolerance (in mm)
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities groups in the PSKERNEL session.
    //! \remark This function is deprecated. Please use the following one
    Dtk_ErrorStatus WriteBodies(const Dtk_tab<Dtk_BodyPtr> &bodies, Dtk_tab<Dtk_ID> &outTabIds,  
                                Dtk_bool bSewing = DTK_TRUE,  
                                Dtk_Double64 tolmin = 0.01,  
                                Dtk_Double64 tolmax = 0.05);
    //! \brief Write the entity provided in parameter using given sewing tolerances. 
    //! \param [in] inEntity : The Entity to be written
    //! \param [out] outTabIds : Corresponding parasolid identifiers
    //! \param [in] inSewing  : Option to sew bodies
    //! \param [in] intTolmin : Minimum sewing tolerance (in mm)
    //! \param [in] inTolmax : Maximum sewing tolerance (in mm)
    //! \param [in] inIterationNumber : number of sewing iterations 
    //!             ( 1 : using min tolerance, > 1 : iterating between min and max tolerances, 0 : calling default sewing method)
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities groups in the PSKERNEL session.
    DtkErrorStatus  WriteBodies(const Dtk_tab<Dtk_BodyPtr> &bodies, Dtk_tab<Dtk_ID> &outTabIds, 
                                Dtk_bool inSewing = DTK_TRUE, 
                                Dtk_Double64 intTolmin = 0.01, 
                                Dtk_Double64 inTolmax = 0.05, 
                                Dtk_Int32 inIterationNumber = 3);
 
    //! \brief Adds identifiers for writing in output parasolid file
    //! \param [in] inTabIDs : Entities identifiers to be written
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to transmit identifiers before creation of parasolid file.
    Dtk_ErrorStatus AddIds(Dtk_tab<Dtk_ID> &inTabIDs);
    //! \brief Creation of the output file and free the Parasolid Writer  
    //! \param [in] inMode : 'T' (default) : text file (x_t), 'B' : binary file (x_b)
    //! \param [in] inTransmitversion : Parasolid file version
    //! \return dtkNoError if it is OK.
    //! \remark used as the last function used for the writer.
    Dtk_ErrorStatus EndWrite(const Dtk_UChar8 &inMode='T',Dtk_Int32 inTransmitversion=100);
    //! \brief Set inValue = -1 if you ever start a parasolid Session  
    //! \remark to be called before InitWrite and after StartAPI
    void SetIsAlreadyStart(const Dtk_Int32& inValue);
 
 
}
 
 
#endif