VisioMove SDK (Android)  2.1.22
 All Classes Functions Variables Pages
VgINavigationCallbackRefPtr Class Reference

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.

any subclass of VgNavigationModule::VgINavigationCallback should not hold a reference to VgINavigation , more information in VgINavigationCallback::notifyNavigationComputed()
2.1.2 updated note on retaining a VgINavigation on this class

Constructor & Destructor Documentation

VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( )
VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( VgINavigationCallback  pPointer)
VgINavigationCallbackRefPtr.VgINavigationCallbackRefPtr ( VgINavigationCallbackRefPtr  pRefPtr)

Member Function Documentation

VgINavigationCallback VgINavigationCallbackRefPtr.__deref__ ( )
VgINavigationCallback VgINavigationCallbackRefPtr.__ref__ ( )
VgINavigationCallback VgINavigationCallbackRefPtr.get ( )
int VgINavigationCallbackRefPtr.getNbReferences ( )
static VgINavigationCallbackRefPtr VgINavigationCallbackRefPtr.getNull ( )
boolean VgINavigationCallbackRefPtr.isValid ( )
boolean VgINavigationCallbackRefPtr.notifyNavigationComputed ( VgNavigationRequestStatus  pStatus,
VgINavigationRefPtr  pNavigation 

Informs requester that a navigation has been computed.

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
pStatusIndicating the status of the result.
pNavigationContaining the newly calculated navigation, or NULL if pStatus returns anthing other then eSuccess.
2.1.2 updated remark regarding retention of pNavigation
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:
VisioMove 2.1.22, Visioglobe® 2016