BcfDataAccessorXml.h

Go to the documentation of this file.

// Copyright (C) 2002-2020, 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-2020 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 _BFC_TOPIC_PROCESSOR_XML_H
#define _BFC_TOPIC_PROCESSOR_XML_H
 
#include "BcfCommon.h"
#define STL_USING_MAP
#include "OdaSTL.h"
 
#include "BcfDataAccessor.h"
 
namespace OdBcf {
 
  class OdBcfArchiveFolder;
  typedef OdSmartPtr<OdBcfArchiveFolder> OdBcfArchiveFolderPtr;
  typedef std::map<OdString, OdBcfArchiveFolderPtr> OdBcfArchiveFolderMap;
 
  class OdBcfVersion;
  typedef OdSmartPtr<OdBcfVersion> OdBcfVersionPtr;
 
  class OdBcfProjectExtension;
  typedef OdSmartPtr<OdBcfProjectExtension> OdBcfProjectExtensionPtr;
 
  class OdBcfTopicFolder;
  typedef OdSmartPtr<OdBcfTopicFolder> OdBcfTopicFolderPtr;
 
  class OdBcfTopic;
  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;
  typedef OdArray<OdBcfTopicPtr> OdBcfTopicArray;
 
  class OdBcfMarkup;
  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;
 
  class OdBcfVisualizationInfo;
  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
 
  class OdBcfArchive;
  typedef OdSmartPtr<OdBcfArchive> OdBcfArchivePtr;
 
  class BCF_EXPORT OdBcfDataAccessorXml : public OdBcfDataAccessor
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfDataAccessorXml);
    //DOM-IGNORE-END
 
    static OdSmartPtr<OdBcfDataAccessorXml> createObject(const OdString &folderPath);
 
    OdResult openProject(const OdString &projectName);
 
    OdResult closeProject(const OdString &projectName);
 
    virtual OdResult putArchive(const OdString &projectName, const OdBcfArchivePtr &pArchive) ODRX_OVERRIDE;
 
    bool projectOpened(const OdString &projectName) const;
 
    virtual OdBcfVersionPtr getVersion(const OdString &projectName, OdResult *result = NULL) ODRX_OVERRIDE;
 
    virtual OdBcfProjectExtensionPtr getProjectExtension(const OdString &projectName, OdResult *result = NULL) ODRX_OVERRIDE;
 
    virtual OdBcfTopicFolderPtr getTopic(const OdString &projectName, const OdString &topicId, OdResult *result = NULL) ODRX_OVERRIDE;
 
    virtual OdBcfMarkupPtr getMarkup(const OdString &projectName, const OdString &topicId, OdResult *result = NULL) ODRX_OVERRIDE;
 
    virtual OdBcfVisualizationInfoPtr getVisualizationInfo(
      const OdString &projectName, 
      const OdString &topicId, 
      const OdString &viewpoint = DEFAULT_VIEWPOINT_FILE_NAME, 
      OdResult *result = NULL) ODRX_OVERRIDE;
 
    virtual OdBcfTopicArray getTopics(const OdString &projectName, OdResult *result = NULL);
 
    virtual OdBcfArchivePtr getArchive(const OdString &projectName, OdResult *result = NULL) ODRX_OVERRIDE;
 
    //DOM-IGNORE-BEGIN
  protected:
    OdString              m_folderPath;
    OdBcfArchiveFolderMap m_openedProjects;
 
    OdString getExtractPath(const OdString &projectName) const;
    OdString getExtractProjectNameFromPath(const OdString &projectName) const;
    OdString getProjectWorkFolder(const OdString &projectName) const;
    //DOM-IGNORE-END
  };
 
  typedef OdSmartPtr<OdBcfDataAccessorXml> OdBcfDataAccessorXmlPtr;
 
} //namespace OdBcf
 
#endif // _BFC_TOPIC_PROCESSOR_XML_H