OdDbXRefMan Class Reference

#include <XRefMan.h>

Static Public Member Functions
static OdResult	load (OdDbDatabase *pHostDb, const OdString &xrefBlockname)
static OdResult	load (OdDbObjectIdArray &xrefBTRids)
static OdResult	load (OdDbBlockTableRecord *pBTR)
static OdResult	loadAll (OdDbDatabase *pHostDb, bool verify=false)
static void	unload (OdDbBlockTableRecord *pBTR)
static void	unload (OdDbObjectIdArray &xrefBTRids)
static void	unloadAll (OdDbDatabase *pHostDb)
static OdResult	bind (OdDbBlockTableRecord *pBTR, bool insertBind=false)
static OdResult	detach (OdDbBlockTableRecord *pBTR)
static void	setOverlaid (OdDbBlockTableRecord *pBTR, bool overlaid=true)

Detailed Description

This class manages External References (Xrefs) in an OdDbDatabase object. <group OdDb_Classes>

Definition at line 44 of file XRefMan.h.

Member Function Documentation

bind()

static OdResult OdDbXRefMan::bind ( OdDbBlockTableRecord * pBTR, bool insertBind = false )

static

Binds the specified Xref.

Parameters

pBTR	[in] Pointer to the Block Table Record of the Xref to bind.
insertBind	[in] True for Xref Insert, false for Xref Bind.

Returns

Returns eInvalidContext if Trace opened for editing.

detach()

static OdResult OdDbXRefMan::detach ( OdDbBlockTableRecord * pBTR )

static

Detaches the specfied Xref.

Parameters

pBTR	[in] Pointer to the Block Table Record of the Xref to detach.

Returns

Returns eInvalidContext if Trace opened for editing.

load() [1/3]

static OdResult OdDbXRefMan::load ( OdDbBlockTableRecord * pBTR )

static

Loads of specified Xref(s) if not currently loaded.

Parameters

pBTR	[in] Pointer to the Block Table Record of the Xref to load.

Returns

Returns eOk if successful, or an appropriate error code if not. Returns eInvalidContext if Trace opened for editing.

load() [2/3]

static OdResult OdDbXRefMan::load ( OdDbDatabase * pHostDb, const OdString & xrefBlockname )

static

Loads of specified Xref(s) if not currently loaded.

Parameters

pHostDb	[in] Pointer to the host database.
xrefBlockname	[in] Xref block name to load.

Returns

Returns eOk if successful, or an appropriate error code if not. Returns eInvalidContext if Trace opened for editing.

load() [3/3]

static OdResult OdDbXRefMan::load ( OdDbObjectIdArray & xrefBTRids )

static

Loads of specified Xref(s) if not currently loaded.

Parameters

xrefBTRids

[in] Array of the object IDs of the Block Table Records of the Xrefs to load.

Returns

Returns eOk if successful, or an appropriate error code if not. Returns eInvalidContext if Trace opened for editing.

loadAll()

static OdResult OdDbXRefMan::loadAll ( OdDbDatabase * pHostDb, bool verify = false )

static

Loads of all Xrefs not currently loaded.

Parameters

pHostDb	[in] Pointer to the host database.
verify	[in] Verify.

Remarks

If verify is true, this function attempts to load those Xrefs that are not unloaded, not unresolved, and not resolved.

Returns eOk if successful, or an appropriate error code if not. Returns eInvalidContext if Trace opened for editing.

setOverlaid()

static void OdDbXRefMan::setOverlaid ( OdDbBlockTableRecord * pBTR, bool overlaid = true )

static

Controls the reference type fo the specified Xref.

Parameters

pBTR	[in] Pointer to the Block Table Record of the Xref to detach.
overlaid	[in] True for Xref Overlay, false for Xref Attach.

Remarks

throws OdError with code eInvalidContext if Trace opened for editing.

unload() [1/2]

static void OdDbXRefMan::unload ( OdDbBlockTableRecord * pBTR )

static

Unloads the specified Xref(s).

Parameters

pBTR	[in] Pointer to the Block Table Record of the Xref to unload.

Remarks

throws OdError with code eInvalidContext if Trace opened for editing.

unload() [2/2]

static void OdDbXRefMan::unload ( OdDbObjectIdArray & xrefBTRids )

static

Unloads the specified Xref(s).

Parameters

xrefBTRids

[in] Array of the object IDs of the Block Table Records of the Xrefs to nload.

Remarks

throws OdError with code eInvalidContext if Trace opened for editing.

unloadAll()

static void OdDbXRefMan::unloadAll ( OdDbDatabase * pHostDb )

static

Unloads all loaded Xrefs.

Parameters

pHostDb

[in] Pointer to the host database.

Remarks

throws OdError with code eInvalidContext if Trace opened for editing.

---

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

• XRefMan.h