Marble::RoutingRunnerPlugin Class Reference

#include <RoutingRunnerPlugin.h>

Inheritance diagram for Marble::RoutingRunnerPlugin:

Public Member Functions
	RoutingRunnerPlugin (QObject *parent=nullptr)
	~RoutingRunnerPlugin () override
virtual bool	canWork () const
bool	canWorkOffline () const
virtual ConfigWidget *	configWidget ()
virtual QString	guiString () const =0
QIcon	icon () const override
virtual RoutingRunner *	newRunner () const =0
QString	statusMessage () const
bool	supportsCelestialBody (const QString &celestialBodyId) const
virtual bool	supportsTemplate (RoutingProfilesModel::ProfileTemplate profileTemplate) const
virtual QHash< QString, QVariant >	templateSettings (RoutingProfilesModel::ProfileTemplate profileTemplate) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const
Public Member Functions inherited from Marble::PluginInterface
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QString	description () const =0
virtual QString	name () const =0
virtual QString	nameId () const =0
virtual QVector< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0

Protected Member Functions
void	setCanWorkOffline (bool canWorkOffline)
void	setStatusMessage (const QString &message)
void	setSupportedCelestialBodies (const QStringList &celestialBodies)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

A plugin for Marble to execute a routing task.

Definition at line 28 of file RoutingRunnerPlugin.h.

Constructor & Destructor Documentation

RoutingRunnerPlugin()

Marble::RoutingRunnerPlugin::RoutingRunnerPlugin ( QObject * parent = nullptr )

explicit

Constructor with optional parent object.

Definition at line 33 of file RoutingRunnerPlugin.cpp.

~RoutingRunnerPlugin()

Marble::RoutingRunnerPlugin::~RoutingRunnerPlugin ( )

override

Destructor.

Definition at line 39 of file RoutingRunnerPlugin.cpp.

Member Function Documentation

canWork()

bool Marble::RoutingRunnerPlugin::canWork ( ) const

virtual

Returns.

true 

if the plugin is able to perform its claimed task.

The default implementation returns

true 

. This method can be overridden for example to indicate an incomplete installation.

Definition at line 73 of file RoutingRunnerPlugin.cpp.

canWorkOffline()

bool Marble::RoutingRunnerPlugin::canWorkOffline

(

)

const

True if the plugin can execute its tasks without network access.

Definition at line 68 of file RoutingRunnerPlugin.cpp.

configWidget()

RoutingRunnerPlugin::ConfigWidget * Marble::RoutingRunnerPlugin::configWidget ( )

virtual

Method for getting a pointer to the configuration widget of the plugin.

Returns

The configuration widget or, if no configuration widget exists, 0.

Definition at line 78 of file RoutingRunnerPlugin.cpp.

guiString()

virtual QString Marble::RoutingRunnerPlugin::guiString ( ) const

pure virtual

Returns the string that should appear in the user interface.

For example, "OpenRouteService" should be returned for the OpenRouteService routing plugin.

icon()

QIcon Marble::RoutingRunnerPlugin::icon ( ) const

overridevirtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 44 of file RoutingRunnerPlugin.cpp.

newRunner()

virtual RoutingRunner * Marble::RoutingRunnerPlugin::newRunner ( ) const

pure virtual

Plugin factory method to create a new runner instance.

Method caller gets ownership of the returned object

setCanWorkOffline()

void Marble::RoutingRunnerPlugin::setCanWorkOffline ( bool canWorkOffline )

protected

Definition at line 63 of file RoutingRunnerPlugin.cpp.

setStatusMessage()

void Marble::RoutingRunnerPlugin::setStatusMessage ( const QString & message )

protected

Definition at line 98 of file RoutingRunnerPlugin.cpp.

setSupportedCelestialBodies()

void Marble::RoutingRunnerPlugin::setSupportedCelestialBodies ( const QStringList & celestialBodies )

protected

Definition at line 58 of file RoutingRunnerPlugin.cpp.

statusMessage()

QString Marble::RoutingRunnerPlugin::statusMessage

(

)

const

A status message showing whether the plugin will be able to deliver results.

Definition at line 93 of file RoutingRunnerPlugin.cpp.

supportsCelestialBody()

bool Marble::RoutingRunnerPlugin::supportsCelestialBody

(

const QString &

celestialBodyId

)

const

True if the plugin supports its tasks on the given planet.

Definition at line 49 of file RoutingRunnerPlugin.cpp.

supportsTemplate()

bool Marble::RoutingRunnerPlugin::supportsTemplate ( RoutingProfilesModel::ProfileTemplate profileTemplate ) const

virtual

True if the plugin supports the given routing profile template.

Definition at line 83 of file RoutingRunnerPlugin.cpp.

templateSettings()

QHash< QString, QVariant > Marble::RoutingRunnerPlugin::templateSettings ( RoutingProfilesModel::ProfileTemplate profileTemplate ) const

virtual

Settings for the given routing profile template.

Definition at line 88 of file RoutingRunnerPlugin.cpp.

---

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

• RoutingRunnerPlugin.h
• RoutingRunnerPlugin.cpp