Goby3  3.1.5a
2024.05.23
goby::moos Namespace Reference

Namespaces

 bluefin
 
 protobuf
 
 transitional
 
 ufld
 

Classes

class  BasicTranslator
 
class  BluefinCommsDriver
 provides a driver for the Bluefin Huxley communications infrastructure (initially uses SonarDyne as underlying hardware) More...
 
class  CMOOSGeodesy
 
class  DynamicMOOSVars
 
class  FrontSeatTranslation
 
class  GobyMOOSApp
 
class  GobyMOOSAppSelector
 
class  ModemIdConvert
 
class  MOOSAppShell
 
class  MOOSPrefixTranslation
 
class  MOOSSerializer
 
class  MOOSTranslation
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_COMMA_SEPARATED_KEY_EQUALS_VALUE_PAIRS >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_FORMAT >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PREFIXED_PROTOBUF_NATIVE_ENCODED >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PREFIXED_PROTOBUF_NATIVE_HEX >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PREFIXED_PROTOBUF_TEXT_FORMAT >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PROTOBUF_NATIVE_ENCODED >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PROTOBUF_NATIVE_HEX >
 
class  MOOSTranslation< protobuf::TranslatorEntry::TECHNIQUE_PROTOBUF_TEXT_FORMAT >
 
class  MOOSTranslator
 
class  TranslatorBase
 
class  UFldDriver
 provides an simulator driver to the uFldNodeComms MOOS module: http://oceanai.mit.edu/moos-ivp/pmwiki/pmwiki.php?n=Modules.UFldNodeComms More...
 

Typedefs

using Translator = BasicTranslator< goby::middleware::SimpleThread >
 

Functions

void convert_and_publish_node_status (const goby::middleware::frontseat::protobuf::NodeStatus &status, CMOOSCommClient &moos_comms)
 
void write_version_message ()
 
template<typename App >
int run (int argc, char *argv[])
 Shorthand for goby::run for Configurators that have a constructor that simply takes argc, argv, e.g. MyConfigurator(int argc, char* argv[]). Allows for backwards-compatibility pre-Configurator. More...
 
template<typename ProtobufMessage >
void protobuf_inbox (const CMOOSMsg &msg, boost::function< void(const ProtobufMessage &msg)> handler)
 
bool TranslatorOnConnectCallBack (void *TranslatorBase)
 
std::map< int, std::string > run_serialize_algorithms (const google::protobuf::Message &in, const google::protobuf::RepeatedPtrField< protobuf::TranslatorEntry::PublishSerializer::Algorithm > &algorithms)
 
std::string strip_name_from_enum (const std::string &enum_value, const std::string &field_name)
 
std::string add_name_to_enum (const std::string &enum_value, const std::string &field_name)
 
goby::moos::protobuf::TranslatorEntry::ParserSerializerTechnique get_moos_technique ()
 
void set_moos_technique (const goby::moos::protobuf::GobyMOOSAppConfig &cfg)
 
std::ostream & operator<< (std::ostream &os, const CMOOSMsg &msg)
 
bool val_from_string (std::string &out, const std::string &str, const std::string &key)
 
template<typename T >
bool val_from_string (T &out, const std::string &str, const std::string &key)
 
bool val_from_string (bool &out, const std::string &str, const std::string &key)
 specialization of val_from_string for boolean out More...
 
void stripblanks (std::string &s)
 remove all blanks from string s More...
 
void alg_power_to_dB (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_dB_to_power (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_TSD_to_soundspeed (moos::transitional::DCCLMessageVal &val, const std::vector< moos::transitional::DCCLMessageVal > &ref_vals)
 
void alg_subtract (moos::transitional::DCCLMessageVal &val, const std::vector< moos::transitional::DCCLMessageVal > &ref_vals)
 
void alg_add (moos::transitional::DCCLMessageVal &val, const std::vector< moos::transitional::DCCLMessageVal > &ref_vals)
 
void alg_angle_0_360 (moos::transitional::DCCLMessageVal &angle)
 
void alg_angle_n180_180 (moos::transitional::DCCLMessageVal &angle)
 
void alg_to_upper (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_to_lower (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_abs (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_lat2hemisphere_initial (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_lon2hemisphere_initial (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_unix_time2nmea_time (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_lat2nmea_lat (moos::transitional::DCCLMessageVal &val_to_mod)
 
void alg_lon2nmea_lon (moos::transitional::DCCLMessageVal &val_to_mod)
 
std::ostream & operator<< (std::ostream &os, const MOOSTranslator &tl)
 

Variables

std::mutex dynamic_parse_mutex
 
const std::string MAGIC_PROTOBUF_HEADER = "@PB"
 
std::mutex moos_technique_mutex
 
goby::moos::protobuf::TranslatorEntry::ParserSerializerTechnique moos_technique
 

Typedef Documentation

◆ Translator

Function Documentation

◆ add_name_to_enum()

std::string goby::moos::add_name_to_enum ( const std::string &  enum_value,
const std::string &  field_name 
)
inline

Definition at line 147 of file moos_protobuf_helpers.h.

◆ alg_abs()

void goby::moos::alg_abs ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_add()

void goby::moos::alg_add ( moos::transitional::DCCLMessageVal val,
const std::vector< moos::transitional::DCCLMessageVal > &  ref_vals 
)

◆ alg_angle_0_360()

void goby::moos::alg_angle_0_360 ( moos::transitional::DCCLMessageVal angle)

◆ alg_angle_n180_180()

void goby::moos::alg_angle_n180_180 ( moos::transitional::DCCLMessageVal angle)

◆ alg_dB_to_power()

void goby::moos::alg_dB_to_power ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_lat2hemisphere_initial()

void goby::moos::alg_lat2hemisphere_initial ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_lat2nmea_lat()

void goby::moos::alg_lat2nmea_lat ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_lon2hemisphere_initial()

void goby::moos::alg_lon2hemisphere_initial ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_lon2nmea_lon()

void goby::moos::alg_lon2nmea_lon ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_power_to_dB()

void goby::moos::alg_power_to_dB ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_subtract()

void goby::moos::alg_subtract ( moos::transitional::DCCLMessageVal val,
const std::vector< moos::transitional::DCCLMessageVal > &  ref_vals 
)

◆ alg_to_lower()

void goby::moos::alg_to_lower ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_to_upper()

void goby::moos::alg_to_upper ( moos::transitional::DCCLMessageVal val_to_mod)

◆ alg_TSD_to_soundspeed()

void goby::moos::alg_TSD_to_soundspeed ( moos::transitional::DCCLMessageVal val,
const std::vector< moos::transitional::DCCLMessageVal > &  ref_vals 
)

◆ alg_unix_time2nmea_time()

void goby::moos::alg_unix_time2nmea_time ( moos::transitional::DCCLMessageVal val_to_mod)

◆ convert_and_publish_node_status()

void goby::moos::convert_and_publish_node_status ( const goby::middleware::frontseat::protobuf::NodeStatus status,
CMOOSCommClient &  moos_comms 
)

◆ get_moos_technique()

goby::moos::protobuf::TranslatorEntry::ParserSerializerTechnique goby::moos::get_moos_technique ( )
inline

Definition at line 1512 of file moos_protobuf_helpers.h.

◆ operator<<() [1/2]

std::ostream& goby::moos::operator<< ( std::ostream &  os,
const CMOOSMsg msg 
)
inline

Definition at line 37 of file moos_string.h.

◆ operator<<() [2/2]

std::ostream& goby::moos::operator<< ( std::ostream &  os,
const MOOSTranslator tl 
)
inline

Definition at line 213 of file moos_translator.h.

◆ protobuf_inbox()

template<typename ProtobufMessage >
void goby::moos::protobuf_inbox ( const CMOOSMsg msg,
boost::function< void(const ProtobufMessage &msg)>  handler 
)
inline

Definition at line 103 of file goby_moos_app.h.

◆ run()

template<typename App >
int goby::moos::run ( int  argc,
char argv[] 
)

Shorthand for goby::run for Configurators that have a constructor that simply takes argc, argv, e.g. MyConfigurator(int argc, char* argv[]). Allows for backwards-compatibility pre-Configurator.

Parameters
argcsame as argc in int main(int argc, char* argv)
argvsame as argv in int main(int argc, char* argv)
Template Parameters
AppApplication subclass
ConfiguratorConfigurator object that has a constructor such as Configurator(int argc, char* argv)
Returns
same as int main(int argc, char* argv)

Definition at line 1089 of file goby_moos_app.h.

◆ run_serialize_algorithms()

std::map<int, std::string> goby::moos::run_serialize_algorithms ( const google::protobuf::Message in,
const google::protobuf::RepeatedPtrField< protobuf::TranslatorEntry::PublishSerializer::Algorithm > &  algorithms 
)
inline

Definition at line 78 of file moos_protobuf_helpers.h.

◆ set_moos_technique()

void goby::moos::set_moos_technique ( const goby::moos::protobuf::GobyMOOSAppConfig cfg)
inline

Definition at line 1518 of file moos_protobuf_helpers.h.

◆ strip_name_from_enum()

std::string goby::moos::strip_name_from_enum ( const std::string &  enum_value,
const std::string &  field_name 
)
inline

Definition at line 141 of file moos_protobuf_helpers.h.

◆ stripblanks()

void goby::moos::stripblanks ( std::string &  s)
inline

remove all blanks from string s

Definition at line 160 of file moos_string.h.

◆ TranslatorOnConnectCallBack()

bool goby::moos::TranslatorOnConnectCallBack ( void *  TranslatorBase)

◆ val_from_string() [1/3]

bool goby::moos::val_from_string ( bool out,
const std::string &  str,
const std::string &  key 
)
inline

specialization of val_from_string for boolean out

Definition at line 148 of file moos_string.h.

◆ val_from_string() [2/3]

bool goby::moos::val_from_string ( std::string &  out,
const std::string &  str,
const std::string &  key 
)
inline

case insensitive - find key in str and if successful put it in out and return true deal with these basic forms: str = foo=1,bar=2,pig=3 str = foo=1,bar={2,3,4,5},pig=3

Parameters
outstring to return value in
strhaystack to search
keyneedle to find
Returns
true if key is in str, false otherwise

Definition at line 60 of file moos_string.h.

◆ val_from_string() [3/3]

template<typename T >
bool goby::moos::val_from_string ( T &  out,
const std::string &  str,
const std::string &  key 
)
inline

variation of val_from_string() for arbitrary return type

Returns
false if key not in str OR if out is not of proper type T

Definition at line 129 of file moos_string.h.

◆ write_version_message()

void goby::moos::write_version_message ( )

Variable Documentation

◆ dynamic_parse_mutex

std::mutex goby::moos::dynamic_parse_mutex

◆ MAGIC_PROTOBUF_HEADER

const std::string goby::moos::MAGIC_PROTOBUF_HEADER = "@PB"

Definition at line 75 of file moos_protobuf_helpers.h.

◆ moos_technique

◆ moos_technique_mutex

std::mutex goby::moos::moos_technique_mutex