OdDbXrefGraphNode Class Reference

#include <DbXrefGraph.h>

Inheritance diagram for OdDbXrefGraphNode:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbXrefGraphNode)
virtual	~OdDbXrefGraphNode ()
OdString	name () const
OdDbObjectId	blockId () const
OdDbDatabase *	database () const
void	setName (const OdString &name)
void	setBlockId (OdDbObjectId blockId)
void	setDatabase (OdDbDatabase *pDb)
bool	isNested () const
OdDb::XrefStatus	xrefStatus () const
void	setXrefStatus (OdDb::XrefStatus xrefStatus)
Public Member Functions inherited from OdDbGraphNode
	OdDbGraphNode ()
	ODRX_DECLARE_MEMBERS (OdDbGraphNode)
virtual	~OdDbGraphNode ()
void *	data () const
void	setData (void *pData)
int	numOut () const
int	numIn () const
OdDbGraphNode *	in (int refIndex) const
OdDbGraphNode *	out (int refIndex) const
void	addRefTo (OdDbGraphNode *pTo)
void	removeRefTo (OdDbGraphNode *pNode)
void	disconnectAll ()
OdDbGraph *	owner () const
bool	isMarkedAs (OdUInt8 flags) const
void	markAs (OdUInt8 flags)
void	clear (OdUInt8 flags)
void	markTree (OdUInt8 flags, OdDbGraphNodeArray *pNodeArray=0)
int	numCycleOut () const
int	numCycleIn () const
OdDbGraphNode *	cycleIn (int refIndex) const
OdDbGraphNode *	cycleOut (int refIndex) const
OdDbGraphNode *	nextCycleNode () const
bool	isCycleNode () const
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdDbXrefGraphNode ()

Additional Inherited Members
Public Types inherited from OdDbGraphNode
enum	Flags {   kNone = 0x00 , kVisited = 0x01 , kOutsideRefed = 0x02 , kSelected = 0x04 ,   kInList = 0x08 , kListAll = 0x0E , kFirstLevel = 0x10 , kUnresTree = 0x20 ,   kAll = 0x2F }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class is a derived class for representing an Xref database.

Remarks

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

See also

OdDbGraph OdDbGraphStack OdDbXrefGraph OdDbXrefGraphNode

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 74 of file DbXrefGraph.h.

Constructor & Destructor Documentation

OdDbXrefGraphNode()

OdDbXrefGraphNode::OdDbXrefGraphNode ( )

inlineprotected

Definition at line 77 of file DbXrefGraph.h.

~OdDbXrefGraphNode()

virtual OdDbXrefGraphNode::~OdDbXrefGraphNode ( )

virtual

Member Function Documentation

blockId()

OdDbObjectId OdDbXrefGraphNode::blockId ( ) const

inline

Returns the Object ID of the BlockTableRecord associated with this XrefGraphNode object.

Definition at line 92 of file DbXrefGraph.h.

database()

OdDbDatabase * OdDbXrefGraphNode::database ( ) const

inline

Returns the database relevent to this XrefGraphNode object.

Definition at line 97 of file DbXrefGraph.h.

isNested()

bool OdDbXrefGraphNode::isNested ( ) const

inline

Returns true if and only if this XrefGraphNode represents an Xref that is not directly referenced by the host drawing.

Definition at line 127 of file DbXrefGraph.h.

name()

OdString OdDbXrefGraphNode::name ( ) const

inline

Returns the name associated with this XrefGraphNode object.

Definition at line 87 of file DbXrefGraph.h.

ODRX_DECLARE_MEMBERS()

OdDbXrefGraphNode::ODRX_DECLARE_MEMBERS

(

OdDbXrefGraphNode

)

setBlockId()

void OdDbXrefGraphNode::setBlockId ( OdDbObjectId  blockId )

inline

Sets the Object ID of the BlockTableRecord associated with this XrefGraphNode object.

Parameters

blockId

[in] Object ID of BlockTableRecord.

Definition at line 112 of file DbXrefGraph.h.

setDatabase()

void OdDbXrefGraphNode::setDatabase ( OdDbDatabase *  pDb )

inline

Sets the database relevent to this XrefGraphNode object.

Parameters

pDb	[in] Pointer to the database.

Definition at line 120 of file DbXrefGraph.h.

setName()

void OdDbXrefGraphNode::setName ( const OdString &  name )

inline

Sets the name associated with this XrefGraphNode object.

Parameters

name	[in] Name.

Definition at line 104 of file DbXrefGraph.h.

setXrefStatus()

void OdDbXrefGraphNode::setXrefStatus ( OdDb::XrefStatus  xrefStatus )

inline

Sets the status for this XrefGraphNode object.

Remarks

xrefStatus must be one of the following:

Value Description OdDb::kXrfNotAnXref 0 Not an Xref. OdDb::kXrfResolved 1 Resolved. OdDb::kXrfUnloaded 2 Unloaded. OdDb::kXrfUnreferenced 3 Unreferenced. OdDb::kXrfFileNotFound 4 File Not Found. OdDb::kXrfUnresolved 5 Unresolved.

Definition at line 166 of file DbXrefGraph.h.

xrefStatus()

OdDb::XrefStatus OdDbXrefGraphNode::xrefStatus ( ) const

inline

Returns the status for this XrefGraphNode object.

Remarks

xrefStatus() returns one of the following:

Value Description OdDb::kXrfNotAnXref 0 Not an Xref. OdDb::kXrfResolved 1 Resolved. OdDb::kXrfUnloaded 2 Unloaded. OdDb::kXrfUnreferenced 3 Unreferenced. OdDb::kXrfFileNotFound 4 File Not Found. OdDb::kXrfUnresolved 5 Unresolved.

Definition at line 146 of file DbXrefGraph.h.

---

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

• DbXrefGraph.h