log_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_LOG_PLUGIN_H
#define GOBY_MIDDLEWARE_LOG_LOG_PLUGIN_H
 
#include "goby/middleware/log/log_entry.h"
#include "goby/middleware/marshalling/interface.h"
#include "goby/middleware/marshalling/json.h"
#include "goby/middleware/protobuf/log_tool_config.pb.h"
 
#include "goby/middleware/log/hdf5/hdf5_plugin.h"
 
namespace goby
{
namespace middleware
{
namespace log
{
class LogPlugin
{
  public:
    LogPlugin() {}
    virtual ~LogPlugin() {}
 
    virtual void register_write_hooks(std::ofstream& out_log_file) = 0;
    virtual void register_read_hooks(const std::ifstream& in_log_file) = 0;
 
    virtual std::string debug_text_message(LogEntry& log_entry)
    {
        throw(log::LogException("DEBUG_TEXT is not supported by the scheme's plugin"));
    }
 
    virtual std::vector<goby::middleware::HDF5ProtobufEntry> hdf5_entry(LogEntry& log_entry)
    {
        throw(log::LogException("HDF5 is not supported by the scheme's plugin"));
    }
 
    virtual std::shared_ptr<nlohmann::json> json_message(LogEntry& log_entry)
    {
        throw(log::LogException("JSON is not supported by the scheme's plugin"));
    }
};
 
} // namespace log
} // namespace middleware
} // namespace goby
 
#endif