DbObjectId.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _ODDBOBJECTID_INCLUDED_
#define _ODDBOBJECTID_INCLUDED_ /* {Secret } */
 
#include "DbExport.h"
#include "DbHandle.h"
#include "OdError.h"
#include "TD_PackPush.h"
 
class OdDbDatabase;
class OdDbObject;
class OdRxClass;
 
template <class T> class OdSmartPtr;
 
typedef OdSmartPtr<OdDbObject> OdDbObjectPtr;
 
class OdDbStub;
class OdDbStubExt;
 
namespace OdDb
{
  enum OpenMode
  {
    kNotOpen           = -1,  // Object is not open.
    kForRead           = 0,   // Object is open for reading.
    kForWrite          = 1,   // Object is open for reading and/or writing.
    kForNotify         = 2    // Object is open for notify.
  };
 
  enum ReferenceType
  {
    kSoftPointerRef     = 0,  // Soft Pointer Reference
    kHardPointerRef     = 1,  // Hard Pointer Reference
    kSoftOwnershipRef   = 2,  // Soft Ownership Reference
    kHardOwnershipRef   = 3   // Hard Ownership Reference
  };
}
 
class TOOLKIT_EXPORT OdDbObjectId
{
public:
  OdDbObjectId () : m_Id (0) { }
 
  OdDbObjectId (
    OdDbStub* objectId) : m_Id (objectId) { }
 
  TOOLKIT_EXPORT_STATIC static const OdDbObjectId kNull;
 
  bool isNull () const { return m_Id == 0; }
 
  void setNull () { m_Id = 0; }
 
  bool isValid () const;
 
  // VS2015 requires to create copy constructor explicity
#if defined(_MSC_VER) && (_MSC_VER > 1800)
  OdDbObjectId(const OdDbObjectId& objectId) = default;
  OdDbObjectId& operator = (const OdDbObjectId& objectId) = default;
#endif
 
  OdDbObjectId& operator = (
    OdDbStub* objectId) { m_Id = objectId; return *this; }
 
  bool operator < (
    const OdDbObjectId& objectId) const;
 
  bool operator > (
    const OdDbObjectId& objectId) const;
 
  bool operator >= (
    const OdDbObjectId& objectId) const;
 
  bool operator <= (
    const OdDbObjectId& objectId) const;
 
  bool operator == (
    const OdDbObjectId& objectId) const;
 
  bool operator != (
    const OdDbObjectId& objectId) const;
 
  bool operator ! () const { return isNull(); }
 
  inline operator OdDbStub* () const { return (OdDbStub*)m_Id; }
 
  inline OdDbStubExt* operator -> () const { return (OdDbStubExt*)m_Id; }
 
  OdDbDatabase* database () const;
 
  OdDbDatabase* originalDatabase () const;
 
  void convertToRedirectedId ();
 
  bool isErased () const;
 
  bool isEffectivelyErased () const;
 
  bool objectLeftOnDisk () const;
 
  const OdDbHandle& getHandle () const;
 
  const OdDbHandle& getNonForwardedHandle () const;
 
  OdResult openObject (
    OdDbObjectPtr& pObj,
    OdDb::OpenMode openMode = OdDb::kForRead, 
    bool openErasedOne = false) const;
  OdDbObjectPtr openObject (
    OdDb::OpenMode openMode = OdDb::kForRead, 
    bool openErasedOne = false) const;
    OdDbObjectPtr safeOpenObject (
    OdDb::OpenMode openMode = OdDb::kForRead, 
    bool openErasedOne = false) const;
 
  void bindObject (
    OdDbObject* pObj);
 
  OdRxClass* objectClass() const;
 
protected:
  friend class OdDbStub;
  OdDbStub* m_Id;
};
 
class TOOLKIT_EXPORT OdDbHardOwnershipId : public OdDbObjectId
{
public:
 
  OdDbHardOwnershipId () {}
 
  OdDbHardOwnershipId (
    const OdDbObjectId& objectId) : OdDbObjectId (objectId) {}
 
  OdDbHardOwnershipId (
    OdDbStub* objectId) : OdDbObjectId (objectId) {}
 
  OdDbHardOwnershipId& operator = (
    const OdDbObjectId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
 
  OdDbHardOwnershipId& operator = (
    OdDbStub* objectId) { m_Id = objectId; return *this; }
 
  bool operator != (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator != (
    OdDbStub* objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator == (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator== (objectId); }
 
  bool operator == (
    OdDbStub* objectId) const { return OdDbObjectId::operator== (objectId); }
};
 
class TOOLKIT_EXPORT OdDbSoftOwnershipId : public OdDbObjectId
{
public:
 
  OdDbSoftOwnershipId () {}
 
  OdDbSoftOwnershipId (
    const OdDbObjectId& objectId) : OdDbObjectId (objectId) {}
 
  OdDbSoftOwnershipId (
    OdDbStub* objectId) : OdDbObjectId (objectId) {}
 
  OdDbSoftOwnershipId& operator = (
    const OdDbObjectId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
  OdDbSoftOwnershipId& operator = (
    OdDbStub* objectId) { m_Id = objectId; return *this; }
    
  bool operator != (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator != (
    OdDbStub* objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator == (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator== (objectId); }
 
  bool operator == (
    OdDbStub* objectId) const { return OdDbObjectId::operator== (objectId); }
 
};
 
class TOOLKIT_EXPORT OdDbHardPointerId : public OdDbObjectId
{
public:
 
  OdDbHardPointerId () {}
 
  OdDbHardPointerId (
    const OdDbObjectId& objectId) : OdDbObjectId (objectId) {}
 
  OdDbHardPointerId (
    OdDbStub* objectId) : OdDbObjectId (objectId) {}
 
  OdDbHardPointerId& operator = (
    const OdDbHardPointerId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
  OdDbHardPointerId& operator = (
    const OdDbObjectId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
  OdDbHardPointerId& operator = (
    OdDbStub* objectId) { m_Id = objectId; return *this; }
 
  bool operator != (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator != (
    OdDbStub* objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator == (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator== (objectId); }
 
  bool operator == (
    OdDbStub* objectId) const { return OdDbObjectId::operator== (objectId); }
};
 
class TOOLKIT_EXPORT OdDbSoftPointerId : public OdDbObjectId
{
public:
  OdDbSoftPointerId () {}
 
  OdDbSoftPointerId (
    const OdDbObjectId& objectId) : OdDbObjectId (objectId) {}
 
  OdDbSoftPointerId (
    OdDbStub* objectId) : OdDbObjectId (objectId) {}
 
  OdDbSoftPointerId& operator = (
    const OdDbSoftPointerId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
  OdDbSoftPointerId& operator = (
    const OdDbObjectId& objectId) { OdDbObjectId::operator= (objectId); return *this; }
 
  OdDbSoftPointerId& operator = (
    OdDbStub* objectId) { m_Id = (OdDbStub*)objectId; return *this; }
 
  bool operator != (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator != (
    OdDbStub* objectId) const { return OdDbObjectId::operator!= (objectId); }
 
  bool operator == (
    const OdDbObjectId& objectId) const { return OdDbObjectId::operator== (objectId); }
  bool operator == (
    OdDbStub* objectId) const { return OdDbObjectId::operator== (objectId); }
 
};
 
#include "TD_PackPop.h"
 
#endif //_ODDBOBJECTID_INCLUDED_