Bcf_3_0Archive.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_ARCHIVE_H
#define _BCF_3_0_ARCHIVE_H
 
#include "BcfCommon.h"
#include "BcfValidation.h"
#include "OdGUID.h"
#define STL_USING_MAP
#include "OdaSTL.h"

namespace OdBcf {
 
  class OdBcfArchiveFolder;
  typedef OdSmartPtr<OdBcfArchiveFolder> OdBcfArchiveFolderPtr;
}

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;
  
  typedef std::map<OdGUID, OdBcfTopicFolderPtr> OdBcfTopicFolderMap;
 
  class OdBcfSession;

  class BCF_3_0_EXPORT OdBcfArchive : public OdRxObject, public OdBcf::OdBcfValidation
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfArchive);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfArchive> createObject(
      const OdBcf::OdBcfArchiveFolderPtr &rootDir,
      const OdBcfExtensionsPtr       &pExtensions,
      const OdBcfVersionPtr          &pVersion,
      const OdBcfDocumentInfoPtr     &pDocumentInfo = OdBcfDocumentInfoPtr(),
      const OdBcfProjectInfoPtr      &pProjectInfo  = OdBcfProjectInfoPtr(),
      const OdBcfTopicFolderMap      &topics = OdBcfTopicFolderMap(),
      bool                                changed = false);

    OdBcfArchive();

    const OdBcf::OdBcfArchiveFolderPtr& getRootDir() const;

    bool isRootDirUnset() const;

    const OdBcfExtensionsPtr& getExtensions() const;

    bool isExtensionsUnset() const;

    const OdBcfVersionPtr& getVersion() const;

    bool isVersionUnset() const;

    void setDocumentInfo(const OdBcfDocumentInfoPtr& documentInfoValue);

    OdBcfDocumentInfoPtr& getDocumentInfo();

    const OdBcfDocumentInfoPtr& getDocumentInfo() const;

    bool isDocumentInfoUnset() const;

    void setProjectInfo(const OdBcfProjectInfoPtr &projectInfoValue);

    OdBcfProjectInfoPtr& getProjectInfo();

    const OdBcfProjectInfoPtr& getProjectInfo() const;

    bool isProjectInfoUnset() const;

    void setTopics(const OdBcfTopicFolderMap &topicsValue);

    OdBcfTopicFolderMap& getTopics();

    const OdBcfTopicFolderMap& getTopics() const;

    bool isTopicsUnset() const;

    const OdGUID& getArchiveGUID() const;

    bool isArchiveGUIDUnset() const;
 
  //DOM-IGNORE-BEGIN
  protected:
    OdBcfExtensionsPtr       m_pExtensions;
    OdBcfVersionPtr          m_pVersion;
    OdBcfDocumentInfoPtr     m_pDocumentInfo;
    OdBcfProjectInfoPtr      m_pProjectInfo;
    OdBcfTopicFolderMap      m_topics;
    OdGUID                       m_archiveGUID;
    OdBcf::OdBcfArchiveFolderPtr m_rootDir;
    bool                         m_changed;

    void setRootDir(const OdBcf::OdBcfArchiveFolderPtr &rootDirValue);

    void setExtensions(const OdBcfExtensionsPtr& extensionsValue);

    void setVersion(const OdBcfVersionPtr &versionValue);

    OdBcf::OdBcfArchiveFolderPtr& getRootDir();

    OdBcfExtensionsPtr& getExtensions();

    OdBcfVersionPtr& getVersion();

    virtual bool validateData() const ODRX_OVERRIDE;
 
    friend OdBcfSession;
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfArchive> OdBcfArchivePtr;

  typedef std::map<OdString, OdBcfArchivePtr> OdBcfArchiveMap;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_ARCHIVE_H