daiObjectId.h

Go to the documentation of this file.

// Copyright (C) 2002-2019, 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-2019 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 _DAI_OBJECT_ID_H_
#define _DAI_OBJECT_ID_H_
 
#include "RxObject.h"
#include "DbHandle.h"
#include "daiBuildOptions.h"
#include "daiEntityInstance.h"
 
template <class T> class OdSmartPtr;
 
namespace OdDAI {
  class EntityInstanceWrapper;
  typedef OdSmartPtr<EntityInstanceWrapper> EntityInstanceWrapperPtr;
}
 
class OdDbStub;
 
namespace OdDAI {
 
  enum OpenMode {
    //kForInitializing = -2,
    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 notifying.
  };
 
}
 
typedef OdRxObject OdDbBaseDatabase;
 
  class DAI_EXPORT OdDAIObjectId {
  public:
 
    typedef OdDbHandle handle_type;
 
    DAI_EXPORT_STATIC static const OdDAIObjectId kNull;                     // A NULL object identifier.
    DAI_EXPORT_STATIC static const handle_type kNullHandle;                 // A NULL object database handle.
 
    OdDAIObjectId();
    
    OdDAIObjectId(OdDbStub* objectId);
    
    bool isNull() const;
 
    void setNull();
    
    bool isValid() const;
 
    OdDAIObjectId& operator=(const OdDAIObjectId& objectId);
    
    OdDAIObjectId& operator=(OdDbStub* objectId);
 
    bool operator<(const OdDAIObjectId& objectId) const;
    
    bool operator>(const OdDAIObjectId& objectId) const;
    
    bool operator>=(const OdDAIObjectId& objectId) const;
    
    bool operator<=(const OdDAIObjectId& objectId) const;
    
    bool operator==(const OdDAIObjectId& objectId) const;
    
    bool operator!=(const OdDAIObjectId& objectId) const;
    
    
    bool operator!() const { return isNull(); }
 
    inline operator OdDbStub*() const { return m_Id; }
 
    inline OdDbStub* operator->() const {
      return reinterpret_cast<OdDbStub*>(m_Id);
    }
 
    OdDbBaseDatabase* model() const;
 
    void erase() const;
 
    bool isErased() const;
 
    const OdDbHandle& getHandle() const;
 
    OdDAI::EntityInstancePtr openObject(OdDAI::OpenMode openMode = OdDAI::kForRead,
      bool openErasedOne = false) const;
    
    OdDAI::EntityInstancePtr get() const;
 
//DOM-IGNORE-BEGIN
  protected:
 
    OdDbStub* id() const;
    friend class OdDbStub;
    OdDbStub* m_Id;
//DOM-IGNORE-END
  };
  
  typedef OdArray<OdDAIObjectId> OdDAIObjectIds;
 
#endif // _DAI_OBJECT_ID_H_