Factory.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 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_MSGS_FACTORY_HH_
#define GZ_MSGS_FACTORY_HH_
 
#include <string>
#include <map>
#include <memory>
#include <vector>
 
#include "gz/msgs/config.hh"
#include "gz/msgs/Export.hh"
 
#include "gz/msgs/MessageFactory.hh"
 
namespace gz::msgs
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MSGS_VERSION_NAMESPACE {
 
  class GZ_MSGS_VISIBLE Factory
  {
    public: using MessagePtr = MessageFactory::MessagePtr;
 
    public: using FactoryFn = MessageFactory::FactoryFn;
 
    public: using FactoryFnCollection = MessageFactory::FactoryFnCollection;
 
    private: Factory() = default;
 
    public: Factory(const Factory&) = delete;
 
    public: void operator=(const Factory&) = delete;
 
    public: Factory(Factory&&) = delete;
 
    public: void operator=(Factory&&) = delete;
 
    public: static MessageFactory& Instance();
 
    public: static void Register(const std::string &_msgType,
                                 FactoryFn _factoryfn);
 
    public: template<typename T>
            static std::unique_ptr<T> New(const std::string &_msgType)
            {
              return Factory::Instance().New<T>(_msgType);
            }
 
    public: template<typename T>
            static std::unique_ptr<T> New(const std::string &_msgType,
                const std::string &_args)
            {
              return Factory::Instance().New<T>(_msgType, _args);
            }
 
    public: static MessagePtr New(const std::string &_msgType);
 
    public: static MessagePtr
            New(const std::string &_msgType, const std::string &_args);
 
    public: static void Types(std::vector<std::string> &_types);
 
    public: static void LoadDescriptors(const std::string &_paths);
  };
}
}  // namespace gz::msgs
#endif