Goby3  3.1.5a
2024.05.23
goby::middleware::frontseat::InterfaceBase Class Referenceabstract

#include <goby/middleware/frontseat/interface.h>

Inheritance diagram for goby::middleware::frontseat::InterfaceBase:
goby::middleware::frontseat::BasicSimulatorFrontSeatInterface goby::middleware::frontseat::Bluefin goby::middleware::frontseat::Iver goby::middleware::frontseat::WavegliderSV2

Public Member Functions

 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)
 
protobuf::HelmState helm_state () const
 
protobuf::InterfaceState state () const
 
void do_work ()
 
protobuf::InterfaceStatus status ()
 
virtual void loop ()=0
 
const protobuf::Configcfg () const
 
void compute_missing (protobuf::CTDSample *ctd_sample)
 
void compute_missing (protobuf::NodeStatus *status)
 
void update_utm_datum (goby::util::UTMGeodesy::LatLonPoint datum)
 

Public Attributes

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
 

Friends

class goby::apps::moos::FrontSeatLegacyTranslator
 

Detailed Description

Definition at line 59 of file interface.h.

Constructor & Destructor Documentation

◆ InterfaceBase()

goby::middleware::frontseat::InterfaceBase::InterfaceBase ( protobuf::Config  cfg)

◆ ~InterfaceBase()

virtual goby::middleware::frontseat::InterfaceBase::~InterfaceBase ( )
virtualdefault

Member Function Documentation

◆ cfg()

const protobuf::Config& goby::middleware::frontseat::InterfaceBase::cfg ( ) const
inline

Definition at line 103 of file interface.h.

◆ compute_missing() [1/2]

void goby::middleware::frontseat::InterfaceBase::compute_missing ( protobuf::CTDSample ctd_sample)

◆ compute_missing() [2/2]

void goby::middleware::frontseat::InterfaceBase::compute_missing ( protobuf::NodeStatus status)

◆ do_work()

void goby::middleware::frontseat::InterfaceBase::do_work ( )

◆ frontseat_providing_data()

virtual bool goby::middleware::frontseat::InterfaceBase::frontseat_providing_data ( ) const
pure virtual

◆ frontseat_state()

virtual protobuf::FrontSeatState goby::middleware::frontseat::InterfaceBase::frontseat_state ( ) const
pure virtual

◆ helm_state()

protobuf::HelmState goby::middleware::frontseat::InterfaceBase::helm_state ( ) const
inline

Definition at line 74 of file interface.h.

◆ loop()

virtual void goby::middleware::frontseat::InterfaceBase::loop ( )
pure virtual

◆ send_command_to_frontseat()

virtual void goby::middleware::frontseat::InterfaceBase::send_command_to_frontseat ( const protobuf::CommandRequest command)
pure virtual

◆ send_data_to_frontseat()

virtual void goby::middleware::frontseat::InterfaceBase::send_data_to_frontseat ( const protobuf::InterfaceData data)
pure virtual

◆ send_raw_to_frontseat()

virtual void goby::middleware::frontseat::InterfaceBase::send_raw_to_frontseat ( const protobuf::Raw data)
pure virtual

◆ set_helm_state()

void goby::middleware::frontseat::InterfaceBase::set_helm_state ( protobuf::HelmState  state)
inline

Definition at line 73 of file interface.h.

◆ state()

protobuf::InterfaceState goby::middleware::frontseat::InterfaceBase::state ( ) const
inline

Definition at line 75 of file interface.h.

◆ status()

protobuf::InterfaceStatus goby::middleware::frontseat::InterfaceBase::status ( )
inline

Definition at line 79 of file interface.h.

◆ update_utm_datum()

void goby::middleware::frontseat::InterfaceBase::update_utm_datum ( goby::util::UTMGeodesy::LatLonPoint  datum)

Friends And Related Function Documentation

◆ goby::apps::moos::FrontSeatLegacyTranslator

friend class goby::apps::moos::FrontSeatLegacyTranslator
friend

Definition at line 111 of file interface.h.

Member Data Documentation

◆ signal_command_response

boost::signals2::signal<void(const protobuf::CommandResponse& data)> goby::middleware::frontseat::InterfaceBase::signal_command_response

Definition at line 98 of file interface.h.

◆ signal_data_from_frontseat

boost::signals2::signal<void(const protobuf::InterfaceData& data)> goby::middleware::frontseat::InterfaceBase::signal_data_from_frontseat

Definition at line 99 of file interface.h.

◆ signal_raw_from_frontseat

boost::signals2::signal<void(const protobuf::Raw& data)> goby::middleware::frontseat::InterfaceBase::signal_raw_from_frontseat

Definition at line 100 of file interface.h.

◆ signal_raw_to_frontseat

boost::signals2::signal<void(const protobuf::Raw& data)> goby::middleware::frontseat::InterfaceBase::signal_raw_to_frontseat

Definition at line 101 of file interface.h.


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