Bcf_3_0DataAccessor.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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_3_0_DATA_ACCESSOR_H
#define _BCF_3_0_DATA_ACCESSOR_H
 
#include "BcfCommon.h"
#include "BcfDataAccessor.h"

namespace OdBcf_3_0 {
 
  class OdBcfExtensions;
  typedef OdSmartPtr<OdBcfExtensions> OdBcfExtensionsPtr;
 
  class OdBcfVersion;
  typedef OdSmartPtr<OdBcfVersion> OdBcfVersionPtr;
 
  class OdBcfDocumentInfo;
  typedef OdSmartPtr<OdBcfDocumentInfo> OdBcfDocumentInfoPtr;
 
  class OdBcfProjectInfo;
  typedef OdSmartPtr<OdBcfProjectInfo> OdBcfProjectInfoPtr;
 
  class OdBcfTopicFolder;
  typedef OdSmartPtr<OdBcfTopicFolder> OdBcfTopicFolderPtr;
 
  class OdBcfMarkup;
  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;
 
  class OdBcfVisualizationInfo;
  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
 
  class OdBcfArchive;
  typedef OdSmartPtr<OdBcfArchive> OdBcfArchivePtr;

  class BCF_3_0_EXPORT OdBcfDataAccessor : public OdBcf::OdBcfDataAccessor
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfDataAccessor);
    //DOM-IGNORE-END

    virtual OdString getBcfFileVersion() const ODRX_OVERRIDE;

    virtual OdResult putArchive(const OdString &projectName, const OdBcfArchivePtr &pArchive) = 0;

    virtual OdResult setProgressMeter(OdDbHostAppProgressMeter* pMeter) = 0;

    virtual OdBcfExtensionsPtr getExtensions(const OdString& projectName, OdResult* result = NULL) = 0;

    virtual OdBcfVersionPtr getVersion(const OdString &projectName, OdResult *result = NULL) = 0;

    virtual OdBcfDocumentInfoPtr getDocumentInfo(const OdString& projectName, OdResult* result = NULL) = 0;

    virtual OdBcfProjectInfoPtr getProjectInfo(const OdString &projectName, OdResult *result = NULL) = 0;

    virtual OdBcfTopicFolderPtr getTopic(const OdString &projectName, const OdString &topicId, OdResult *result = NULL) = 0;

    virtual OdBcfMarkupPtr getMarkup(const OdString &projectName, const OdString &topicId, OdResult *result = NULL) = 0;

    virtual OdBcfVisualizationInfoPtr getVisualizationInfo(
      const OdString &projectName, 
      const OdString &topicId, 
      const OdString &viewpoint = DEFAULT_VIEWPOINT_FILE_NAME,
      OdResult *result = NULL) = 0;

    virtual OdBcfArchivePtr getArchive(const OdString &projectName, OdResult *result = NULL) = 0;
  };

  typedef OdSmartPtr<OdBcfDataAccessor> OdBcfDataAccessorPtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_DATA_ACCESSOR_H