VisioDevKit  v2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Friends Pages
VgNavigationModule::VgINavigationCallback Interface Referenceabstract

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

Inheritance diagram for VgNavigationModule::VgINavigationCallback:
Inheritance graph

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...
 
VgReferencedoperator= (const VgReferenced &pThis)
 Assignment operator. More...
 
void ref () const
 This method is used to add a reference to this object. More...
 
void 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...
 

Protected Member Functions

 VgINavigationCallback ()
 Constructor. 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.

Date
04/10/2011

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationCallback::VgINavigationCallback ( )
inlineprotected

Constructor.

virtual VgNavigationModule::VgINavigationCallback::~VgINavigationCallback ( )
inlinevirtual

Destructor.

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
pStatusIndicating the status of the result.
[out]pNavigationContaining the newly calculated navigation, or NULL if pStatus returns anthing other then eSuccess.
Returns
true if it should the VgINavigation object should continue to call the notifyNewInstruction for the first instruction.
Remarks
the caller is responsible for the deallocation of pNavigation.

The documentation for this interface was generated from the following file:
VisioDevKit 2.0, Visioglobe® 2013