osmscout::OSMScoutQt Class Reference

Singleton that provides access to high level modules of OSMScout library. More...

#include <OSMScoutQt.h>

Inheritance diagram for osmscout::OSMScoutQt:

Public Slots
void	threadFinished ()

Public Member Functions
QString	GetCacheLocation () const
DBThreadRef	GetDBThread () const
QString	GetIconDirectory () const
MapDownloaderRef	GetMapDownloader ()
MapManagerRef	GetMapManager () const
size_t	GetOnlineTileCacheSize () const
SettingsRef	GetSettings () const
QString	GetUserAgent () const
VoiceManagerRef	GetVoiceManager ()
ElevationModule *	MakeElevationModule ()
IconLookup *	MakeIconLookup ()
LookupModule *	MakeLookupModule ()
MapRenderer *	MakeMapRenderer (RenderingType type)
NavigationModule *	MakeNavigation ()
POILookupModule *	MakePOILookupModule ()
Router *	MakeRouter ()
SearchModule *	MakeSearchModule ()
StyleModule *	MakeStyleModule ()
QThread *	makeThread (QString name)
	Create new background thread with given name.
bool	waitForReleasingResources (unsigned long mSleep, unsigned long maxCount) const
	Wait for releasing of dbThread shared pointer from other threads and terminating all created service threads.
	~OSMScoutQt () override

Static Public Member Functions
static void	FreeInstance ()
static OSMScoutQt &	GetInstance ()
static OSMScoutQtBuilder	NewInstance ()
static void	RegisterQmlTypes (const char *uri="net.sf.libosmscout.map", int versionMajor=1, int versionMinor=0)

Friends
class	OSMScoutQtBuilder

Detailed Description

Singleton that provides access to high level modules of OSMScout library.

On application start should be registered Qt types by static method RegisterQmlTypes(). OSMScoutQt instance may be created by NewInstance() and accessed by GetInstance() then. To free resources should be called FreeInstance() before program exits.

Example:

OSMScoutQt::RegisterQmlTypes();
 
bool success=OSMScoutQt::NewInstance()
     .WithBasemapLookupDirectory(basemapDir)
     .WithStyleSheetDirectory(stylesheetDir)
     .WithStyleSheetFile(stylesheetFileName)
     .WithIconDirectory(iconDirectory)
     .WithMapLookupDirectories(mapLookupDirectories)
     .AddOnlineTileProviders(":/resources/online-tile-providers.json")
     .AddMapProviders(":/resources/map-providers.json")
     .Init();
 
if (!success){
  // terminate program, or just report error - something is really bad
}
 
// now it is possible to access OSMScoutQt by OSMScoutQt::GetInstance()
 
OSMScoutQt::FreeInstance();

Constructor & Destructor Documentation

~OSMScoutQt()

osmscout::OSMScoutQt::~OSMScoutQt ( )

override

Member Function Documentation

FreeInstance()

void osmscout::OSMScoutQt::FreeInstance ( )

static

References osmscout::Log::Debug(), osmscout::log, osmscout::osmScoutInstance, waitForReleasingResources(), and osmscout::Log::Warn().

GetCacheLocation()

QString osmscout::OSMScoutQt::GetCacheLocation

(

)

const

Referenced by osmscout::TileLoaderThread::init().

GetDBThread()

DBThreadRef osmscout::OSMScoutQt::GetDBThread

(

)

const

Referenced by osmscout::MapWidget::firstStylesheetErrorColumn(), osmscout::MapWidget::firstStylesheetErrorDescription(), osmscout::MapWidget::firstStylesheetErrorLine(), osmscout::MapWidget::GetStylesheetFilename(), osmscout::MapWidget::isDatabaseLoaded(), osmscout::MapWidget::isInDatabaseBoundingBox(), osmscout::MapWidget::MapWidget(), osmscout::MapWidget::recenter(), osmscout::MapWidget::reloadStyle(), osmscout::MapWidget::reloadTmpStyle(), osmscout::LookupModule::requestLocationDescription(), osmscout::LookupModule::requestRegionLookup(), osmscout::SearchModule::SearchForLocations(), osmscout::MapWidget::stylesheetHasErrors(), osmscout::TiledMapOverlay::TiledMapOverlay(), and osmscout::MapWidget::toggleDaylight().

GetIconDirectory()

QString osmscout::OSMScoutQt::GetIconDirectory

(

)

const

GetInstance()

OSMScoutQt & osmscout::OSMScoutQt::GetInstance ( )

static

References osmscout::osmScoutInstance.

Referenced by osmscout::AvailableMapsModel::AvailableMapsModel(), osmscout::AvailableVoicesModel::AvailableVoicesModel(), osmscout::OsmTileDownloader::download(), osmscout::ElevationChartWidget::ElevationChartWidget(), osmscout::MapWidget::firstStylesheetErrorColumn(), osmscout::MapWidget::firstStylesheetErrorDescription(), osmscout::MapWidget::firstStylesheetErrorLine(), osmscout::MapDownloadsModel::getLookupDirectories(), osmscout::MapStyleModel::getStyle(), osmscout::MapWidget::GetStylesheetFilename(), osmscout::TileLoaderThread::init(), osmscout::InstalledMapsModel::InstalledMapsModel(), osmscout::InstalledVoicesModel::InstalledVoicesModel(), osmscout::MapWidget::isDatabaseLoaded(), osmscout::MapWidget::isInDatabaseBoundingBox(), osmscout::LocationInfoModel::LocationInfoModel(), osmscout::LocationListModel::LocationListModel(), osmscout::MapDownloadsModel::MapDownloadsModel(), osmscout::MapObjectInfoModel::MapObjectInfoModel(), osmscout::MapStyleModel::MapStyleModel(), osmscout::MapWidget::MapWidget(), osmscout::NavigationModel::NavigationModel(), osmscout::NearPOIModel::NearPOIModel(), osmscout::QmlSettings::QmlSettings(), osmscout::MapWidget::recenter(), osmscout::AvailableMapsModel::reload(), osmscout::AvailableVoicesModel::reload(), osmscout::VoiceManager::reload(), osmscout::MapWidget::reloadStyle(), osmscout::MapWidget::reloadTmpStyle(), osmscout::LookupModule::requestLocationDescription(), osmscout::LookupModule::requestRegionLookup(), osmscout::RoutingListModel::RoutingListModel(), osmscout::SearchModule::SearchForLocations(), osmscout::StyleFlagsModel::setFlag(), osmscout::MapWidget::setInteractiveIcons(), osmscout::MapStyleModel::setStyle(), osmscout::FileDownloader::startDownload(), osmscout::StyleFlagsModel::StyleFlagsModel(), osmscout::MapWidget::stylesheetHasErrors(), osmscout::MapDownloadsModel::suggestedDirectory(), osmscout::TiledMapOverlay::TiledMapOverlay(), osmscout::MapWidget::toggleDaylight(), and osmscout::VoiceManager::VoiceManager().

GetMapDownloader()

MapDownloaderRef osmscout::OSMScoutQt::GetMapDownloader

(

)

Referenced by osmscout::MapDownloadsModel::MapDownloadsModel().

GetMapManager()

MapManagerRef osmscout::OSMScoutQt::GetMapManager

(

)

const

Referenced by osmscout::MapDownloadsModel::getLookupDirectories(), osmscout::InstalledMapsModel::InstalledMapsModel(), and osmscout::MapDownloadsModel::suggestedDirectory().

GetOnlineTileCacheSize()

size_t osmscout::OSMScoutQt::GetOnlineTileCacheSize

(

)

const

GetSettings()

SettingsRef osmscout::OSMScoutQt::GetSettings

(

)

const

Referenced by osmscout::AvailableMapsModel::AvailableMapsModel(), osmscout::AvailableVoicesModel::AvailableVoicesModel(), osmscout::ElevationChartWidget::ElevationChartWidget(), osmscout::TileLoaderThread::init(), osmscout::InstalledVoicesModel::InstalledVoicesModel(), osmscout::LocationInfoModel::LocationInfoModel(), osmscout::LocationListModel::LocationListModel(), osmscout::MapObjectInfoModel::MapObjectInfoModel(), osmscout::MapStyleModel::MapStyleModel(), osmscout::MapWidget::MapWidget(), osmscout::NearPOIModel::NearPOIModel(), osmscout::QmlSettings::QmlSettings(), osmscout::VoiceManager::reload(), osmscout::StyleFlagsModel::setFlag(), osmscout::MapStyleModel::setStyle(), and osmscout::VoiceManager::VoiceManager().

GetUserAgent()

QString osmscout::OSMScoutQt::GetUserAgent

(

)

const

GetVoiceManager()

VoiceManagerRef osmscout::OSMScoutQt::GetVoiceManager

(

)

Referenced by osmscout::AvailableVoicesModel::AvailableVoicesModel(), and osmscout::InstalledVoicesModel::InstalledVoicesModel().

MakeElevationModule()

ElevationModule * osmscout::OSMScoutQt::MakeElevationModule

(

)

References makeThread().

Referenced by osmscout::ElevationChartWidget::ElevationChartWidget().

MakeIconLookup()

IconLookup * osmscout::OSMScoutQt::MakeIconLookup

(

)

References makeThread().

Referenced by osmscout::MapWidget::setInteractiveIcons().

MakeLookupModule()

LookupModule * osmscout::OSMScoutQt::MakeLookupModule

(

)

References makeThread().

Referenced by osmscout::LocationInfoModel::LocationInfoModel(), osmscout::LocationListModel::LocationListModel(), and osmscout::MapObjectInfoModel::MapObjectInfoModel().

MakeMapRenderer()

MapRenderer * osmscout::OSMScoutQt::MakeMapRenderer

(

RenderingType

type

)

References makeThread(), and osmscout::TiledRendering.

MakeNavigation()

NavigationModule * osmscout::OSMScoutQt::MakeNavigation

(

)

References makeThread().

Referenced by osmscout::NavigationModel::NavigationModel().

MakePOILookupModule()

POILookupModule * osmscout::OSMScoutQt::MakePOILookupModule

(

)

Referenced by osmscout::NearPOIModel::NearPOIModel().

MakeRouter()

Router * osmscout::OSMScoutQt::MakeRouter

(

)

References makeThread().

Referenced by osmscout::RoutingListModel::RoutingListModel().

MakeSearchModule()

SearchModule * osmscout::OSMScoutQt::MakeSearchModule

(

)

References makeThread().

Referenced by osmscout::LocationListModel::LocationListModel().

MakeStyleModule()

StyleModule * osmscout::OSMScoutQt::MakeStyleModule

(

)

References makeThread().

Referenced by osmscout::MapStyleModel::MapStyleModel(), and osmscout::StyleFlagsModel::StyleFlagsModel().

makeThread()

QThread * osmscout::OSMScoutQt::makeThread

(

QString

name

)

Create new background thread with given name.

Usage:

QThread *t=OSMScoutQt::GetInstance().makeThread("OverlayTileLoader"); Service *service=new Service(t); service->moveToThread(thread); connect(thread, SIGNAL(started()), service, SLOT(init())); thread->start();

Service should stop thread in own destructor: QThread::stop()

Parameters

name

Returns

thread

References threadFinished().

Referenced by MakeElevationModule(), MakeIconLookup(), MakeLookupModule(), MakeMapRenderer(), MakeNavigation(), MakeRouter(), MakeSearchModule(), MakeStyleModule(), and osmscout::TiledMapOverlay::TiledMapOverlay().

NewInstance()

OSMScoutQtBuilder osmscout::OSMScoutQt::NewInstance ( )

static

References OSMScoutQtBuilder.

RegisterQmlTypes()

void osmscout::OSMScoutQt::RegisterQmlTypes ( const char *  uri = "net.sf.libosmscout.map", int  versionMajor = 1, int  versionMinor = 0  )

static

threadFinished

void osmscout::OSMScoutQt::threadFinished ( )

slot

Referenced by makeThread().

waitForReleasingResources()

bool osmscout::OSMScoutQt::waitForReleasingResources	(	unsigned long	mSleep,
		unsigned long	maxCount
	)		const

Wait for releasing of dbThread shared pointer from other threads and terminating all created service threads.

This waiting has configurable timeout, up to [mSleep * maxCount] milliseconds.

Note that on success, this method don't guarantee that dbThread is not used from another thread, see std::shared_ptr::use_count() documentation.

Parameters

mSleep	wait period between checks (in milliseconds)
maxCount	maximul count

Returns

true if dbThread is holding just from current thread (dbThread.use_count() == 1) and all previously created service threads are terminated.

Referenced by FreeInstance().

Friends And Related Symbol Documentation

OSMScoutQtBuilder

friend class OSMScoutQtBuilder

friend

Referenced by NewInstance().

---

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

• OSMScoutQt.h
• OSMScoutQt.cpp