glo::WatchNotifyManager::CommunicatorClassNotifyModes Class Reference

Monitoring or notification mode of AllSets. More...

Inheritance diagram for glo::WatchNotifyManager::CommunicatorClassNotifyModes:

Public Member Functions
	CommunicatorClassNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)
virtual	~CommunicatorClassNotifyModes ()
virtual bool	hasWatches () const
void	setWatch (TdWatchNotifyMode tdWatchNotifyMode, unsigned long ulClassID)
int	unsetWatch (TdWatchNotifyMode tdWatchNotifyMode, unsigned long ulClassID, bool bSimulate=false)
Public Member Functions inherited from glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)
virtual	~CommunicatorNotifyModes ()
NUM_PTR	getCallBackIndex ()
Communicator *	getCommunicator ()
WatchNotifyManager::CommunicatorCallBackIndex &	getCommunicatorCallBackIndex ()

Protected Member Functions
	CommunicatorClassNotifyModes ()
Protected Member Functions inherited from glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes ()

Private Attributes
int	m_iWNM_DELETE
int	m_iWNM_INSERT
int	m_iWNM_LOCK
int	m_iWNM_READ
int	m_iWNM_UNLOCK
int	m_iWNM_WRITE

Detailed Description

Monitoring or notification mode of AllSets.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

CommunicatorClassNotifyModes() [1/2]

glo::WatchNotifyManager::CommunicatorClassNotifyModes::CommunicatorClassNotifyModes ( )

protected

The standard constructor is not available.

CommunicatorClassNotifyModes() [2/2]

glo::WatchNotifyManager::CommunicatorClassNotifyModes::CommunicatorClassNotifyModes

(

const CommunicatorCallBackIndex &

rCommunicatorCallBackIndex

)

Constructor with parameter passing.

Parameters

[in]

rCommunicatorCallBackIndex

The client communicator CallBackIndex.

~CommunicatorClassNotifyModes()

virtual glo::WatchNotifyManager::CommunicatorClassNotifyModes::~CommunicatorClassNotifyModes ( )

virtual

Destructor.

Member Function Documentation

hasWatches()

virtual bool glo::WatchNotifyManager::CommunicatorClassNotifyModes::hasWatches ( ) const

virtual

Checks whether monitoring is set.

Returns

Returns true if any supervision is set.

Implements glo::WatchNotifyManager::CommunicatorNotifyModes.

setWatch()

void glo::WatchNotifyManager::CommunicatorClassNotifyModes::setWatch	(	TdWatchNotifyMode	tdWatchNotifyMode,
		unsigned long	ulClassID )

Registers a monitoring for an AllSet.

Parameters

[in]	tdWatchNotifyMode	The monitoring mode to be registered for the AllSet.
[in]	ulClassID	The class ID of the AllSet.

unsetWatch()

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::unsetWatch	(	TdWatchNotifyMode	tdWatchNotifyMode,
		unsigned long	ulClassID,
		bool	bSimulate = false )

Deregisters a monitoring for an AllSet.

Parameters

[in]	tdWatchNotifyMode	The watch mode to be unregistered for the AllSet.
[in]	ulClassID	The class ID of the AllSet.
[in]	bSimulate	If true, only simulation is performed, no value is set, but a result or error is returned.

Returns

A return value > 0 indicates that the monitoring mode was switched off; however, there are still as many monitoring modes as specified in the return value.
A return == 0 indicates that the monitoring mode has been switched off and there are no further monitoring modes!
A return value < 0 indicates an error.

Member Data Documentation

m_iWNM_DELETE

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_DELETE

private

Monitoring counter for "delete".

m_iWNM_INSERT

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_INSERT

private

Monitoring counter for "insert".

m_iWNM_LOCK

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_LOCK

private

Monitoring counter for "lock".

m_iWNM_READ

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_READ

private

Monitoring counter for "read".

m_iWNM_UNLOCK

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_UNLOCK

private

Monitoring counter for "unlock".

m_iWNM_WRITE

int glo::WatchNotifyManager::CommunicatorClassNotifyModes::m_iWNM_WRITE

private

Monitoring counter for "write".

---

The documentation for this class was generated from the following file:

• GloWatchNotifyManager.h