provider_factory.h
Go to the documentation of this file.
/*
* Copyright © 2012-2013 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*/
#ifndef LOCATION_SERVICE_COM_LOMIRI_LOCATION_PROVIDER_FACTORY_H_
#define LOCATION_SERVICE_COM_LOMIRI_LOCATION_PROVIDER_FACTORY_H_
#include <com/lomiri/location/configuration.h>
#include <com/lomiri/location/provider.h>
#include <functional>
#include <map>
#include <memory>
#include <mutex>
#include <string>
namespace com
{
namespace lomiri
{
namespace location
{
class Provider;
class ProviderFactory
{
public:
typedef com::lomiri::location::Configuration Configuration;
typedef std::function<Provider::Ptr(const Configuration&)> Factory;
static ProviderFactory& instance();
// Makes the given factory functor known for the given name.
void add_factory_for_name(const std::string& name, const Factory& factory);
// Tries to lookup the factory for the given name, and create a provider instance
// by calling the factory and passing it the given config. Please note that the name
// can be decorated with @ for distinguishing providers of the same type but different configs.
// Eg.:
// --provider=remote::Provider@gps --remote::Provider@gps::name="com.ubuntu.android.gps.Provider" --remote::Provider@gps::path="/com/ubuntu/android/gps/Provider"
Provider::Ptr create_provider_for_name_with_config(const std::string& name, const Configuration& config);
// Async version of above.
void create_provider_for_name_with_config(const std::string& name, const Configuration& config, const std::function<void(Provider::Ptr)>& cb);
void enumerate(const std::function<void(const std::string&, const Factory&)>& enumerator);
static std::string extract_undecorated_name(const std::string& name);
private:
ProviderFactory() = default;
~ProviderFactory() = default;
ProviderFactory(const ProviderFactory&) = delete;
ProviderFactory& operator=(const ProviderFactory&) = delete;
std::mutex guard;
std::map<std::string, Factory> factory_store;
};
}
}
}
#endif // LOCATION_SERVICE_COM_LOMIRI_LOCATION_PROVIDER_FACTORY_H_
com::lomiri::location::ProviderFactory::instance
static ProviderFactory & instance()
com::lomiri::location::ProviderFactory::add_factory_for_name
void add_factory_for_name(const std::string &name, const Factory &factory)
com::lomiri::location::ProviderFactory::Factory
std::function< Provider::Ptr(const Configuration &)> Factory
Definition provider_factory.h:42
com::lomiri::location::ProviderFactory::create_provider_for_name_with_config
Provider::Ptr create_provider_for_name_with_config(const std::string &name, const Configuration &config)
com::lomiri::location::ProviderFactory::extract_undecorated_name
static std::string extract_undecorated_name(const std::string &name)
com::lomiri::location::ProviderFactory::enumerate
void enumerate(const std::function< void(const std::string &, const Factory &)> &enumerator)
com::lomiri::location::ProviderFactory::create_provider_for_name_with_config
void create_provider_for_name_with_config(const std::string &name, const Configuration &config, const std::function< void(Provider::Ptr)> &cb)
com::lomiri::location::ProviderFactory::Configuration
com::lomiri::location::Configuration Configuration
Definition provider_factory.h:41
com::lomiri::location::Provider
The Provider class is the abstract base of all positioning providers.
Definition provider.h:46
com::lomiri::location::Provider::Ptr
std::shared_ptr< Provider > Ptr
Definition provider.h:48
configuration.h
com::lomiri::location
Definition accuracy.h:28
com::lomiri::location::Configuration
boost::property_tree::ptree Configuration
Definition configuration.h:29
com::lomiri
Definition accuracy.h:26
com
Definition accuracy.h:24
provider.h