interface.h

Go to the documentation of this file.

// Copyright 2013-2025:
//   GobySoft, LLC (2013-)
//   Massachusetts Institute of Technology (2007-2014)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//   Henrik Schmidt <henrik@mit.edu>
//
//
// 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_FRONTSEAT_INTERFACE_H
#define GOBY_MIDDLEWARE_FRONTSEAT_INTERFACE_H
 
#include <memory> // for unique_ptr
#include <string> // for string
 
#include <boost/signals2/signal.hpp>      // for signal
#include <boost/smart_ptr/shared_ptr.hpp> // for shared_ptr
 
#include "goby/middleware/protobuf/frontseat.pb.h"        // for InterfaceS...
#include "goby/middleware/protobuf/frontseat_config.pb.h" // for Config
#include "goby/time/types.h"                              // for MicroTime
#include "goby/util/geodesy.h"                            // for UTMGeodesy
 
namespace goby
{
namespace apps
{
namespace moos
{
class FrontSeatLegacyTranslator;
}
} // namespace apps
namespace middleware
{
namespace frontseat
{
namespace protobuf
{
class CTDSample;
class NodeStatus;
} // namespace protobuf
 
class InterfaceBase
{
  public:
    InterfaceBase(protobuf::Config cfg);
 
    virtual ~InterfaceBase() = default;
 
    virtual void send_command_to_frontseat(const protobuf::CommandRequest& command) = 0;
    virtual void send_data_to_frontseat(const protobuf::InterfaceData& data) = 0;
    virtual void send_raw_to_frontseat(const protobuf::Raw& data) = 0;
 
    virtual protobuf::FrontSeatState frontseat_state() const = 0;
    virtual bool frontseat_providing_data() const = 0;
 
    void set_helm_state(protobuf::HelmState state) { helm_state_ = state; }
    protobuf::HelmState helm_state() const { return helm_state_; }
    protobuf::InterfaceState state() const { return state_; }
 
    void do_work();
 
    protobuf::InterfaceStatus status()
    {
        protobuf::InterfaceStatus s;
        s.set_state(state_);
        s.set_frontseat_state(frontseat_state());
        s.set_helm_state(helm_state_);
        if (last_helm_error_ != protobuf::ERROR_HELM_NONE)
            s.set_helm_error(last_helm_error_);
        if (last_frontseat_error_ != protobuf::ERROR_FRONTSEAT_NONE)
            s.set_frontseat_error(last_frontseat_error_);
        s.set_frontseat_providing_data(frontseat_providing_data());
        return s;
    }
 
    // Called at the AppTick frequency of iFrontSeat
    // Here is where you can process incoming data
    virtual void loop() = 0;
 
    // Signals that iFrontseat connects to
    // call this with data from the Frontseat
    boost::signals2::signal<void(const protobuf::CommandResponse& data)> signal_command_response;
    boost::signals2::signal<void(const protobuf::InterfaceData& data)> signal_data_from_frontseat;
    boost::signals2::signal<void(const protobuf::Raw& data)> signal_raw_from_frontseat;
    boost::signals2::signal<void(const protobuf::Raw& data)> signal_raw_to_frontseat;
 
    const protobuf::Config& cfg() const { return cfg_; }
 
    void compute_missing(protobuf::CTDSample* ctd_sample);
    void compute_missing(protobuf::NodeStatus* status);
 
    // Dynamic UTM update
    void update_utm_datum(goby::util::UTMGeodesy::LatLonPoint datum);
 
    friend class goby::apps::moos::FrontSeatLegacyTranslator; // to access the signal_state_change
  private:
    void check_error_states();
    void check_change_state();
 
    // Signals called by InterfaceBase directly. No need to call these
    // from the Frontseat driver implementation
    boost::signals2::signal<void(protobuf::InterfaceState state)> signal_state_change;
 
    enum Direction
    {
        DIRECTION_TO_FRONTSEAT,
        DIRECTION_FROM_FRONTSEAT
    };
 
    void glog_raw(const protobuf::Raw& data, Direction direction);
 
  private:
    protobuf::Config cfg_;
    protobuf::HelmState helm_state_;
    protobuf::InterfaceState state_;
    goby::time::MicroTime start_time_;
    protobuf::FrontSeatError last_frontseat_error_;
    protobuf::HelmError last_helm_error_;
 
    std::unique_ptr<goby::util::UTMGeodesy> geodesy_;
 
    
    std::string glog_out_group_, glog_in_group_;
};
} // namespace frontseat
} // namespace middleware
} // namespace goby
 
#endif