Superclass for implementing plugins for the goby_hdf5 tool for converting from Google Protocol Buffers messages to an HDF5 scientific data file. More...

#include <goby/middleware/log/hdf5/hdf5_plugin.h>

Public Member Functions
	HDF5Plugin (const goby::middleware::protobuf::HDF5Config *cfg)

virtual	~HDF5Plugin ()=default

virtual bool	provide_entry (HDF5ProtobufEntry *entry)=0
	Implement this function in the plugin to provide a single Protobuf message and related metadata to the goby_hdf5 tool. More...

Detailed Description

Superclass for implementing plugins for the goby_hdf5 tool for converting from Google Protocol Buffers messages to an HDF5 scientific data file.

Various plugins can read the Protobuf messages from different formats.

Definition at line 79 of file hdf5_plugin.h.

Constructor & Destructor Documentation

◆ HDF5Plugin()

goby::middleware::HDF5Plugin::HDF5Plugin ( const goby::middleware::protobuf::HDF5Config * cfg )

inline

Definition at line 82 of file hdf5_plugin.h.

◆ ~HDF5Plugin()

virtual goby::middleware::HDF5Plugin::~HDF5Plugin ( )

virtualdefault

Member Function Documentation

◆ provide_entry()

virtual bool goby::middleware::HDF5Plugin::provide_entry ( HDF5ProtobufEntry * entry )

pure virtual

Implement this function in the plugin to provide a single Protobuf message and related metadata to the goby_hdf5 tool.

Parameters

entry Pointer to HDF5ProtobufEntry that should be populated by the overriding method (in the plugin)

Returns: true if more data are available, false if no more data are available (end-of-file) or similar. goby_hdf5 will continue to call this method until it returns false.

The documentation for this class was generated from the following file: