gz/sensors/SensorFactory.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_SENSORS_SENSORFACTORY_HH_
#define GZ_SENSORS_SENSORFACTORY_HH_
 
#include <memory>
#include <string>
#include <type_traits>
#include <sdf/sdf.hh>
 
#include <gz/common/Console.hh>
#include <gz/common/SuppressWarning.hh>
 
#include <gz/sensors/config.hh>
#include <gz/sensors/Export.hh>
 
#include "gz/sensors/Sensor.hh"
 
namespace ignition
{
  namespace sensors
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_SENSORS_VERSION_NAMESPACE {
    // forward declaration
    class SensorFactoryPrivate;
 
    class IGNITION_SENSORS_VISIBLE SensorPlugin
    {
      public: virtual Sensor IGN_DEPRECATED(6) * New() = 0;
    };
 
    template<class SensorType>
    class SensorTypePlugin : public SensorPlugin
    {
      // Documentation inherited
      public: SensorType IGN_DEPRECATED(6) * New() override
              {
                return new SensorType();
              };
    };
 
    // After removing plugin functionality, the sensor factory class doesn't
    // hold any internal state. Consider converting the functionality in this
    // class to helper functions.
    class IGNITION_SENSORS_VISIBLE SensorFactory
    {
      public: SensorFactory();
 
      public: ~SensorFactory();
 
      public: template<typename SensorType>
              std::unique_ptr<SensorType> CreateSensor(const sdf::Sensor &_sdf)
              {
                auto sensor = std::make_unique<SensorType>();
 
                if (nullptr == sensor)
                {
                  ignerr << "Failed to create sensor [" << _sdf.Name()
                         << "] of type[" << _sdf.TypeStr() << "]" << std::endl;
                  return nullptr;
                }
 
                if (!sensor->Load(_sdf))
                {
                  ignerr << "Failed to load sensor [" << _sdf.Name()
                         << "] of type[" << _sdf.TypeStr() << "]" << std::endl;
                  return nullptr;
                }
 
                if (!sensor->Init())
                {
                  ignerr << "Failed to initialize sensor [" << _sdf.Name()
                         << "] of type[" << _sdf.TypeStr() << "]" << std::endl;
                  return nullptr;
                }
 
                return sensor;
              }
 
      public: template<typename SensorType>
              std::unique_ptr<SensorType> CreateSensor(sdf::ElementPtr _sdf)
              {
                if (nullptr == _sdf)
                {
                  ignerr << "Failed to create sensor, received null SDF "
                         << "pointer." << std::endl;
                  return nullptr;
                }
 
                auto sensor = std::make_unique<SensorType>();
 
                auto type = _sdf->Get<std::string>("type");
                auto name = _sdf->Get<std::string>("name");
 
                if (nullptr == sensor)
                {
                  ignerr << "Failed to create sensor [" << name
                         << "] of type[" << type << "]" << std::endl;
                  return nullptr;
                }
 
                if (!sensor->Load(_sdf))
                {
                  ignerr << "Failed to load sensor [" << name
                         << "] of type[" << type << "]" << std::endl;
                  return nullptr;
                }
 
                if (!sensor->Init())
                {
                  ignerr << "Failed to initialize sensor [" << name
                         << "] of type[" << type << "]" << std::endl;
                  return nullptr;
                }
 
                return sensor;
              }
 
      public: std::unique_ptr<Sensor> IGN_DEPRECATED(6) CreateSensor(
          sdf::ElementPtr _sdf);
 
      public: std::unique_ptr<Sensor> IGN_DEPRECATED(6) CreateSensor(
          const sdf::Sensor &_sdf);
 
      public: void IGN_DEPRECATED(6) AddPluginPaths(const std::string &_path);
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<SensorFactoryPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
    }
  }
}
 
#endif