/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef _ZIPIO_TRANSLATOR_STEPZIP_H_
#define _ZIPIO_TRANSLATOR_STEPZIP_H_

#include "ZipIOCommon.h"
#include "ZipIOTranslatorBase.h"
#define STL_USING_MAP
#include "OdaSTL.h"

namespace OdDAI {
  class Repository;
  typedef OdSmartPtr<Repository> RepositoryPtr;
}

namespace OdZipIO {

  /** \details
  A class that describes the interface for working with supported compressed STEP based file formats.
  */
  class ZIPIO_EXPORT OdZipIOTranslatorStepZip : public OdZipIOTranslatorBase
  {
  public:

    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdZipIOTranslatorStepZip);
    //DOM-IGNORE-END

    /** \details
    Creates a new Step Zip translator object.
    \param fileName  [in] A string that contains the original file name.
    \param fileCache [in] A pointer to structure containing already loaded files.
    \returns A smart pointer to the created <link OdZipIO::OdZipIOTranslatorStepZip, OdZipIOTranslatorStepZip> instance.
    */
    static OdSmartPtr<OdZipIOTranslatorStepZip> createObject(const OdString& fileName, std::map<OdString, OdDAI::RepositoryPtr>* fileCache = nullptr);

    /** \details
    Serializes the repository into file of supported format.
    \param folderName [in] A string that contains path to the destination folder.
    \param repo       [in] A pointer to the repository containing data.
    \returns eOk if the file was successfully saved; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult serialize(const OdString &folderName, OdDAI::Repository *repo) ODRX_OVERRIDE;

    /** \details
    Deserializes the repository from file of supported format.
    \param folderName [in] A string that contains path to the folder with the file.
    \param repo       [out] A pointer to the resulting repository.
    \returns eOk if the file was successfully loaded; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult deserialize(const OdString &folderName, OdDAI::Repository *repo) ODRX_OVERRIDE;

    //DOM-IGNORE-BEGIN
  private:
    OdString m_fileName;
    std::map<OdString, OdDAI::RepositoryPtr>* m_fileCache;
    //DOM-IGNORE-END
  };
  typedef OdSmartPtr<OdZipIOTranslatorStepZip> OdZipIOTranslatorStepZipPtr;

} //namespace OdZipIO

#endif // _ZIPIO_TRANSLATOR_STEPZIP_H_