Überwachungs- bzw. Benachrichtigungs-Modus von Objekten mit deren abhängigen Objekten. Abhängige Objekte sind die eingebetteten bzw. direkt mitgeladenen Objekte in Zeigern und Zeigerlisten. Mehr ...

Klassendiagramm für glo::WatchNotifyManager::CommunicatorObjNotifyModes:

[Legende]

Öffentliche Methoden
	CommunicatorObjNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)

virtual	~CommunicatorObjNotifyModes ()

virtual bool	hasWatches () const

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

int	unsetWatch (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, const ObjID &rObjID, bool bSimulate=false)

Öffentliche Methoden geerbt von glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)

virtual	~CommunicatorNotifyModes ()

NUM_PTR	getCallBackIndex ()

Communicator *	getCommunicator ()

WatchNotifyManager::CommunicatorCallBackIndex &	getCommunicatorCallBackIndex ()

Geschützte Methoden
	CommunicatorObjNotifyModes ()

int	setUnsetWatch (TdWatchNotifyMode tdWatchNotifyMode, EnDeepMode eDeepMode, 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, std::stack< ObjID > pDependObjIdStack, const ObjID &rObjID, bool bSimulate=false)

int	setWatchCount (std::list< DependentObjsWithDeepMode * > &rWatchCountList, std::stack< ObjID > &prDependObjIdStack, std::stack< ObjID > pDependObjIdStack, EnDeepMode eDeepMode, const ObjID &rObjID, std::list< CommunicatorCallBackIndex * > &rActionList, bool bSimulate=false)

Geschützte Methoden geerbt von glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes ()

Private Methoden
void	clearList (std::list< DependentObjsWithDeepMode * > *pList)

Private Attribute
bool	m_bCopyDependObjIdStack

std::list< DependentObjsWithDeepMode * >	m_WNM_DELETE

std::list< DependentObjsWithDeepMode * >	m_WNM_LOCK

std::list< DependentObjsWithDeepMode * >	m_WNM_READ

std::list< DependentObjsWithDeepMode * >	m_WNM_UNLOCK

std::list< DependentObjsWithDeepMode * >	m_WNM_WRITE

Ausführliche Beschreibung

Überwachungs- bzw. Benachrichtigungs-Modus von Objekten mit deren abhängigen Objekten. Abhängige Objekte sind die eingebetteten bzw. direkt mitgeladenen Objekte in Zeigern und Zeigerlisten.

Copyright: © 2010 Helmut Jakoby

Autor: Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

◆ CommunicatorObjNotifyModes() [1/2]

glo::WatchNotifyManager::CommunicatorObjNotifyModes::CommunicatorObjNotifyModes ( )

protected

Der Standard-Konstruktor steht nicht zur Verfügung.

◆ CommunicatorObjNotifyModes() [2/2]

glo::WatchNotifyManager::CommunicatorObjNotifyModes::CommunicatorObjNotifyModes ( const CommunicatorCallBackIndex & rCommunicatorCallBackIndex )

Konstruktor mit Parameterübergabe.

Parameter

[in] rCommunicatorCallBackIndex Der Client-Kommunikator-CallBackIndex.

◆ ~CommunicatorObjNotifyModes()

virtual glo::WatchNotifyManager::CommunicatorObjNotifyModes::~CommunicatorObjNotifyModes ( )

virtual

Destruktor.

Dokumentation der Elementfunktionen

◆ clearList()

void glo::WatchNotifyManager::CommunicatorObjNotifyModes::clearList ( std::list< DependentObjsWithDeepMode * > * pList )

private

Leert eine Leseüberwachungslist von Strukturen mit Objekt-ID und Überwachungs-Tiefenmodus.

Parameter

[in,out] pList Die zu leerende Liste (die Objekte werden aus dem Speicher entfernt)

◆ hasWatches()

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

virtual

Prüft ob Überwachungen gesetzt sind.

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

Implementiert glo::WatchNotifyManager::CommunicatorNotifyModes.

◆ setUnsetWatch()

int glo::WatchNotifyManager::CommunicatorObjNotifyModes::setUnsetWatch	(	TdWatchNotifyMode	tdWatchNotifyMode,
		EnDeepMode	eDeepMode,
		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,
		std::stack< ObjID > *	pDependObjIdStack,
		const ObjID &	rObjID,
		bool	bSimulate = false )

protected

Es wird der übergebene WatchNotifyMode mit seine eDeepMode in Abhängigkeit von pDependObjIdStack, wenn gesetzt registriert, ansonsten deregistreiert.

Parameter

[in]	tdWatchNotifyMode	Der Überwachungsmodus.
[in]	eDeepMode	Der Überwachungstiefenmodus zum Auseinanderhalten der einzelnen DependentObjsWithDeepMode-Objekte.
[in]	prWNM_ReadDependObjIdStack	Die abhängigen Objekte, welche mit WNM_READ 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter pDependObjIdStack == 0 und Parameter bSimulate == false.
[in]	prWNM_WriteDependObjIdStack	Die abhängigen Objekte, welche mit WNM_WRITE 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter pDependObjIdStack == 0 und Parameter bSimulate == false.
[in]	prWNM_DeleteDependObjIdStack	Die abhängigen Objekte, welche mit WNM_DELETE 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter pDependObjIdStack == 0 und Parameter bSimulate == false.
[in]	prWNM_LockDependObjIdStack	Die abhängigen Objekte, welche mit WNM_LOCK 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter pDependObjIdStack == 0 und Parameter bSimulate == false.
[in]	prWNM_UnlockDependObjIdStack	Die abhängigen Objekte, welche mit WNM_UNLOCK 'mitüberwacht' wurden und auch 'deregistriert' werden müssen, wenn Parameter pDependObjIdStack == 0 und Parameter bSimulate == false.
[in]	pDependObjIdStack	Die abhängigen Objekte, welche mitüberwacht werden (wenn übergeben, dann wird registriert).
[in]	rObjID	Das überwachte Objekt.
[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.

◆ setWatch()

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

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

Parameter

[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.
[in]	rObjID	Das zu überwachte Objekt.

◆ setWatchCount()

int glo::WatchNotifyManager::CommunicatorObjNotifyModes::setWatchCount	(	std::list< DependentObjsWithDeepMode * > &	rWatchCountList,
		std::stack< ObjID > *&	prDependObjIdStack,
		std::stack< ObjID > *	pDependObjIdStack,
		EnDeepMode	eDeepMode,
		const ObjID &	rObjID,
		std::list< CommunicatorCallBackIndex * > &	rActionList,
		bool	bSimulate = false )

protected

Inkerementiert bzw. dekrementiert (in Abhängigkeit von Parameter pDependObjIdStack) eine Überwachungsregistrierung.

Parameter

[in,out]	rWatchCountList	Die betroffene Leseüberwachungslist von Strukturen mit Objekt-ID und Überwachungs-Tiefenmodus.
[in,out]	prDependObjIdStack	Die Objekte bei denen die Überwachung deregistriert wurde (wird nur gefüllt wenn Parameter pDependObjIdStack == 0).
[in]	pDependObjIdStack	Die abhängigen Objekte, welche mitüberwacht werden (wenn übergeben, dann wird registriert).
[in]	eDeepMode	Der Überwachungstiefenmodus zum Auseinanderhalten der einzelnen DependentObjsWithDeepMode-Objekte.
[in]	rObjID	Das überwachte Objekt.
[in,out]	rActionList	Liste von Objekten des Typs CommunicatorCallBackIndex über welche die einzelnen Clients über die einzelnen Aktionen benachrichtigt werden können wird hier gefüllt.
[in]	bSimulate	Wenn true, wird nur simuliert, also kein Wert gesetzt, aber ein Ergebnis bzw. Fehler geliefert.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

◆ unsetWatch()

int glo::WatchNotifyManager::CommunicatorObjNotifyModes::unsetWatch	(	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,
		const ObjID &	rObjID,
		bool	bSimulate = false )

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

Parameter

[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]	rObjID	Das überwachte Objekt.
[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_bCopyDependObjIdStack

bool glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_bCopyDependObjIdStack

private

Für den internen Gebrauch um Mehrfachinstanziierung zu vermeiden.

◆ m_WNM_DELETE

std::list<DependentObjsWithDeepMode *> glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_WNM_DELETE

private

Lösch-Überwachungslist von abhängigen Objekten mit Objekt-ID und Überwachungs-Tiefenmodus.

◆ m_WNM_LOCK

std::list<DependentObjsWithDeepMode *> glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_WNM_LOCK

private

Sperr-Überwachungslist von abhängigen Objekten mit Objekt-ID und Überwachungs-Tiefenmodus.

◆ m_WNM_READ

std::list<DependentObjsWithDeepMode *> glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_WNM_READ

private

Lese-Überwachungslist von abhängigen Objekten mit Objekt-ID und Überwachungs-Tiefenmodus.

◆ m_WNM_UNLOCK

std::list<DependentObjsWithDeepMode *> glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_WNM_UNLOCK

private

Entsperr-Überwachungslist von abhängigen Objekten mit Objekt-ID und Überwachungs-Tiefenmodus.

◆ m_WNM_WRITE

std::list<DependentObjsWithDeepMode *> glo::WatchNotifyManager::CommunicatorObjNotifyModes::m_WNM_WRITE

private

Schreib-Überwachungslist von abhängigen Objekten mit Objekt-ID und Überwachungs-Tiefenmodus.

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

GloWatchNotifyManager.h

Öffentliche Methoden

Geschützte Methoden

Private Methoden

Private Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ CommunicatorObjNotifyModes() [1/2]

◆ CommunicatorObjNotifyModes() [2/2]

◆ ~CommunicatorObjNotifyModes()

Dokumentation der Elementfunktionen

◆ clearList()

◆ hasWatches()

◆ setUnsetWatch()

◆ setWatch()

◆ setWatchCount()

◆ unsetWatch()

Dokumentation der Datenelemente

◆ m_bCopyDependObjIdStack

◆ m_WNM_DELETE

◆ m_WNM_LOCK

◆ m_WNM_READ

◆ m_WNM_UNLOCK

◆ m_WNM_WRITE