NotifyCollapseMaintainCustAttribEnumProc2 Class Reference

Class used by EnumGeomPipeline to notify the pipeline of a collapse as well as maintaing the Custom Attributes. More...

#include <modstack.h>

Inheritance diagram for NotifyCollapseMaintainCustAttribEnumProc2:

Public Member Functions
CoreExport	NotifyCollapseMaintainCustAttribEnumProc2 (bool preCollapse, INode *node, bool ignoreBaseObjectCAs=false, Object *collapsedObj=NULL)
	Constructor. The private data members are initialized by the passed parameters.
virtual CoreExport PipeEnumResult	proc (ReferenceTarget *object, IDerivedObject *derObj, int index)
	This is the implementation of the EnumGeomPipeline callback method proc().
virtual PipeEnumResult	proc (ReferenceTarget *object, IDerivedObject *derObj, int index)=0
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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

Class used by EnumGeomPipeline to notify the pipeline of a collapse as well as maintaing the Custom Attributes.

This class is used in conjunction with ICustAttribCollapseManager. The calling code needs to make sure they call the correct version of the enumeration. The following is a code example of its usage.

ICustAttribCollapseManager * iCM = ICustAttribCollapseManager::GetICustAttribCollapseManager();

if(iCM && iCM->GetCustAttribSurviveCollapseState()) { NotifyCollapseMaintainCustAttribEnumProc2 PostNCEP(false,oldObj,true,obj); //use the CA safe version EnumGeomPipeline(&PostNCEP,oldObj); } else { NotifyCollapseEnumProc PostNCEP(false,node,obj); //use the original EnumGeomPipeline(&PostNCEP,oldObj); }

Constructor & Destructor Documentation

NotifyCollapseMaintainCustAttribEnumProc2()

CoreExport NotifyCollapseMaintainCustAttribEnumProc2	(	bool	preCollapse,
		INode *	node,
		bool	ignoreBaseObjectCAs = false,
		Object *	collapsedObj = NULL
	)

Constructor. The private data members are initialized by the passed parameters.

Parameters

[in]	preCollapse	Indicates if this is a pre- collapse or a post- collapse. Pass true for pre and false for post.
[in]	node	Points to the node at the beginning of the pipeline that was collapsed.
[in]	ignoreBaseObjectCAs	If this is a post- collapse then specifies whether to apply CAs collected from the node's base object.
[in]	collapsedObj	If this is a post- collapse then points to the object which is the result of the collapse.

Member Function Documentation

proc()

virtual CoreExport PipeEnumResult proc ( ReferenceTarget *  object, IDerivedObject *  derObj, int  index  )

virtual

This is the implementation of the EnumGeomPipeline callback method proc().

On a pre-collapse enumeration, collects the custom attributes on each object and its references (recursively), and calls NotifyPreCollapse on the object. On a post-collapse enumeration, applies the custom attributes previously collected to the collapsed object, and calls NotifyPostCollapse on the object. If ignoreBaseObjectCAs is true, CAs that were collected from the base object and its references are not applied. This is to account for cases of collapsing the stack where the base object is cloned. When the base object is cloned, it will create its own copy of the CAs.

Implements GeomPipelineEnumProc.