OdTraceRuntime.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 _ODTraceRuntime_h_Included_
#define _ODTraceRuntime_h_Included_
 
#include "TD_PackPush.h"
#include "RxDefs.h"
#include "DbDatabase.h"
#include "TraceStorage/DbTraceStore.h"
 
class OdDbTraceRuntimeObject;
class OdTraceRuntime;
typedef OdDbDate(*OdTraceDateFunc)();

OdTraceDateFunc OD_DLL_EXPORT odSetTraceDateFunc(OdTraceDateFunc traceDateFunc);

struct OdTraceCollaborator
{
private:
  OdString m_firstName;
  OdString m_lastName;
  OdString m_userName;
  //DOM-IGNORE-BEGIN
  OdString m_traceFile;//internal use
  OdString m_oxygenID; //internal use. String containing the user unique hash code
  //DOM-IGNORE-END
  OdDb::Visibility m_visibility = OdDb::kVisible;
 
  //DOM-IGNORE-BEGIN
  OdTraceCollaborator() = delete;
  OdTraceCollaborator(const OdString& firstName, const OdString& lastName, const OdString& userName, const OdString& traceFile, const OdString oxygenID, const OdDb::Visibility visibility)
    : m_firstName(firstName), m_lastName(lastName), m_userName(userName), m_traceFile(traceFile), m_oxygenID(oxygenID), m_visibility(visibility) {}
  //DOM-IGNORE-END
public:
  void     setVisible(const OdDb::Visibility visibility){ m_visibility = visibility; }

  OdDb::Visibility isVisible()    const { return m_visibility; }

  OdString getFirstName() const { return m_firstName; }

  OdString getLastName()  const { return m_lastName;  }

  OdString getUserName()  const { return m_userName;  }

  OdString getTraceFile()  const { return m_traceFile; }

  OdString getOxygenId()   const { return m_oxygenID; }
 
  //DOM-IGNORE-BEGIN
  friend class OdDbTraceRuntimeObject;
  //DOM-IGNORE-END
};

class OD_DLL_EXPORT OdTraceRuntime
{
public:
   OdResult appendDwgAsTrace(const OdString& sPath2DwgFileAsTrace, OdString& traceName);

   OdResult appendDwgAsTrace(OdDbDatabase* pDbTrace, OdString& traceName);

  OdResult newTrace();

   OdResult openTrace(const OdTraceUserInfo& traceInfo);

   OdResult renameTrace(const OdTraceUserInfo& trace, const OdString& newTraceName);

   OdResult removeTrace(const OdTraceUserInfo& traceInfo);

   OdResult removeSubTrace(const OdTraceUserInfo& traceInfo, const OdTraceCollaborator& subTrace);

   OdResult closeTrace();

   OdResult traceFront() const;

   OdResult traceBack() const;

   OdResult getOpenTraceCollaborators(OdArray<OdTraceCollaborator>& traceCollaborators) const;

   OdResult getTraceCollaborators(const OdTraceUserInfo& trace, OdArray<OdTraceCollaborator>& traceCollaborators) const;

   OdResult showOpenTraceCollaborators(const OdArray<OdTraceCollaborator>& traceCollaborators) const;

   OdResult getTracesUserInfo(OdArray<OdTraceUserInfo>& userInfoArr) const;

   bool isObjectFromTrace(const OdDbObject* pSubject) const;
public:
   OdResult setCurrentUserInfo(const OdTraceUserProfile& currentUserInfo);

   OdTraceUserProfile getCurrentUserInfo() const;

   OdResult getOpenTraceExtents(OdGeExtents3d&) const;

   static OdTraceRuntime* getInstance(OdDbDatabase* pDb, const bool bCreateIfNotFound = false);

   OdDbObjectId getTraceRuntimeId() const;
   
   //DOM-IGNORE-BEGIN
   virtual  ~OdTraceRuntime();
   //DOM-IGNORE-END
protected:
  OdTraceRuntime(OdDbDatabase*, const bool);

  OdTraceRuntime() = delete;
  
  //DOM-IGNORE-BEGIN
  OdDbObjectId m_traceRuntimeId;
 
  //DOM-IGNORE-END
};
 
#include "TD_PackPop.h"
 
#endif