glo::WatchNotifyManager::ObjectWatch Klassenreferenz

Überwachungsklasse für Objekte. Mehr ...

Öffentliche Methoden
	ObjectWatch (const ObjID &rObjID)
	~ObjectWatch ()
void	deleteAllWatches (Communicator *pCommunicator)
ObjID &	getObjID ()
bool	hasWatches () const
void	setWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, std::stack< ObjID > *pDependObjIdStack, TdWatchNotifyMode tdWatchNotifyMode, EnDeepMode eDeepMode)
int	unsetWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, 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)

Geschützte Methoden
	ObjectWatch ()

Private Methoden
void	clearCommunicatorObjNotifyModesMap ()

Private Attribute
std::map< CommunicatorCallBackIndex, CommunicatorObjNotifyModes *, std::less< CommunicatorCallBackIndex > >	m_CommunicatorObjNotifyModesMap
ObjID	m_ObjID

Ausführliche Beschreibung

Überwachungsklasse für Objekte.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

ObjectWatch() [1/2]

glo::WatchNotifyManager::ObjectWatch::ObjectWatch ( )

protected

Der Standard-Konstruktor steht nicht zur Verfügung.

ObjectWatch() [2/2]

glo::WatchNotifyManager::ObjectWatch::ObjectWatch

(

const ObjID &

rObjID

)

Konstruktor mit Parameterübergabe.

Parameter

[in]

rObjID

Die Objekt-ID des zu überwachenden Objekts.

~ObjectWatch()

glo::WatchNotifyManager::ObjectWatch::~ObjectWatch

(

)

Destruktor.

Dokumentation der Elementfunktionen

clearCommunicatorObjNotifyModesMap()

void glo::WatchNotifyManager::ObjectWatch::clearCommunicatorObjNotifyModesMap ( )

private

Entfernt alle Überwachungen des Objekts.

deleteAllWatches()

void glo::WatchNotifyManager::ObjectWatch::deleteAllWatches

(

Communicator *

pCommunicator

)

Entfernt alle Überwachungen des übergebenen Client-Kommunikators.

Parameter

[in]

pCommunicator

Der Client-Kommunikators.

getObjID()

ObjID & glo::WatchNotifyManager::ObjectWatch::getObjID

(

)

Liefert die Objekt-ID des zu überwachenden Objekts.

Rückgabe

Die Objekt-ID des zu überwachenden Objekts.

hasWatches()

bool glo::WatchNotifyManager::ObjectWatch::hasWatches

(

)

const

Prüft ob Objekt-Überwachungen gesetzt sind.

Rückgabe

Liefert true, wenn Überwachungen gesetzt sind.

setWatch()

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

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

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwachen möchte.
[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.

unsetWatch()

int glo::WatchNotifyManager::ObjectWatch::unsetWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		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 sein Objekt mit ggf. abhängigen Objekten.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwacht hat
[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.

Dokumentation der Datenelemente

m_CommunicatorObjNotifyModesMap

std::map< CommunicatorCallBackIndex, CommunicatorObjNotifyModes *, std::less<CommunicatorCallBackIndex> > glo::WatchNotifyManager::ObjectWatch::m_CommunicatorObjNotifyModesMap

private

Die einzelnen CommunicatorObjNotifyModes des überwachten Objektes mit dem CommunicatorCallBackIndex als Index in einer Map.

m_ObjID

ObjID glo::WatchNotifyManager::ObjectWatch::m_ObjID

private

Die Objekt-ID des zu überwachenden Objekts.

---

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

• GloWatchNotifyManager.h