#include <OdFileDepMgr.h>

Inheritance diagram for OdFileDependencyManager:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdFileDependencyManager)

	OdFileDependencyManager ()

virtual OdUInt32	createEntry (const OdString &feature, const OdString &fullFileName, const bool affectsGraphics=false, const bool noIncrement=false)=0

virtual OdResult	getEntry (const OdString &feature, const OdString &fullFileName, OdFileDependencyInfoPtr &fileInfo, const bool useCachedInfo=false)=0

virtual OdResult	getEntry (OdUInt32 fdlIndex, OdFileDependencyInfoPtr &fileInfo, const bool useCachedInfo=false)=0

virtual OdResult	updateEntry (const OdString &feature, const OdString &fullFileName)=0

virtual OdResult	updateEntry (OdUInt32 index)=0

virtual OdResult	eraseEntry (const OdString &feature, const OdString &fullFileName, const bool forceRemove=false)=0

virtual OdResult	eraseEntry (OdUInt32 fdlIndex, const bool forceRemove=false)=0

virtual OdUInt32	countEntries ()=0

virtual void	iteratorInitialize (const OdString &feature=OdString::kEmpty, const bool modifiedOnly=false, const bool affectsGraphicsOnly=false, const bool walkXRefTree=false)=0

virtual OdUInt32	iteratorNext ()=0

virtual void	getFeatures (OdRxDictionaryPtr &features)=0

virtual void	clearXRefEntries ()=0

virtual void	iteratorUnInitialize ()=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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class allows management of entries in the File Dependency List DWG section.

Corresponding C++ library: TD_Db

Remarks: Every OdDbDatabase instance has an instance of the this class permanently associated with it. <group Other_Classes>

Definition at line 76 of file OdFileDepMgr.h.

Constructor & Destructor Documentation

◆ OdFileDependencyManager()

OdFileDependencyManager::OdFileDependencyManager ( )

inline

Definition at line 81 of file OdFileDepMgr.h.

Member Function Documentation

◆ clearXRefEntries()

virtual void OdFileDependencyManager::clearXRefEntries ( )

pure virtual

Removes the Xref entries from the File Dependency List by iteratorInitialize.

◆ countEntries()

virtual OdUInt32 OdFileDependencyManager::countEntries ( )

pure virtual

Returns the number of unique entries in the DWG section of the File Dependency List.

◆ createEntry()

virtual OdUInt32 OdFileDependencyManager::createEntry	(	const OdString &	feature,
		const OdString &	fullFileName,
		const bool	affectsGraphics = `false`,
		const bool	noIncrement = `false`
	)

pure virtual

Creates an entry in the File Dependency List.

Parameters

feature	[in] Name of the application or feature creating the entry.
fullFileName	[in] Full name of file for the entry.
affectsGraphics	[in] True if and only if the entry affects the screen view.
noIncrement	[in] If true, duplicate records are created instead of incrementing the reference count of the existing entry.

Returns: Returns the Unique File Dependency List ID for the new entry, or 0 if not successful.

◆ eraseEntry() [1/2]

virtual OdResult OdFileDependencyManager::eraseEntry	(	const OdString &	feature,
		const OdString &	fullFileName,
		const bool	forceRemove = `false`
	)

pure virtual

Erases the specified entry from the File Dependency List.

Parameters

feature	[in] Name of the application or feature that created the entry.
fullFileName	[in] Full name of file for the entry.
forceRemove	[in] True to erases the entry regardless of its reference count.

Remarks: If the reference count of the entry is 1, or forceRemove is true, the entry is erased. Otherwise, this function merely decrements the reference count.

◆ eraseEntry() [2/2]

virtual OdResult OdFileDependencyManager::eraseEntry	(	OdUInt32	fdlIndex,
		const bool	forceRemove = `false`
	)

pure virtual

Erases the specified entry from the File Dependency List.

Parameters

fdlIndex	[in] File Dependency List index.
forceRemove	[in] True to erases the entry regardless of its reference count.

Remarks: If the reference count of the entry is 1, or forceRemove is true, the entry is erased. Otherwise, this function merely decrements the reference count.

◆ getEntry() [1/2]

virtual OdResult OdFileDependencyManager::getEntry	(	const OdString &	feature,
		const OdString &	fullFileName,
		OdFileDependencyInfoPtr &	fileInfo,
		const bool	useCachedInfo = `false`
	)

pure virtual

Returns the specified entry in the File Dependency List.

Parameters

feature	[in] Name of the application or feature that created the entry.
fullFileName	[in] Full name of file for the entry.
fileInfo	[out] Receives the file dependency information
useCachedInfo	[in] True to use cached information, false to use updated information.

Returns: Returns eOk if successful, or an appropriate error code if not.

◆ getEntry() [2/2]

virtual OdResult OdFileDependencyManager::getEntry	(	OdUInt32	fdlIndex,
		OdFileDependencyInfoPtr &	fileInfo,
		const bool	useCachedInfo = `false`
	)

pure virtual

Returns the specified entry in the File Dependency List.

Parameters

fdlIndex	[in] File Dependency List index.
fileInfo	[out] Receives the file dependency information
useCachedInfo	[in] True to use cached information, false to use updated information.

Returns: Returns eOk if successful, or an appropriate error code if not.

◆ getFeatures()

virtual void OdFileDependencyManager::getFeatures ( OdRxDictionaryPtr & features )

pure virtual

Returns the dictionary containing the feature list in the File Dependency List.

◆ iteratorInitialize()

virtual void OdFileDependencyManager::iteratorInitialize	(	const OdString &	feature = `OdString::kEmpty`,
		const bool	modifiedOnly = `false`,
		const bool	affectsGraphicsOnly = `false`,
		const bool	walkXRefTree = `false`
	)

pure virtual

Initializes an iterator for the DWG section of the File Dependency List.

Parameters

feature	[in] Name of the application or feature creating the entry.
modifiedOnly	[in] True to return only modified entries.
affectsGraphicsOnly	[in] True to return only entries that effect the screen view.
walkXRefTree	[in] True to traverse the File Dependency Lists of the referenced drawings.

Remarks: If no arguments are specified, all entries in the local list will be traversed. Specifying feature, modifiedOnly true, and/or affectsGraphicsOnly true will restrict the entries traversed.

◆ iteratorNext()

virtual OdUInt32 OdFileDependencyManager::iteratorNext ( )

pure virtual

Returns the index of the next entry in File Dependency List.

Remarks: The returned value may be used in the getEntry() and eraseEntry() functions.

◆ iteratorUnInitialize()

virtual void OdFileDependencyManager::iteratorUnInitialize ( )

pure virtual

Clean up File Dependency List internal iterator.

◆ ODRX_DECLARE_MEMBERS()

OdFileDependencyManager::ODRX_DECLARE_MEMBERS ( OdFileDependencyManager )

◆ updateEntry() [1/2]

virtual OdResult OdFileDependencyManager::updateEntry	(	const OdString &	feature,
		const OdString &	fullFileName
	)

pure virtual

Updates the specified entry in the File Dependency List.

Parameters

feature	[in] Name of the application or feature that created the entry.
fullFileName	[in] Full name of file for the entry.
index	[in] File Dependency List index.

Remarks: This function resets the mIsModified, mTimestamp, and mFileSize members of the entry.

◆ updateEntry() [2/2]

virtual OdResult OdFileDependencyManager::updateEntry ( OdUInt32 index )

pure virtual

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

OdFileDepMgr.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdFileDependencyManager()

Member Function Documentation

◆ clearXRefEntries()

◆ countEntries()

◆ createEntry()

◆ eraseEntry() [1/2]

◆ eraseEntry() [2/2]

◆ getEntry() [1/2]

◆ getEntry() [2/2]

◆ getFeatures()

◆ iteratorInitialize()

◆ iteratorNext()

◆ iteratorUnInitialize()

◆ ODRX_DECLARE_MEMBERS()

◆ updateEntry() [1/2]

◆ updateEntry() [2/2]