Public Member Functions
	VgINavigationCallbackRefPtr ()

	VgINavigationCallbackRefPtr (VgINavigationCallback pPointer)

	VgINavigationCallbackRefPtr (VgINavigationCallbackRefPtr pRefPtr)

VgINavigationCallbackRefPtr	set (VgINavigationCallback pPointer)

VgINavigationCallback	__ref__ ()

VgINavigationCallback	__deref__ ()

VgINavigationCallback	get ()

boolean	isValid ()

boolean	notifyNavigationComputed (VgNavigationRequestStatus pStatus, VgINavigationRefPtr pNavigation)

void	ref ()

int	unref ()

int	getNbReferences ()

Static Public Member Functions
static VgINavigationCallbackRefPtr	getNull ()

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

VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( )

VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( VgINavigationCallback pPointer )

VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( VgINavigationCallbackRefPtr pRefPtr )

VgINavigationCallback VgINavigationCallbackRefPtr.__deref__ ( )

VgINavigationCallback VgINavigationCallbackRefPtr.__ref__ ( )

VgINavigationCallback VgINavigationCallbackRefPtr.get ( )

int VgINavigationCallbackRefPtr.getNbReferences ( )

static VgINavigationCallbackRefPtr VgINavigationCallbackRefPtr.getNull ( )

static

boolean VgINavigationCallbackRefPtr.isValid ( )

boolean VgINavigationCallbackRefPtr.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 VgINavigationCallbackRefPtr.ref ( )

VgINavigationCallbackRefPtr VgINavigationCallbackRefPtr.set ( VgINavigationCallback pPointer )

int VgINavigationCallbackRefPtr.unref ( )

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