ATSNotifyParams Class Reference

ATSNotifyParams Class Reference

#include <IATSNotifications.h>

Class Description

Asset Tracking System Notification Parameter class.

This class is created and configured by an object send an ATS notification message.

+ Inheritance diagram for ATSNotifyParams:

Public Member Functions

ATSExport ATSNotifyParams ()
 Constructor. More...
 
virtual ATSExport ~ATSNotifyParams ()
 Destructor. More...
 
virtual ATSExport ATSNotifyID GetID ()
 Returns the Notification ID. More...
 
virtual ATSExport void SetID (ATSNotifyID id)
 Set the Notification ID. More...
 
virtual ATSExport UINT GetProviderIndex ()
 Returns the index of the provider. More...
 
virtual ATSExport void SetProviderIndex (UINT uIndex)
 Set the provider index. More...
 
virtual ATSExport bool IsCancelled ()
 Specifies if this notification message was cancelled. More...
 
virtual ATSExport void SetCancelled (bool bCancelled)
 Sets the cancel state of a notification message. More...
 
virtual ATSExport ATSFileListGetATSFileList ()
 Returns the file list associated with the notification message. More...
 
virtual ATSExport void SetATSFileList (ATSFileList *pATSFileList)
 Set the file list associated with the notification message. More...
 

Protected Attributes

ATSNotifyID mID
 
UINT mProviderIndex
 
bool mCancelled
 
ATSFileListmpATSFileList
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
static UtilExport voidoperator 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 

Constructor & Destructor Documentation

Constructor.

virtual ATSExport ~ATSNotifyParams ( )
virtual

Destructor.

Member Function Documentation

virtual ATSExport ATSNotifyID GetID ( )
virtual

Returns the Notification ID.

Returns
returns the ID of the notification message
virtual ATSExport void SetID ( ATSNotifyID  id)
virtual

Set the Notification ID.

Parameters
[in]idID of notification message
virtual ATSExport UINT GetProviderIndex ( )
virtual

Returns the index of the provider.

Returns
Returns the index of the provider that is associated with the message
virtual ATSExport void SetProviderIndex ( UINT  uIndex)
virtual

Set the provider index.

Parameters
[in]uIndexIndex of provider that is associated with the message
virtual ATSExport bool IsCancelled ( )
virtual

Specifies if this notification message was cancelled.

If a message is cancelled by an object that has registered for notifications, all objects that received the notification before it was cancelled will be notified again, but this method will return true to allow the objects to perform any cleanup or undo any action taken.

Returns
true if cancelled, false if not cancelled
virtual ATSExport void SetCancelled ( bool  bCancelled)
virtual

Sets the cancel state of a notification message.

See also
ATSNotifyParams::IsCancelled
Parameters
[in]bCancelledtrue if cancelled, false if not.
virtual ATSExport ATSFileList* GetATSFileList ( )
virtual

Returns the file list associated with the notification message.

See also
ATSFileList
Returns
pointer to ATSFileList object
virtual ATSExport void SetATSFileList ( ATSFileList pATSFileList)
virtual

Set the file list associated with the notification message.

See also
ATSFileList
Parameters
[in,out]pATSFileListpointer to ATSFileList object

Member Data Documentation

ATSNotifyID mID
protected
UINT mProviderIndex
protected
bool mCancelled
protected
ATSFileList* mpATSFileList
protected