OdDbXrefGraph Class Reference

#include <DbXrefGraph.h>

Inheritance diagram for OdDbXrefGraph:

Public Member Functions
	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
OdDbXrefGraphNode *	hostDwg () const
bool	markUnresolvedTrees ()
Public Member Functions inherited from OdDbGraph
	OdDbGraph ()
virtual	~OdDbGraph ()
OdDbGraphNode *	node (int nodeIndex) const
OdDbGraphNode *	rootNode () const
int	numNodes () const
bool	isEmpty () const
void	addNode (OdDbGraphNode *pNode)
void	addEdge (OdDbGraphNode *pFrom, OdDbGraphNode *pTo)
void	delNode (OdDbGraphNode *pNode)
void	reset ()
void	clearAll (OdUInt8 flags)
void	getOutgoing (OdDbGraphNodeArray &outgoing)
virtual bool	findCycles (OdDbGraphNode *pStart=0)
void	breakCycleEdge (OdDbGraphNode *pFrom, OdDbGraphNode *pTo)

Static Public Member Functions
static void	getFrom (OdDbDatabase *pDb, OdDbXrefGraph &xrefGraph, bool includeGhosts=false)

Additional Inherited Members
Protected Member Functions inherited from OdDbGraph
void	clearAllCycles ()

Detailed Description

This class is a derived class for representing the Xref tree of a database.

Remarks

This class uses XrefGraphNode objects to represent an Xref database at each node.

See also

OdDbGraph OdDbGraphStack OdDbXrefGraph OdDbXrefGraphNode

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 194 of file DbXrefGraph.h.

Constructor & Destructor Documentation

OdDbXrefGraph()

OdDbXrefGraph::OdDbXrefGraph ( )

inline

Definition at line 199 of file DbXrefGraph.h.

~OdDbXrefGraph()

virtual OdDbXrefGraph::~OdDbXrefGraph ( )

virtual

Member Function Documentation

getFrom()

static void OdDbXrefGraph::getFrom ( OdDbDatabase *  pDb, OdDbXrefGraph &  xrefGraph, bool  includeGhosts = false  )

static

Populate the specified XrefGraph object with the Xref tree of the specified database.

Parameters

pDb	[in] Pointer to the database.
xrefGraph	[out] Receives the Xref tree.
includeGhosts	[in] Ignored.

Remarks

xrefGraph is reset at the start of this function.

hostDwg()

OdDbXrefGraphNode* OdDbXrefGraph::hostDwg ( ) const

inline

Returns the XrefGraphNode associated with the host drawing of this XrefGraph object.

Remarks

Returns rootNode().

Definition at line 264 of file DbXrefGraph.h.

markUnresolvedTrees()

bool OdDbXrefGraph::markUnresolvedTrees

(

)

Marks the unresolved Xrefs in this XrefGraph object, and their nested Xrefs, with the kUnresTree flag.

Remarks

Not implemented, reserved. Returns true if and only if there are any unresolved Xrefs.

xrefNode() [1/4]

OdDbXrefGraphNode* OdDbXrefGraph::xrefNode

(

const OdDbDatabase *

pDb

)

const

Returns the XrefGraphNode object corresponding to the specified parameter.

Parameters

pDb	[in] Pointer to the database.

Returns

Return a null pointer if the specified node is not found.

Remarks

getFrom() will populate an XrefGraph object with the Xref tree of a specified database.

xrefNode() [2/4]

OdDbXrefGraphNode* OdDbXrefGraph::xrefNode

(

const OdString &

name

)

const

Returns the XrefGraphNode object corresponding to the specified parameter.

Parameters

name	[in] Name.

Returns

Return a null pointer if the specified node is not found.

Remarks

getFrom() will populate an XrefGraph object with the Xref tree of a specified database.

xrefNode() [3/4]

OdDbXrefGraphNode* OdDbXrefGraph::xrefNode ( int  nodeIndex ) const

inline

Returns the XrefGraphNode object corresponding to the specified parameter.

Parameters

nodeIndex

[in] Node index.

Returns

Return a null pointer if the specified node is not found.

Remarks

getFrom() will populate an XrefGraph object with the Xref tree of a specified database.

Definition at line 255 of file DbXrefGraph.h.

xrefNode() [4/4]

OdDbXrefGraphNode* OdDbXrefGraph::xrefNode

(

OdDbObjectId

blockId

)

const

Returns the XrefGraphNode object corresponding to the specified parameter.

Parameters

blockId

[in] Object ID of BlockTableRecord.

Returns

Return a null pointer if the specified node is not found.

Remarks

getFrom() will populate an XrefGraph object with the Xref tree of a specified database.

---

The documentation for this class was generated from the following file:

• DbXrefGraph.h