igesw.hpp

Go to the documentation of this file.

#ifndef __IGESW_HPP__
#define __IGESW_HPP__
//! \brief Exported APIs for IGES (.igs) Write Library
namespace Igesw 
{
     class IgesMetaData
     {
     private:
          Dtk_string Startsection;
          Dtk_string ProductID;
          Dtk_string FileName;
          Dtk_string System;
          Dtk_string Preprocessor;
          Dtk_string UnitsName;
          Dtk_string UnitFlag;
          Dtk_string Author;
          Dtk_string Organisation;
     public:
          IgesMetaData();
          ~IgesMetaData();
          //! \brief Add Unit in StartSection 
          //! \param [in] inString : StartSection.
          void SetStartsection( const Dtk_string & inString );
          //! \brief Add Unit in ProductID in GlobalSection
          //! \param [in] inString : ProductID.
          void SetProductID( const Dtk_string & inString );
          //! \brief Add Unit in FileName in GlobalSection
          //! \param [in] inString : FileName.
          void SetFileName( const Dtk_string & inString );
          //! \brief Add Unit in System in GlobalSection
          //! \param [in] inString : System.
          void SetSystem( const Dtk_string & inString );
          //! \brief Add Unit in Preprocessor in GlobalSection
          //! \param [in] inString : Preprocessor.
          void SetPreprocessor( const Dtk_string & inString );
 
          //! \brief Add Unit in GlobalSection following iges norm 
          //! \param [in] inUnitsName : UnitName.
          //! \param [in] inUnitFlag : UnitFlag.
          //! \remark inGlobalSection.SetUnit( "INCH", "1" ); 
          //! \remark inGlobalSection.SetUnit( "MM", "2" ); 
          void SetUnit( const Dtk_string & inUnitsName, const Dtk_string & inUnitFlag );
          //! \brief Add Unit in Author in GlobalSection
          //! \param [in] inString : Author.
          void SetAuthor( const Dtk_string & inString );
          //! \brief Add Unit in Organisation in GlobalSection
          //! \param [in] inString : Organisation.
          void SetOrganisation( const Dtk_string & inString );
          Dtk_string GetStartsection();
          Dtk_string GetProductID();
          Dtk_string GetFileName();
          Dtk_string GetSystem();
          Dtk_string GetPreprocessor();
          Dtk_string GetUnitsName();
          Dtk_string GetUnitFlag();
          Dtk_string GetAuthor();
          Dtk_string GetOrganisation();
 
     };
    //! \brief Initialize the Iges Writer  
    //! \return dtkNoError if it is OK.
    //! \param [in] inOutputFile : Output file name
     //! \param [in] inLogFile : Log file
     //! \param [in] inHeaderInformations : StartSection and Global Section information
     //! \remark This function is the first call for the writer, it must me called after Dtk_API::StartAPI(...)
    DtkErrorStatus InitWrite(const Dtk_string& inOutputFile, const Dtk_string& inLogFile, IgesMetaData inHeaderInformations);
 
    //! \brief Creation of the output file and free the Iges Writer  
    //! \return dtkNoError if it is OK.
    //! \remark used as the last function used for the writer.
    DtkErrorStatus EndWrite();
 
    //! \brief Write an entity  
     //! \param [in] inEntity : The Entity to be written
     //! \param [in] inDependancyFlag : 0 for independant entities / 1 for entities to add in Prototype
     //! \param [out] outIndices : IDs of entity written
    //! \return dtkNoError if it is OK.
    //! \remark This function is used to write entities.
    Dtk_ErrorStatus WriteEntity(const Dtk_EntityPtr& inEntity,Dtk_Char8 inDependancyFlag,Dtk_tab<Dtk_ID> &outIndices);
 
 
     //! \brief Write a Prototype 308 subfigure entity  
     //! \param [in] inIndices : Entities IDs to add to 308
     //! \param [in] inProtoInfos : Prototype infos (Name ,Color , layer)
     //! \param [out] outProtoIndex : ID of 308 written
     //! \return dtkNoError if it is OK.
     Dtk_ErrorStatus WritePrototype(const Dtk_tab<Dtk_ID> &inIndices,const Dtk_InfoPtr &inProtoInfos, Dtk_ID &outProtoIndex);
 
 
     //! \brief Write a Instance 408 figure entity  
     //! \param [in] inProtoIndex : Prototype to be Instanciate
     //! \param [in] inPlacement : Matrix Placement
     //! \param [in] inInstanceInfos : Instance infos (Name ,Color , layer)
     //! \param [in] inDependancyFlag : 0 for independant instance  / 1 for instance to add in another Prototype
     //! \param [out] outInstanceIndex : ID of 308 written
     //! \return dtkNoError if it is OK.     
     Dtk_ErrorStatus InstanciatePrototype(Dtk_ID inProtoIndex,const Dtk_transfo &inPlacement,const Dtk_InfoPtr &inInstanceInfos,Dtk_Char8 inDependancyFlag,Dtk_ID &outInstanceIndex);
 
}
 
#endif