VgNavigationModule::VgINavigationCallback Interface Reference

Inheritance diagram for VgNavigationModule::VgINavigationCallback:

Public Member Functions
virtual	~VgINavigationCallback ()
virtual bool	notifyNavigationComputed (VgNavigationRequestStatus pStatus, VgEngine::VgRefPtr< VgNavigationModule::VgINavigation > pNavigation)=0
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Protected Member Functions
	VgINavigationCallback ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

Detailed Description

VgINavigationCallback provides an interface for the Navigation Module to communicate with the navigation request.

Remarks

any subclass of VgNavigationModule::VgINavigationCallback should not hold a reference to VgINavigation, more information in VgINavigationCallback::notifyNavigationComputed()

Version

2.1.2 updated note on retaining a VgINavigation on this class

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationCallback::VgINavigationCallback ( )

inlineprotected

Constructor.

virtual VgNavigationModule::VgINavigationCallback::~VgINavigationCallback ( )

inlinevirtual

Destructor.

References notifyNavigationComputed().

Member Function Documentation

virtual bool VgNavigationModule::VgINavigationCallback::notifyNavigationComputed ( VgNavigationRequestStatus  pStatus, VgEngine::VgRefPtr< VgNavigationModule::VgINavigation >  pNavigation  )

pure virtual

Informs requester that a navigation has been computed.

Parameters

pStatus	Indicating the status of the result.
pNavigation	Containing the newly calculated navigation, or NULL if pStatus returns anthing other then eSuccess.

Returns

true if the VgINavigation object should continue to call the notifyNewInstruction() for the first instruction.

Remarks

The callback should not keep a reference pointer to pNavigation. It can make other classes keep a reference or if it keeps a reference it needs to be cleared manually at some point before the user's reference to this callback disappear. The reason for this constraint is is because VgINavigation keeps a reference to the callback, which is accessible via pNavigation->getRequestParameters().mCallback

Version

2.1.2 updated remark regarding retention of pNavigation

Referenced by ~VgINavigationCallback().

---

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

• VgINavigationCallback.h