gz/msgs/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_
 
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4100 4512 4127 4068 4244 4267 4251 4146)
#endif
#include <google/protobuf/message.h>
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#include <string>
#include <map>
#include <memory>
#include <vector>
 
#include "gz/msgs/config.hh"
#include "gz/msgs/Export.hh"
 
namespace gz
{
  namespace msgs
  {
    // Inline bracket to help doxygen filtering.
    inline namespace GZ_MSGS_VERSION_NAMESPACE {
    //
    typedef std::unique_ptr<google::protobuf::Message> (*FactoryFn) ();
 
    class GZ_MSGS_VISIBLE Factory
    {
      public: static void Register(const std::string &_msgType,
                                   FactoryFn _factoryfn);
 
      public: template<typename T>
              static std::unique_ptr<T> New(const std::string &_msgType)
              {
                auto msgType = _msgType;
                if (msgType.find("ignition") == 0)
                {
                  msgType.replace(0, 8, "gz");
                  std::cerr << "Trying to create deprecated message type ["
                            << _msgType << "]. Using [" << msgType
                            << "] instead." << std::endl;
                }
                return std::unique_ptr<T>(
                    static_cast<T*>(New(msgType).release()));
              }
 
      public: template<typename T>
              static std::unique_ptr<T> New(const std::string &_msgType,
                  const std::string &_args)
              {
                auto msgType = _msgType;
                if (msgType.find("ignition") == 0)
                {
                  msgType.replace(0, 8, "gz");
                  std::cerr << "Trying to create deprecated message type ["
                            << _msgType << "]. Using [" << msgType
                            << "] instead." << std::endl;
                }
                return std::unique_ptr<T>(
                    static_cast<T*>(New(msgType, _args).release()));
              }
 
      public: static std::unique_ptr<google::protobuf::Message> New(
                  const std::string &_msgType);
 
      public: static std::unique_ptr<google::protobuf::Message> 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);
 
      private: static std::map<std::string, FactoryFn> *msgMap;
    };
 
    #define GZ_REGISTER_STATIC_MSG(_msgtype, _classname) \
    GZ_MSGS_VISIBLE \
    std::unique_ptr<google::protobuf::Message> New##_classname() \
    { \
      return std::unique_ptr<gz::msgs::_classname>(\
          new gz::msgs::_classname); \
    } \
    class GZ_MSGS_VISIBLE GzMsg##_classname \
    { \
      public: GzMsg##_classname() \
      { \
        gz::msgs::Factory::Register(_msgtype, New##_classname);\
      } \
    }; \
    static GzMsg##_classname GzMessagesInitializer##_classname;
    }
  }
}
#endif