/////////////////////////////////////////////////////////////////////////////// 
// 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 _BCF_LOADER_H
#define _BCF_LOADER_H

#include "BcfCommon.h"
#include "BcfDataAccessor.h"

#include "BcfToolsModule.h"

/** \details
Contains declarations related to working with BCF files content.
*/
namespace OdBcfTools {

  /** \details
  A class that provides the interface for getting access to BCF data.
  */
  class BCFTOOLS_EXPORT OdBcfLoader
  {
  public:
    /** \details
    Opens a BCF XML file for interaction.
    \param projectName  [in] A string that contains the name of the BCF file.
    \param folderPath   [in] A string that contains the path to the directory with BCF files.
    \param version      [in] A variable that contains the user-defined version of the BCF file.
    \param result       [out] A raw pointer to a variable containing the result of the operation.
    \returns A smart pointer to the <exref target="../tifc_api_cpp/OdBcf__OdBcfDataAccessor.html">OdBcfDataAccessor</exref> for the project if the opening was successful; otherwise, the method returns null pointer.
    \remarks
    The method unpacks BCF data into the directory and determines BCF file version.
    If the version cannot be determined, the file is opened according to the version specified in the input parameter. In that case, correct operation cannot be guaranteed.
    */
    static OdBcf::OdBcfDataAccessorPtr openProject(const OdString& projectName, const OdString& folderPath = OdString(), BcfVersion version = kVersionBcfUndefined, OdResult* result = NULL);
  };

} //namespace OdBcfTools

#endif // _BCF_LOADER_H