DbXrefGraph.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 _ODDBXREFGRAPH_H_INCLUDED_
#define _ODDBXREFGRAPH_H_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "DbGraph.h"
#include "DbObjectId.h"
#include "OdString.h"
 
namespace OdDb
{
  enum XrefStatus
  {
    kXrfNotAnXref     = 0,  // Not an Xref.
    kXrfResolved      = 1,  // Resolved.
    kXrfUnloaded      = 2,  // Unloaded.
    kXrfUnreferenced  = 3,  // Unreferenced.
    kXrfFileNotFound  = 4,  // File Not Found.
    kXrfUnresolved    = 5   // Unresolved.
  };  
}
 
class OdDbXrefGraphNode;
typedef OdSmartPtr<OdDbXrefGraphNode> OdDbXrefGraphNodePtr;
 
class TOOLKIT_EXPORT OdDbXrefGraphNode : public OdDbGraphNode
{
protected:
  OdDbXrefGraphNode() : m_status(OdDb::kXrfNotAnXref) {}
public:
 
  ODRX_DECLARE_MEMBERS(OdDbXrefGraphNode);
 
  virtual ~OdDbXrefGraphNode();
  
  OdString name() const { return m_sName; }
 
  OdDbObjectId blockId() const { return m_blockId; }
 
  OdDbDatabase* database() const { return (OdDbDatabase*)data(); }
  
  void setName(
    const OdString& name) { m_sName = name; }
    
  void setBlockId(
    OdDbObjectId blockId) { m_blockId = blockId; }
   
  void setDatabase(
    OdDbDatabase* pDb) { setData(pDb); }
  
  bool isNested() const { return !isMarkedAs(kFirstLevel); }
 
    OdDb::XrefStatus xrefStatus() const { return m_status; }
 
 
    void setXrefStatus(
    OdDb::XrefStatus xrefStatus) { m_status = xrefStatus; }
 
  
private:
  OdString          m_sName;
  OdDbObjectId      m_blockId;
  OdDb::XrefStatus  m_status;
  // OdDbDatabase* uses base class data() member
};
 
 
class TOOLKIT_EXPORT OdDbXrefGraph : public OdDbGraph
{
  OdDbXrefGraph(const OdDbXrefGraph&);
  OdDbXrefGraph& operator =(const OdDbXrefGraph&);
public:
  OdDbXrefGraph() {}
  virtual ~OdDbXrefGraph();
  
  OdDbXrefGraphNode* xrefNode(
    const OdString& name) const;
  
  OdDbXrefGraphNode* xrefNode(
    OdDbObjectId blockId) const;
  
  OdDbXrefGraphNode* xrefNode(
    const OdDbDatabase* pDb) const;
  
  OdDbXrefGraphNode* xrefNode(
    int nodeIndex) const { return(OdDbXrefGraphNode*)node(nodeIndex); }
    
    OdDbXrefGraphNode* hostDwg() const { return(OdDbXrefGraphNode*)rootNode(); }  
  bool markUnresolvedTrees();
  
  // cycle detection
  
  // virtual bool findCycles(OdDbGraphNode* pStart = 0);
 
  static void getFrom(
    OdDbDatabase* pDb, 
    OdDbXrefGraph& xrefGraph, 
    bool includeGhosts = false);
};
#include "TD_PackPop.h"
 
#endif // _ODDBXREFGRAPH_H_INCLUDED_