MessageFactory.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2023 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_MESSAGE_FACTORY_HH_
#define GZ_MSGS_MESSAGE_FACTORY_HH_
 
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <vector>
 
#include "gz/msgs/config.hh"
#include "gz/msgs/Export.hh"
#include "gz/msgs/MessageCastUtils.hh"
#include <gz/utils/ImplPtr.hh>
 
namespace gz::msgs {
  class DynamicFactory;
 
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MSGS_VERSION_NAMESPACE {
 
  class GZ_MSGS_VISIBLE MessageFactory
  {
    public: using Message = google::protobuf::Message;
 
    public: using MessagePtr = std::unique_ptr<Message>;
 
    public: using FactoryFn = std::function<MessagePtr(void)>;
 
    public: using FactoryFnCollection = std::map<std::string, FactoryFn>;
 
    public: MessageFactory();
 
    public: ~MessageFactory();
 
    public: void Register(const std::string &_msgType, FactoryFn _factoryFn);
 
    public: template<typename T>
            std::unique_ptr<T> New(const std::string &_msgType)
            {
              return DoDynamicCastMessage<T>(New(_msgType));
            }
 
    public: template<typename T>
            std::unique_ptr<T> New(const std::string &_msgType,
                const std::string &_args)
            {
              return DoDynamicCastMessage<T>(New(_msgType, _args));
            }
 
    public: MessagePtr New(const std::string &_msgType);
 
    public: MessagePtr New(
                const std::string &_msgType, const std::string &_args);
 
    public: void Types(std::vector<std::string> &_types);
 
    public: void LoadDescriptors(const std::string &_paths);
 
    private: FactoryFnCollection msgMap;
 
    GZ_UTILS_UNIQUE_IMPL_PTR_FWD(gz::msgs::DynamicFactory, dynamicFactory)
  };
}
}  // namespace gz::msgs
#endif  // GZ_MSGS_MESSAGE_FACTORY_HH_