gz/sim/components/Serialization.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_SIM_COMPONENTS_SERIALIZATION_HH_
#define GZ_SIM_COMPONENTS_SERIALIZATION_HH_
 
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
 
#include <google/protobuf/message_lite.h>
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
 
#include <gz/msgs/double_v.pb.h>
 
#include <string>
#include <vector>
#include <sdf/Sensor.hh>
 
#include <gz/sim/Conversions.hh>
#include <gz/msgs/Utility.hh>
 
// This header holds serialization operators which are shared among several
// components
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace traits
{
  template <typename In, typename Out>
  class HasGazeboConvert
  {
    private: template <typename InArg, typename OutArg>
    static auto Test(int _test)
        -> decltype(std::declval<OutArg>() =
           gz::sim::convert<OutArg>(std::declval<const InArg &>()),
           std::true_type());
 
    private: template <typename, typename>
    static auto Test(...) -> std::false_type;
 
    public: static constexpr bool value =  // NOLINT
                decltype(Test<In, Out>(true))::value;
  };
}
 
namespace serializers
{
  template <typename DataType, typename MsgType>
  class ComponentToMsgSerializer
  {
    public: static std::ostream &Serialize(std::ostream &_out,
                                           const DataType &_data)
    {
      MsgType msg;
      // cppcheck-suppress syntaxError
      if constexpr (traits::HasGazeboConvert<DataType, MsgType>::value)
      {
        msg = gz::sim::convert<MsgType>(_data);
      }
      else
      {
        msg = gz::msgs::Convert(_data);
      }
 
      msg.SerializeToOstream(&_out);
      return _out;
    }
 
    public: static std::istream &Deserialize(std::istream &_in,
                                             DataType &_data)
    {
      MsgType msg;
      msg.ParseFromIstream(&_in);
 
      if constexpr (traits::HasGazeboConvert<MsgType, DataType>::value)
      {
        _data = gz::sim::convert<DataType>(msg);
      }
      else
      {
        _data = gz::msgs::Convert(msg);
      }
      return _in;
    }
  };
 
  using SensorSerializer = ComponentToMsgSerializer<sdf::Sensor, msgs::Sensor>;
 
  class VectorDoubleSerializer
  {
    public: static std::ostream &Serialize(std::ostream &_out,
                                           const std::vector<double> &_vec)
    {
      gz::msgs::Double_V msg;
      *msg.mutable_data() = {_vec.begin(), _vec.end()};
      msg.SerializeToOstream(&_out);
      return _out;
    }
 
    public: static std::istream &Deserialize(std::istream &_in,
                                             std::vector<double> &_vec)
    {
      gz::msgs::Double_V msg;
      msg.ParseFromIstream(&_in);
 
      _vec = {msg.data().begin(), msg.data().end()};
      return _in;
    }
  };
 
  class MsgSerializer
  {
    public: static std::ostream &Serialize(std::ostream &_out,
        const google::protobuf::Message &_msg)
    {
      _msg.SerializeToOstream(&_out);
      return _out;
    }
 
    public: static std::istream &Deserialize(std::istream &_in,
        google::protobuf::Message &_msg)
    {
      _msg.ParseFromIstream(&_in);
      return _in;
    }
  };
 
  class StringSerializer
  {
    public: static std::ostream &Serialize(std::ostream &_out,
        const std::string &_data)
    {
      _out << _data;
      return _out;
    }
 
    public: static std::istream &Deserialize(std::istream &_in,
        std::string &_data)
    {
      _data = std::string(std::istreambuf_iterator<char>(_in), {});
      return _in;
    }
  };
 
  template <typename T>
  class VectorSerializer
  {
    public: static std::ostream &Serialize(std::ostream &_out,
      const std::vector<T> &_data)
    {
      _out << _data.size();
      for (const auto& datum : _data)
        _out << " " << datum;
      return _out;
    }
 
    public: static std::istream &Deserialize(std::istream &_in,
      std::vector<T> &_data)
    {
      size_t size;
      _in >> size;
      _data.resize(size);
      for (size_t i = 0; i < size; ++i)
      {
        _in >> _data[i];
      }
      return _in;
    }
  };
}
}
}
}
 
#endif