Bcf_3_0Session.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_SESSION_H
#define _BCF_3_0_SESSION_H
 
#include "BcfCommon.h"
#include "OdGUID.h"
#include "OdArray.h"
#define STL_USING_MAP
#define STL_USING_UTILITY
#include "OdaSTL.h"
 
class OdDbHostAppProgressMeter;

namespace OdBcf_3_0 {
 
  class OdBcfProjectData;
  class OdBcfProject;
  typedef OdSmartPtr<OdBcfProject> OdBcfProjectPtr;
 
  class OdBcfProjectInfo;
  typedef OdSmartPtr<OdBcfProjectInfo> OdBcfProjectInfoPtr;
 
  class OdBcfVersion;
  typedef OdSmartPtr<OdBcfVersion> OdBcfVersionPtr;
 
  class OdBcfCommentData;
  class OdBcfComment;
  typedef OdSmartPtr<OdBcfComment> OdBcfCommentPtr;
 
  class OdBcfTopicData;
  class OdBcfTopic;
  typedef OdSmartPtr<OdBcfTopic> OdBcfTopicPtr;
 
  class OdBcfMarkup;
  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;
 
  class OdBcfViewPoint;
  typedef OdSmartPtr<OdBcfViewPoint> OdBcfViewPointPtr;
  
  typedef OdArray<OdBcfViewPointPtr> OdBcfViewPointArray;
 
  class OdBcfComponent;
  typedef OdSmartPtr<OdBcfComponent> OdBcfComponentPtr;
  
  typedef OdArray<OdBcfComponentPtr> OdBcfComponentArray;
 
  class OdBcfViewSetupHints;
  typedef OdSmartPtr<OdBcfViewSetupHints> OdBcfViewSetupHintsPtr;
 
  class OdBcfComponentSelection;
  typedef OdSmartPtr<OdBcfComponentSelection> OdBcfComponentSelectionPtr;
 
  class OdBcfComponentVisibility;
  typedef OdSmartPtr<OdBcfComponentVisibility> OdBcfComponentVisibilityPtr;
 
  class OdBcfColor;
  typedef OdSmartPtr<OdBcfColor> OdBcfColorPtr;
 
  class OdBcfComponentColoring;
  typedef OdSmartPtr<OdBcfComponentColoring> OdBcfComponentColoringPtr;
 
  class OdBcfComponents;
  typedef OdSmartPtr<OdBcfComponents> OdBcfComponentsPtr;
 
  class OdBcfBitmapData;
  class OdBcfBitmap;
  typedef OdSmartPtr<OdBcfBitmap> OdBcfBitmapPtr;
 
  class OdBcfVisualizationInfoData;
  class OdBcfVisualizationInfo;
  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
  
  typedef OdArray<OdBcfVisualizationInfoPtr> OdBcfVisualizationInfoArray;
 
  class OdBcfTopicFolder;
  typedef OdSmartPtr<OdBcfTopicFolder> OdBcfTopicFolderPtr;
  
  typedef OdArray<OdBcfTopicFolderPtr> OdBcfTopicFolderArray;
 
  class OdBcfArchive;
  typedef OdSmartPtr<OdBcfArchive> OdBcfArchivePtr;
  typedef std::map<OdString, OdBcfArchivePtr> OdBcfArchiveMap;
 
  class OdBcfDataAccessor;
  typedef OdSmartPtr<OdBcfDataAccessor> OdBcfDataAccessorPtr;

  class BCF_3_0_EXPORT OdBcfSession : public OdRxObject
  {
  public:
 
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdBcfSession);
    //DOM-IGNORE-END

    static OdSmartPtr<OdBcfSession> createObject(
      const OdString &author,
      const OdString &authoringToolId,
      const OdBcfDataAccessorPtr &pDataAccessor = OdBcfDataAccessorPtr());
 
    //const OdBcfArchiveMap& loadProjects(OdResult *result = NULL);

    void setAuthor(const OdString& author);

    void setAuthoringToolId(const OdString& authoringToolId);

    OdResult setProgressMeter(OdDbHostAppProgressMeter* pMeter);

    void saveProject(
      const OdString &projectId, 
      const OdString &fileName = OdString(), 
      OdBcfDataAccessorPtr pDataAccessor = OdBcfDataAccessorPtr(), 
      OdResult *result = NULL);

    OdString loadProject(
      const OdString &fileName,
      OdBcfDataAccessorPtr pDataAccessor = OdBcfDataAccessorPtr(),
      OdResult *result = NULL);

    OdString addArchive(const OdBcfArchivePtr &pArchive, OdResult *result = NULL);

    OdBcfArchivePtr getArchive(const OdString &projectId, OdResult *result = NULL);

    bool validateArchive(const OdString &projectId, OdResult *result = NULL) const;

    OdBcfArchivePtr removeArchive(const OdString &projectId, OdResult *result = NULL);

    enum eSortParameter
    {
      kSortParameter_Guid = 0,
      kSortParameter_CreationDate,
      kSortParameter_ModifiedDate,
      kSortParameter_Index
    };

    OdBcfTopicFolderArray getTopics(const OdString &projectId, eSortParameter sortParameter = kSortParameter_Guid, OdResult *result = NULL);

    OdGUID addTopicFolder(const OdString &projectId, const OdBcfTopicFolderPtr& pTopicFolder, OdResult *result = NULL);

    static OdGUID getTopicId(const OdBcfTopicFolderPtr& pTopicFolder, OdResult* result = NULL);

    OdBcfTopicFolderPtr getTopicFolder(const OdString &projectId, const OdGUID &topicId, OdResult *result = NULL);

    void removeTopicFolder(const OdString &projectId, const OdGUID &topicId, OdResult *result = NULL);

    void addComment(const OdString& projectId, const OdGUID& topicId, const OdString& comment, const OdGUID& viewpointId = OdGUID(), OdResult* result = NULL);

    void editComment(const OdString& projectId, const OdGUID& topicId, const OdGUID& commentId, const OdString& comment, OdResult* result = NULL);

    void deleteComment(const OdString& projectId, const OdGUID& topicId, const OdGUID& commentId, OdResult* result = NULL);

    void addScreenshot(
      const OdString &projectId,
      const OdGUID &topicId,
      const OdString &fileName,
      const char *data,
      unsigned int size,
      OdResult *result = NULL);

    OdString getScreenshot(const OdString &projectId, const OdGUID &topicId, const OdString &fileName = OdString(), OdResult *result = NULL);

    OdBcfProjectInfoPtr createProjectInfo(const OdBcfProjectData *pProjectData, bool createManually = false, OdResult *result = NULL) const;

    OdBcfVersionPtr createVersion(OdResult *result = NULL) const;

    OdBcfTopicPtr createTopic(const OdString& projectId, const OdBcfTopicData *pTopicData, bool createManually = false, OdResult *result = NULL);

    OdBcfCommentPtr createComment(const OdBcfCommentData* pCommentData, OdResult* result = NULL) const;

    OdBcfViewSetupHintsPtr createViewSetupHints(OdResult *result = NULL) const;

    OdBcfComponentSelectionPtr createComponentSelection(
      const OdArray<OdString> &ifcGuids,
      const OdArray<OdString> &originatingSystems = OdArray<OdString>(),
      const OdArray<OdString> &authoringToolIds = OdArray<OdString>(),
      OdResult *result = NULL) const;

    OdBcfComponentVisibilityPtr createComponentVisibility(
      const OdArray<OdString> &ifcGuids, 
      const OdArray<OdString> &originatingSystems = OdArray<OdString>(),
      const OdArray<OdString> &authoringToolIds = OdArray<OdString>(),
      const OdBcfViewSetupHintsPtr &pViewSetupHints = OdBcfViewSetupHintsPtr(), 
      bool defaultVisibility = false, 
      OdResult *result = NULL) const;

    class ComponentColoring
    {
    public:
      OdArray<OdString> m_ifcGuids;
      
      OdArray<OdString> m_originatingSystems;
      
      OdArray<OdString> m_authoringToolIds;
      
      OdString          m_color;
    };

    typedef OdArray<ComponentColoring> ComponentColoringArray;

    OdBcfComponentColoringPtr createComponentColoring(const ComponentColoringArray &componentColoring, OdResult *result = NULL) const;

    OdBcfBitmapPtr createBitmap(const OdBcfBitmapData *pBitmapData, OdResult *result = NULL) const;

    OdBcfVisualizationInfoPtr createVisualizationInfo(
      const OdBcfVisualizationInfoData *pVisualizationInfoData, 
      const OdString &visInfoFileName,
      const OdString &screenshotFileName,
      OdBcfMarkupPtr pMarkup,
      OdInt32 viewPointIndex = OdBcf::Utils::getUnset<OdInt32>(),
      bool createManually = false,
      OdResult *result = NULL) const;

    void deleteViewpoint(const OdString& projectId, const OdGUID& topicId, const OdGUID& viewpointId, OdResult* result = NULL);
 
    //DOM-IGNORE-BEGIN
  protected:
    OdString                  m_author;
    OdString                  m_authoringToolId;
    OdBcfDataAccessorPtr      m_pDataAccessor;
    OdBcfArchiveMap           m_archives;
    OdDbHostAppProgressMeter *m_pMeter;
 
    const OdBcfComponentPtr createComponent(const OdString &ifcGuid, const OdString& originatingSystem, const OdString& authoringToolId) const;
    OdBcfComponentArray createComponents(const OdArray<OdString> &ifcGuids, const OdArray<OdString>& originatingSystems = OdArray<OdString>(), const OdArray<OdString>& authoringToolIds = OdArray<OdString>()) const;
    OdBcfColorPtr createColor(const OdString& color, const OdArray<OdString> &ifcGuids, const OdArray<OdString>& originatingSystems = OdArray<OdString>(), const OdArray<OdString>& authoringToolIds = OdArray<OdString>()) const;
 
    //DOM-IGNORE-END
  };

  typedef OdSmartPtr<OdBcfSession> OdBcfSessionPtr;
 
} //namespace OdBcf_3_0
 
#endif // _BCF_3_0_SESSION_H