qgeopositioninfosourcefactory.cpp

/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qgeopositioninfosourcefactory.h"

QTM_BEGIN_NAMESPACE

/*!
  \class QGeoPositionInfoSourceFactory

  \brief The QGeoPositionInfoSourceFactory class is a factory class used
  as the plugin interface for external providers of positioning data.

  \inmodule QtLocation

  \ingroup location
  \since 1.2

  Implementers must provide a unique combination of sourceName() and
  sourceVersion() per plugin.

  The other functions must be overridden by all plugins, other than
  sourcePriority() which defaults to returning 0. Higher values of
  priority will be preferred to lower ones.

  \section1 Default plugins

  Normally, the platform default position source will always overrule any
  plugin-based position source during a call to createDefaultSource().
  However, a limited measure is available where needed to change this behaviour,
  using a system-wide configuration file.

  The configuration file is in the system's default QSettings format, under
  \c Nokia/QtLocationPosAndSat (for example, on most Linux variants this is
  \c /etc/xdg/Nokia/QtLocationPosAndSat.conf). To set a default plugin source,
  set the value \c position.plugin.operator.whitelist to a string of the format
  \c "name,filename,hash,size" where \a name is the same as returned by the
  plugin's \c sourceName() function, \a size is the size of the shared library
  and \a hash is the library's SHA1 hash in hex format.
  */

/*!
  \fn QGeoPositionInfoSource *QGeoPositionInfoSourceFactory::positionInfoSource(QObject *parent)

  Returns a new QGeoPositionInfoSource associated with this plugin
  with parent \a parent . Can also return 0, in which case the factory
  with the next highest priority will be used instead.
  */

/*!
  \fn QGeoSatelliteInfoSource *QGeoPositionInfoSourceFactory::satelliteInfoSource(QObject *parent)

  Returns a new QGeoSatelliteInfoSource associated with this plugin
  with parent \a parent. Can also return 0, in which case the factory
  with the next highest priority will be used instead.
  */

/*!
  \fn QString QGeoPositionInfoSourceFactory::sourceName() const

  Returns the string used to identify the position provider behind this
  implementation.

  The combination of sourceName() and sourceVersion() should be unique
  amongst the plugins.
  */

/*!
  \fn int QGeoPositionInfoSourceFactory::sourceVersion() const

  Returns the version of the plugin.

  The combination of sourceName() and sourceVersion() should be unique
  amongst the plugins.
  */

/*!
  Returns the priority of this factory in the list of available
  factories. Factories with higher values of priority will be preferred
  to those with lower values.
  */
int QGeoPositionInfoSourceFactory::sourcePriority() const
{
    return 0;
}

/*!
    Destroys the position info source factory.
*/
QGeoPositionInfoSourceFactory::~QGeoPositionInfoSourceFactory()
{}

QTM_END_NAMESPACE