DbXrecord.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 ODDB_XRECORD_H
#define ODDB_XRECORD_H 
#include "TD_PackPush.h"
 
//#define ODDB_XRECORD_CLASS          "OdDbXrecord"
 
#include "DbObject.h"
#include "DbFiler.h"
 
class OdDbXrecordIteratorImpl;
 
class TOOLKIT_EXPORT OdDbXrecordIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbXrecordIterator);
 
    void start();
 
    bool done() const;
 
   bool next();
  
  int curRestype() const;
  
  OdResBufPtr getCurResbuf(OdDbDatabase* pDb = 0) const;
protected:
  OdDbXrecordIterator(
    OdDbXrecordIteratorImpl* pIterImpl);
  OdDbXrecordIteratorImpl* m_pImpl;
};
 
typedef OdSmartPtr<OdDbXrecordIterator> OdDbXrecordIteratorPtr;
 
 
class TOOLKIT_EXPORT OdDbXrecord : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbXrecord);
 
  OdDbXrecord();
 
  OdResBufPtr rbChain(
    OdDbDatabase* pDb = 0, 
    OdResult* pStatus = 0) const;
 
  OdDbXrecordIteratorPtr newIterator(
    OdDbDatabase* pDb = 0) const;
 
  OdResult setFromRbChain(const OdResBuf* pRb, OdDbDatabase* pDb = 0);
  
  OdResult appendRbChain(
    const OdResBuf* pRb, 
    OdDbDatabase* pDb = 0);
 
  bool isXlateReferences() const;
 
  void setXlateReferences(
    bool isXlateReferences);
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
  
  virtual OdDb::DuplicateRecordCloning mergeStyle() const;
 
  virtual void setMergeStyle(
    OdDb::DuplicateRecordCloning mergeStyle);
  
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  enum
  {
    kOpenExisting     = 0,
    kCreateIfNotFound = 1
  };
 
  static OdDbXrecordPtr open(OdDbObject* pObject, const OdString &key,
    int creationFlag = kOpenExisting,
    OdDb::DuplicateRecordCloning mergeStyle = OdDb::kDrcIgnore);
 
  static OdDbXrecordPtr open(OdDbObject* pObject, const OdArray<OdString> &keys,
    int creationFlag = kOpenExisting,
    OdDb::DuplicateRecordCloning mergeStyle = OdDb::kDrcIgnore);
};
 
#include "TD_PackPop.h"
 
#endif //ODDB_XRECORD_H