Detailed Description

Asset Tracking System Notification Parameter class.

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

#include <IATSNotifications.h>

Inheritance diagram for ATSNotifyParams:

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

Constructor & Destructor Documentation

ATSExport ATSNotifyParams ( )

Constructor.

virtual ATSExport ~ATSNotifyParams ( ) [virtual]

Destructor.

Member Function Documentation

virtual ATSExport ATSNotifyID GetID ( ) [virtual]

Search for all occurrences

Returns the Notification ID.

Returns:: returns the ID of the notification message

virtual ATSExport void SetID ( ATSNotifyID id ) [virtual]

Search for all occurrences

Set the Notification ID.

Parameters:

[in] id ID of notification message

virtual ATSExport UINT GetProviderIndex ( ) [virtual]

Search for all occurrences

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]

Search for all occurrences

Set the provider index.

Parameters:

[in] uIndex Index of provider that is associated with the message

virtual ATSExport bool IsCancelled ( ) [virtual]

Search for all occurrences

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.