OdDbIdMapping Class Reference

#include <DbIdMapping.h>

Inheritance diagram for OdDbIdMapping:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbIdMapping)
	OdDbIdMapping ()
virtual void	assign (const OdDbIdPair &idPair)=0
virtual bool	compute (OdDbIdPair &idPair) const =0
virtual bool	del (const OdDbObjectId &key)=0
virtual OdDbIdMappingIterPtr	newIterator ()=0
virtual OdDbDatabase *	destDb () const =0
virtual void	setDestDb (OdDbDatabase *pDb)=0
virtual OdDbDatabase *	origDb () const =0
virtual OdDbObjectId	insertingXrefBlockId () const =0
virtual OdDb::DeepCloneType	deepCloneContext () const =0
virtual OdDb::DuplicateRecordCloning	duplicateRecordCloning () const =0
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

Static Public Member Functions
static OdDbIdMappingPtr	createObject (OdDb::DeepCloneType)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class is used in deepclone operations to map, using OdDbIdPair objects, Object IDs from the original objects to their clones.

Remarks

There is no mechanism to clear all the mappings in an OdDbIdMapping instance; a new instance must be created for each deepclone operation.

<group OdDb_Classes>

Definition at line 231 of file DbIdMapping.h.

Constructor & Destructor Documentation

OdDbIdMapping()

OdDbIdMapping::OdDbIdMapping ( )

inline

Definition at line 236 of file DbIdMapping.h.

Member Function Documentation

assign()

virtual void OdDbIdMapping::assign ( const OdDbIdPair &  idPair )

pure virtual

Adds the specified IdPair object to this IdMapping object.

Parameters

idPair

[in] IdPair to add.

compute()

virtual bool OdDbIdMapping::compute ( OdDbIdPair &  idPair ) const

pure virtual

Returns the value of the IdPair in this IdMapping object that matches the key in the specified IdPair object.

Parameters

idPair

[in/out] Supplies the key and receives the value.

Remarks

Returns true if and only if the key is found.

createObject()

static OdDbIdMappingPtr OdDbIdMapping::createObject ( OdDb::DeepCloneType  )

static

deepCloneContext()

virtual OdDb::DeepCloneType OdDbIdMapping::deepCloneContext ( ) const

pure virtual

Returns the type of deepclone operation using this IdMapping object.

Remarks

deepCloneContext() returns one of the of the following:

Value Description kDcCopy 0 Copy Array Mirror kDcExplode 1 Explode kDcBlock 2 Block definition kDcXrefBind 3 Xref Bind kDcSymTableMerge 4 Xref Attach DxfIn IgesIn kDcInsert 6 Insert of a .dwg file kDcWblock 7 Wblock kDcObjects 8 OdDbDatabase::deepCloneObjects() kDcXrefInsert 9 Xref Insert Xref BInd kDcInsertCopy 10 Insert() kDcWblkObjects 11 Wblock objects

del()

virtual bool OdDbIdMapping::del ( const OdDbObjectId &  key )

pure virtual

Deletes the IdPair with the specified key from this IdMapping object.

Parameters

key	[in] Object ID key to delete.

destDb()

virtual OdDbDatabase * OdDbIdMapping::destDb ( ) const

pure virtual

Returns the destination database for the deepclone operation using this IdMapping object.

duplicateRecordCloning()

virtual OdDb::DuplicateRecordCloning OdDbIdMapping::duplicateRecordCloning ( ) const

pure virtual

Returns the type of duplicate record cloning for IdMapping object.

Remarks

duplicateRecordCloning() returns one of the of the following:

Value Description kDrcNotApplicable 0 Not applicable to the object. kDrcIgnore 1 If a duplicate record exists, use the existing record in the database, and ignore the clone. kDrcReplace 2 If a duplicate record exists, replace it with the cloned record. kDrcXrefMangleName 3 Incoming record names are mangled with <Xref>$0$<name> kDrcMangleName 4 Incoming record names are mangled with $0$<name> kDrcUnmangleName 5 Unmangle the names mangled by kDrcMangleName, then default to kDrcIgnore. Typically used by RefEdit when checking records into the original database.

insertingXrefBlockId()

virtual OdDbObjectId OdDbIdMapping::insertingXrefBlockId ( ) const

pure virtual

Notification function called whenever the Xref Block ID is about to be inserted into the destination database.

Returns the ObjectID of the Xref Block.

newIterator()

virtual OdDbIdMappingIterPtr OdDbIdMapping::newIterator ( )

pure virtual

Creates an Iterator object that provides access to the IdPair objects in this IdMapping object.

ODRX_DECLARE_MEMBERS()

OdDbIdMapping::ODRX_DECLARE_MEMBERS

(

OdDbIdMapping

)

origDb()

virtual OdDbDatabase * OdDbIdMapping::origDb ( ) const

pure virtual

Returns the source database for the deepclone operation using this IdMapping object.

setDestDb()

virtual void OdDbIdMapping::setDestDb ( OdDbDatabase *  pDb )

pure virtual

Sets the destination database for the deepclone operation using this IdMapping object.

Parameters

pDb	[in] Pointer to the destination database.

---

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

• DbIdMapping.h