Glympse::IPoiManager Struct Reference

Inheritance diagram for Glympse::IPoiManager:

Public Member Functions
virtual bool	isSynced ()=0
	Determine if the PoiManager is synced with the server. More...
virtual GArray< GPoi >::ptr	getPois ()=0
	Gets the list of POIs. More...
virtual void	addPoi (const GPoi &poi)=0
	Add a POI locally and on the server. More...
virtual void	updatePoi (const GPoi &targetPoi, const GPoi &sourcePoi)=0
	Update a currently registered POI with the values from an existing POI. More...
virtual void	removePoi (const GPoi &poi)=0
	Remove a POI locally and on the server. More...
virtual GPoi	findPoiById (const GString &poiId)=0
	Get the POI corresponding to a particular id. More...
Public Member Functions inherited from Glympse::IEventSink
virtual bool	addListener (const GEventListener &eventListener)=0
	Registeres event listener on the sink. More...
virtual bool	removeListener (const GEventListener &eventListener)=0
	Unsubscribes listener from events coming from this sink.
virtual GArray< GEventListener > ::ptr	getListeners ()=0
	Provides access to the collection of current listeners. More...
virtual bool	hasContext (int64 key)=0
	Checks, where user context identified by key is already associated with the object.
virtual void	associateContext (int64 key, const GCommonObj &value)=0
	Associates specific context (user data) with the sink. More...
virtual GCommonObj	getContext (int64 key)=0
	Returns context associated with the sink, or NULL, if it is not found.
virtual void	clearContext (int64 key)=0
	Clears context identified by key argument.
virtual GEnumeration< GLong >::ptr	getContextKeys ()=0
	Gets enumeration of all context keys associated with the sink.
virtual void	deriveContext (const GEventSink &sink)=0
	Derives context from another sink object.
Public Member Functions inherited from Glympse::IEventListener
virtual void	eventsOccurred (const GGlympse &glympse, int32 listener, int32 events, const GCommonObj &obj)=0
	This method is invoked each time, when sink object notifies subscriber on an event. More...
Public Member Functions inherited from Glympse::ICommon
virtual int32	retain ()=0
	Add a reference to our object in a COM-like way.
virtual int32	release ()=0
	Release a reference to our object in a COM-like way.
virtual int32	hold ()=0
	Add a reference to our object in a COM-like way.
virtual int32	unhold ()=0
	Release a reference to our object in a COM-like way.
virtual int32	hashCode ()=0
	Returns an integer hash code for this object.
virtual bool	equals (const GCommonObj &o)=0
	Compares this instance with the specified object and indicates if they are equal. More...
virtual GString	toString ()=0
	Returns a string containing a concise, human-readable description of this object. More...
virtual void	attachObject (const GCommon &obj)=0
	Asociates arbitrary object with the instance.
virtual GCommon	extractObject ()=0
	Extracts associated object or NULL if no association is established.

Additional Inherited Members
Protected Member Functions inherited from Glympse::ICommon
virtual	~ICommon ()
	Destructor is protected to deny explicit object deallocation. More...

Member Function Documentation

virtual void Glympse::IPoiManager::addPoi ( const GPoi &  poi)

pure virtual

Add a POI locally and on the server.

Parameters

poi	The POI to add.

virtual GPoi Glympse::IPoiManager::findPoiById ( const GString &  poiId)

pure virtual

Get the POI corresponding to a particular id.

Parameters

id	Id of the POI to return

Returns

The POI with the given id or NULL if not present.

virtual GArray<GPoi>::ptr Glympse::IPoiManager::getPois ( )

pure virtual

Gets the list of POIs.

Returns

List of POIs on the system.

virtual bool Glympse::IPoiManager::isSynced ( )

pure virtual

Determine if the PoiManager is synced with the server.

Returns

True if the PoiManager has synced with the server.

virtual void Glympse::IPoiManager::removePoi ( const GPoi &  poi)

pure virtual

Remove a POI locally and on the server.

Parameters

poi	The POI to remove.

virtual void Glympse::IPoiManager::updatePoi ( const GPoi &  targetPoi, const GPoi &  sourcePoi  )

pure virtual

Update a currently registered POI with the values from an existing POI.

All values in target POI are overwritten by values from source POI, including unset values.

Parameters

targetPoi	The POI to update.
sourcePoi	The POI to use as the source of values to update on the targetPoi.

---

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

• IPoiManager.h