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

Inheritance diagram for VgNavigationModule::VgINavigationCallback:

Public Member Functions
virtual	~VgINavigationCallback ()
	Destructor. More...

virtual bool	notifyNavigationComputed (VgNavigationRequestStatus pStatus, VgEngine::VgRefPtr< VgNavigationModule::VgINavigation > pNavigation)=0
	Informs requester that a navigation has been computed. More...

Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...

	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...

virtual	~VgReferenced ()
	Destructor. More...

VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...

void	ref () const
	This method is used to add a reference to this object. More...

int	unref () const
	This method is used to remove a reference to this object. More...

int	getNbReferences () const
	Retrieves the number of references to this object. More...

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

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()

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationCallback::VgINavigationCallback ( )

inlineprotected

Constructor.

virtual VgNavigationModule::VgINavigationCallback::~VgINavigationCallback ( )

inlinevirtual

Destructor.

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.
[out]	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

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