DependentEnumProc Class Reference

A callback class for enumerating dependents. More...

#include <ref.h>

Inheritance diagram for DependentEnumProc:

Public Member Functions
virtual int	proc (ReferenceMaker *rmaker)=0
	This is the method called by system from ReferenceTarget::DoEnumDependentsImpl().
CoreExport bool	CheckIfAndSetAsVisited (ReferenceMaker *rmaker)
	This method sets and checks whether a ReferenceMaker was visited.

Protected Member Functions
CoreExport	DependentEnumProc ()
virtual CoreExport	~DependentEnumProc ()
	DependentEnumProc (const DependentEnumProc &)
DependentEnumProc &	operator= (const DependentEnumProc &rhs)

Friends
class	ReferenceTarget
class	ReferenceMaker

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

A callback class for enumerating dependents.

This class is a callback object for the ReferenceMaker::DoEnumDependentsImpl() and ReferenceMaker::DoEnumDependents() methods. The proc() method is called by the system.

Constructor & Destructor Documentation

DependentEnumProc() [1/2]

CoreExport DependentEnumProc ( )

protected

~DependentEnumProc()

virtual CoreExport ~DependentEnumProc ( )

protectedvirtual

DependentEnumProc() [2/2]

DependentEnumProc ( const DependentEnumProc &  )

protected

Member Function Documentation

operator=()

DependentEnumProc & operator= ( const DependentEnumProc &  rhs )

protected

proc()

virtual int proc ( ReferenceMaker *  rmaker )

pure virtual

This is the method called by system from ReferenceTarget::DoEnumDependentsImpl().

Parameters

rmaker

- A pointer to the reference maker

Returns

One of the following values:

• DEP_ENUM_CONTINUE: This continues the enumeration
• DEP_ENUM_HALT: This stops the enumeration.
• DEP_ENUM_SKIP: Reference Targets can have multiple Reference Makers (dependents). In certain instances when DoEnumDependents() is used to enumerate them you may not want to travel up all of the "branches". By returning DEP_ENUM_SKIP from this method you tell the enumerator to not enumerate the current Reference Maker's dependents but not to halt the enumeration completely.

See also

ReferenceTarget::DoEnumDependentsImpl(DependentEnumProc* dep)

ReferenceTarget::DoEnumDependents(DependentEnumProc* dep)

Implemented in FindMAXWrapperEnum, and FindCustAttribOwnerDEP.

CheckIfAndSetAsVisited()

CoreExport bool CheckIfAndSetAsVisited

(

ReferenceMaker *

rmaker

)

This method sets and checks whether a ReferenceMaker was visited.

This method is used to check whether a ReferenceMaker was previously visited by this callback object, and registers it as having been visited if not. This is used to only call the proc on each ReferenceMaker once. If you override ReferenceTarget::EnumDependentsImp, you should use this method to process your instance only if it was not previously visited.

Parameters

rmaker

- A pointer to the reference maker

Returns

Returns true of the rmaker was previously visited, false if not.

See also

ReferenceTarget::DoEnumDependentsImpl(DependentEnumProc* dep)

Friends And Related Function Documentation

ReferenceTarget

friend class ReferenceTarget

friend

ReferenceMaker

friend class ReferenceMaker

friend