Überwachungsklasse für AllSets. Mehr ...

Öffentliche Methoden
	ClassWatch (unsigned long ulClassID)

	~ClassWatch ()

void	deleteAllWatches (Communicator *pCommunicator)

unsigned long	getClassID () const

std::size_t	getCommunicatorClassNotifyModesMapCount () const

std::size_t	getObjectWatchMapCount () const

bool	hasWatches () const

void	setWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, const ObjID &rObjID, std::stack< ObjID > *pDependObjIdStack, TdWatchNotifyMode tdWatchNotifyMode, EnDeepMode eDeepMode)

void	setWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, TdWatchNotifyMode tdWatchNotifyMode)

int	unsetWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, const ObjID &rObjID, std::stack< ObjID > &prWNM_ReadDependObjIdStack, std::stack< ObjID > &prWNM_WriteDependObjIdStack, std::stack< ObjID > &prWNM_DeleteDependObjIdStack, std::stack< ObjID > &prWNM_LockDependObjIdStack, std::stack< ObjID > *&prWNM_UnlockDependObjIdStack, TdWatchNotifyMode tdWatchNotifyMode, EnDeepMode eDeepMode, bool bSimulate=false)

int	unsetWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, TdWatchNotifyMode tdWatchNotifyMode, bool bSimulate=false)

Geschützte Methoden
	ClassWatch ()

void	clearCommunicatorClassNotifyModesMap ()

void	ClearObjectWatchMap ()

Private Attribute
std::map< CommunicatorCallBackIndex, CommunicatorClassNotifyModes *, std::less< CommunicatorCallBackIndex > >	m_CommunicatorClassNotifyModesMap

std::map< ObjID, ObjectWatch *, std::less< ObjID > >	m_ObjectWatchMap

unsigned long	m_ulClassID

Ausführliche Beschreibung

Überwachungsklasse für AllSets.

Copyright: © 2010 Helmut Jakoby

Autor: Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

◆ ClassWatch() [1/2]

glo::WatchNotifyManager::ClassWatch::ClassWatch ( )

protected

Der Standard-Konstruktor steht nicht zur Verfügung.

◆ ClassWatch() [2/2]

glo::WatchNotifyManager::ClassWatch::ClassWatch ( unsigned long ulClassID )

Konstruktor mit Parameterübergabe.

Parameter

[in] ulClassID Die Klassen-ID des zu überwachenden AllSets.

◆ ~ClassWatch()

glo::WatchNotifyManager::ClassWatch::~ClassWatch ( )

Destruktor.

Dokumentation der Elementfunktionen

◆ clearCommunicatorClassNotifyModesMap()

void glo::WatchNotifyManager::ClassWatch::clearCommunicatorClassNotifyModesMap ( )

protected

Entfernt alle Überwachungen der AllSets.

◆ ClearObjectWatchMap()

void glo::WatchNotifyManager::ClassWatch::ClearObjectWatchMap ( )

protected

Entfernt alle Überwachungen der Objkete.

◆ deleteAllWatches()

void glo::WatchNotifyManager::ClassWatch::deleteAllWatches ( Communicator * pCommunicator )

Entfernt alle Überwachungen des übergebenen Client-Kommunikators.

Parameter

[in] pCommunicator Der Client-Kommunikators.

◆ getClassID()

unsigned long glo::WatchNotifyManager::ClassWatch::getClassID ( ) const

Liefert die Klassen-ID des überwachten AllSets.

Rückgabe: Die Klassen-ID des überwachten AllSets.

◆ getCommunicatorClassNotifyModesMapCount()

std::size_t glo::WatchNotifyManager::ClassWatch::getCommunicatorClassNotifyModesMapCount ( ) const

Liefert die Anzahl der AllSet-Überwachungen.

Rückgabe: Die Anzahl der CommunicatorClassNotifyModes.

◆ getObjectWatchMapCount()

std::size_t glo::WatchNotifyManager::ClassWatch::getObjectWatchMapCount ( ) const

Liefert die Anzahl der Objektüberwachungen.

Rückgabe: Die Anzahl der Objektüberwachungen.

◆ hasWatches()

bool glo::WatchNotifyManager::ClassWatch::hasWatches ( ) const

Prüft ob AllSet-Überwachungen gesetzt sind.

Rückgabe: Liefert true, wenn Überwachungen gesetzt sind.

◆ setWatch() [1/2]

void glo::WatchNotifyManager::ClassWatch::setWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		const ObjID &	rObjID,
		std::stack< ObjID > *	pDependObjIdStack,
		TdWatchNotifyMode	tdWatchNotifyMode,
		EnDeepMode	eDeepMode )

Registriert eine Überwachung für ein Objekt mit ggf. abhängigen Objekten.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwachen möchte.
[in]	rObjID	Die Objekt-ID, für die die Überwachung registriert werden soll.
[in]	pDependObjIdStack	Die abhängigen Objekte, welche von der aufrufenden Instanz 'mitüberwacht' werden.
[in]	tdWatchNotifyMode	Der aktivierte Überwachungsmodus.
[in]	eDeepMode	Der Überwachungstiefenmodus zum Auseinanderhalten der einzelnen DependentObjsWithDeepMode-Objekte.

◆ setWatch() [2/2]

void glo::WatchNotifyManager::ClassWatch::setWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		TdWatchNotifyMode	tdWatchNotifyMode )

Registriert eine Überwachung für seinen AllSet.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwachen möchte.
[in]	tdWatchNotifyMode	Der aktivierte Überwachungsmodus.

◆ unsetWatch() [1/2]

int glo::WatchNotifyManager::ClassWatch::unsetWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		const ObjID &	rObjID,
		std::stack< ObjID > *&	prWNM_ReadDependObjIdStack,
		std::stack< ObjID > *&	prWNM_WriteDependObjIdStack,
		std::stack< ObjID > *&	prWNM_DeleteDependObjIdStack,
		std::stack< ObjID > *&	prWNM_LockDependObjIdStack,
		std::stack< ObjID > *&	prWNM_UnlockDependObjIdStack,
		TdWatchNotifyMode	tdWatchNotifyMode,
		EnDeepMode	eDeepMode,
		bool	bSimulate = false )

Deregistriert eine Überwachung für ein Objekt mit ggf. abhängigen Objekten.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwacht hat
[in]	rObjID	Das überwachte Objekt.
[in,out]	prWNM_ReadDependObjIdStack	Die abhängigen Objekte, welche mit WNM_READ 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter bSimulate == false.
[in,out]	prWNM_WriteDependObjIdStack	Die abhängigen Objekte, welche mit WNM_WRITE 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter bSimulate == false.
[in,out]	prWNM_DeleteDependObjIdStack	Die abhängigen Objekte, welche mit WNM_DELETE 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter bSimulate == false.
[in,out]	prWNM_LockDependObjIdStack	Die abhängigen Objekte, welche mit WNM_LOCK 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter bSimulate == false.
[in,out]	prWNM_UnlockDependObjIdStack	Die abhängigen Objekte, welche mit WNM_UNLOCK 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter bSimulate == false.
[in]	tdWatchNotifyMode	Der aufgehobene Überwachungsmodus.
[in]	eDeepMode	Der Überwachungstiefenmodus zum Auseinanderhalten der einzelnen DependentObjsWithDeepMode-Objekte.
[in]	bSimulate	Wenn true, wird nur simuliert, also kein Wert gesetzt, aber ein Ergebnis bzw. Fehler geliefert.

Rückgabe: Eine Rückgabe > 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde; es existieren aber noch soviele Überwachungsmodi wie in der Rückgabeanzahl angegeben.
Eine Rückgabe == 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde und es keine weiteren Überwachungsmodi gibt!
Eine Rückgabe < 0 zeigt einen Fehler an.

◆ unsetWatch() [2/2]

int glo::WatchNotifyManager::ClassWatch::unsetWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		TdWatchNotifyMode	tdWatchNotifyMode,
		bool	bSimulate = false )

Deregistriert eine Überwachung für seinen AllSet.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwacht hat
[in]	tdWatchNotifyMode	Der aufgehobene Überwachungsmodus.
[in]	bSimulate	Wenn true, wird nur simuliert, also kein Wert gesetzt, aber ein Ergebnis bzw. Fehler geliefert.

Rückgabe: Eine Rückgabe > 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde; es existieren aber noch soviele Überwachungsmodi wie in der Rückgabeanzahl angegeben.
Eine Rückgabe == 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde und es keine weiteren Überwachungsmodi gibt!
Eine Rückgabe < 0 zeigt einen Fehler an.

Dokumentation der Datenelemente

◆ m_CommunicatorClassNotifyModesMap

std::map< CommunicatorCallBackIndex, CommunicatorClassNotifyModes *, std::less<CommunicatorCallBackIndex> > glo::WatchNotifyManager::ClassWatch::m_CommunicatorClassNotifyModesMap

private

Die einzelnen CommunicatorClassNotifyModes des überwachten AllSets mit dem CommunicatorCallBackIndex als Index in einer Map.

◆ m_ObjectWatchMap

std::map< ObjID, ObjectWatch *, std::less<ObjID> > glo::WatchNotifyManager::ClassWatch::m_ObjectWatchMap

private

Die Objekt-Überwachungen mit der ObjID als Index in einer Map.

◆ m_ulClassID

unsigned long glo::WatchNotifyManager::ClassWatch::m_ulClassID

private

Die Klassen-ID des zu überwachenden AllSets.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

GloWatchNotifyManager.h

Öffentliche Methoden

Geschützte Methoden

Private Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ ClassWatch() [1/2]

◆ ClassWatch() [2/2]

◆ ~ClassWatch()

Dokumentation der Elementfunktionen

◆ clearCommunicatorClassNotifyModesMap()

◆ ClearObjectWatchMap()

◆ deleteAllWatches()

◆ getClassID()

◆ getCommunicatorClassNotifyModesMapCount()

◆ getObjectWatchMapCount()

◆ hasWatches()

◆ setWatch() [1/2]

◆ setWatch() [2/2]

◆ unsetWatch() [1/2]

◆ unsetWatch() [2/2]

Dokumentation der Datenelemente

◆ m_CommunicatorClassNotifyModesMap

◆ m_ObjectWatchMap

◆ m_ulClassID