hdf5_plugin.h

Go to the documentation of this file.

// Copyright 2016-2022:
//   GobySoft, LLC (2013-)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//
//
// This file is part of the Goby Underwater Autonomy Project Libraries
// ("The Goby Libraries").
//
// The Goby Libraries are free software: you can redistribute them and/or modify
// them under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// The Goby Libraries are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Goby.  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef GOBY_MIDDLEWARE_LOG_HDF5_HDF5_PLUGIN_H
#define GOBY_MIDDLEWARE_LOG_HDF5_HDF5_PLUGIN_H
 
#include <google/protobuf/descriptor.h>
#include <google/protobuf/message.h>
 
#include <memory>
 
#include "goby/middleware/protobuf/hdf5.pb.h"
#include "goby/time/types.h"
#include "goby/util/primitive_types.h"
 
namespace goby
{
namespace middleware
{
struct HDF5ProtobufEntry
{
    std::string channel;
    time::MicroTime time{0 * boost::units::si::seconds};
    std::shared_ptr<google::protobuf::Message> msg;
 
    int scheme{-1};
 
    HDF5ProtobufEntry() = default;
 
    void clear()
    {
        channel.clear();
        time = time::MicroTime(0 * boost::units::si::seconds);
        msg.reset();
    }
};
 
inline std::ostream& operator<<(std::ostream& os, const HDF5ProtobufEntry& entry)
{
    os << "@" << entry.time.value() << ": ";
    os << "/" << entry.channel;
    if (entry.msg)
    {
        os << "/" << entry.msg->GetDescriptor()->full_name();
        os << " " << entry.msg->ShortDebugString();
    }
    return os;
}
 
class HDF5Plugin
{
  public:
    HDF5Plugin(const goby::middleware::protobuf::HDF5Config* cfg) {}
    virtual ~HDF5Plugin() = default;
 
    virtual bool provide_entry(HDF5ProtobufEntry* entry) = 0;
};
} // namespace middleware
} // namespace goby
 
#endif