OperationDesc Class Reference

Class OperationDesc This class contains data used to report usage analytics through theHold.Accept method and the ADP mechanism. More...

#include <operationdesc.h>

Inheritance diagram for OperationDesc:

Public Member Functions
	OperationDesc (int commandResId)
	internal use only. Used internally to interface with legacy code
	OperationDesc (const MCHAR *commandName)
	OperationDesc (int commandResId, const MCHAR *commandName, HINSTANCE moduleInst)
	Constructor to report only a commandResId and a module name to ADP.
	OperationDesc (int commandResId, const MCHAR *commandName, HINSTANCE moduleInst, ReferenceTarget *refTarget)
	Constructor to report the impacted object class ids(derived from the ReferenceTarget), a commandResId and a module name to ADP.
	OperationDesc (int commandResId, const MCHAR *commandName, HINSTANCE moduleInst, ClassDesc *classDesc)
	Constructor to report the impacted object class ids (derived from the ClassDesc), a commandResId and a module name to ADP.
	OperationDesc (int commandResId, const MCHAR *commandName, HINSTANCE moduleInst, const SClass_ID &scId, const Class_ID &cId)
	Constructor to report the impacted object class ids, a commandResId and a module name to ADP.
	OperationDesc (int commandResId, const MCHAR *commandName, HINSTANCE moduleInst, MSTR commandDetails)
	Constructor to report only an arbitrary details string, a commandResId and a module name to ADP.
int	getCommandResId () const
const MSTR	getCommandName () const
HINSTANCE	getModuleInstance () const
SClass_ID	getCommandDetailsSid () const
const Class_ID	getCommandDetailsCid () const
const MSTR	getCommandDetails () const

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 OperationDesc This class contains data used to report usage analytics through theHold.Accept method and the ADP mechanism.

Each of the data members value are included in the way point report.

Constructor & Destructor Documentation

OperationDesc() [1/7]

OperationDesc ( int  commandResId )

explicit

internal use only. Used internally to interface with legacy code

OperationDesc() [2/7]

OperationDesc ( const MCHAR *  commandName )

explicit

OperationDesc() [3/7]

OperationDesc ( int  commandResId, const MCHAR *  commandName, HINSTANCE  moduleInst  )

explicit

Constructor to report only a commandResId and a module name to ADP.

Parameters

commandResId	Resource string ID identifying the command name string. Must not be -1.
commandName	This parameter must not be null should be a localized string.
moduleInst	HINSTANCE of the dll or exe which instantiated the OperationDesc and initiated the command.

OperationDesc() [4/7]

OperationDesc ( int  commandResId, const MCHAR *  commandName, HINSTANCE  moduleInst, ReferenceTarget *  refTarget  )

explicit

Constructor to report the impacted object class ids(derived from the ReferenceTarget), a commandResId and a module name to ADP.

Parameters

commandResId	Resource string ID identifying the command name string. Must not be -1.
commandName	This parameter must not be null should be a localized string.
moduleInst	HINSTANCE of the dll or exe which instantiated the OperationDesc and initiated the command.
refTarget	ReferenceTarget of the scene entity currently being modified or created by the Accept invocation and from which the Class_ID and the SClass_ID will be extracted and used as such in the way point.

OperationDesc() [5/7]

OperationDesc ( int  commandResId, const MCHAR *  commandName, HINSTANCE  moduleInst, ClassDesc *  classDesc  )

explicit

Constructor to report the impacted object class ids (derived from the ClassDesc), a commandResId and a module name to ADP.

Parameters

commandResId	Resource string ID identifying the command name string. Must not be -1.
commandName	This parameter must not be null should be a localized string.
moduleInst	HINSTANCE of the dll or exe which instantiated the OperationDesc and initiated the command.
classDesc	Class Descriptor of the scene entity currently being modified or created by the Accept invocation and from which the Class_ID and the SClass_ID will be extracted and used as such in the way point.

OperationDesc() [6/7]

OperationDesc ( int  commandResId, const MCHAR *  commandName, HINSTANCE  moduleInst, const SClass_ID &  scId, const Class_ID &  cId  )

explicit

Constructor to report the impacted object class ids, a commandResId and a module name to ADP.

Parameters

commandResId	Resource string ID identifying the command name string. Must not be -1.
commandName	This parameter must not be null should be a localized string.
moduleInst	HINSTANCE of the dll or exe which instantiated the OperationDesc and initiated the command.
scId	Super Class Id of the scene entity currently being modified or created by the Accept invocation. Used as such in the way point.
cId	Class Id of the scene entity currently being modified or created by the Accept invocation. Used as such in the way point.

OperationDesc() [7/7]

OperationDesc ( int  commandResId, const MCHAR *  commandName, HINSTANCE  moduleInst, MSTR  commandDetails  )

explicit

Constructor to report only an arbitrary details string, a commandResId and a module name to ADP.

Parameters

commandResId	Resource string ID identifying the command name string. Must not be -1.
commandName	This parameter must not be null should be a localized string.
moduleInst	HINSTANCE of the dll or exe which instantiated the OperationDesc and initiated the command.
commandDetails	Gives additional information on the command when other information like class ids, ClassDesc or ReferenceTarget are not readily available to the user. For instance: For a CREATE command, the type of object created. commandDetails must NOT be a localized string.

Member Function Documentation

getCommandResId()

int getCommandResId ( ) const

inline

{ return commandResId; }

getCommandName()

const MSTR getCommandName ( ) const

inline

Returns

Command name string. Likely to be localized. Empty only when OperationDesc is used internally in Max.

{ return commandName; }

getModuleInstance()

HINSTANCE getModuleInstance ( ) const

inline

{ return moduleInst; }

getCommandDetailsSid()

SClass_ID getCommandDetailsSid ( ) const

inline

Returns

Super class id of the object influenced by the command. The one created, modified or deleted. May be 0.

{ return commandDetailsSid; }

getCommandDetailsCid()

const Class_ID getCommandDetailsCid ( ) const

inline

Returns

Class id of the object impacted by the command. The one created, modified or deleted. May be invalid.

{ return commandDetailsCid; }

getCommandDetails()

const MSTR getCommandDetails ( ) const

inline

Returns

Additional command details string that have been provided at construction by the user. Shall not be localized. Can be anything. May be empty.

{ return commandDetails; }