Inheritance diagram for VgINavigationCallback:

Public Member Functions
void	swigReleaseOwnership ()

void	swigTakeOwnership ()

boolean	notifyNavigationComputed (VgNavigationRequestStatus pStatus, VgINavigationRefPtr pNavigation)

Public Member Functions inherited from VgReferenced
synchronized void	release ()

	VgReferenced ()

	VgReferenced (VgReferenced pThis)

void	ref ()

int	unref ()

int	getNbReferences ()

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

Member Function Documentation

boolean VgINavigationCallback.notifyNavigationComputed	(	VgNavigationRequestStatus	pStatus,
		VgINavigationRefPtr	pNavigation
	)

Informs requester that a navigation has been computed.

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

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.

void VgINavigationCallback.swigReleaseOwnership ( )

void VgINavigationCallback.swigTakeOwnership ( )

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