Goby3  3.1.5a
2024.05.23
goby::util::gps::RTE Struct Reference

#include <goby/util/linebasedcomms/gps_sentence.h>

Public Types

enum  RouteType { ROUTE_TYPE__INVALID, ROUTE_TYPE__COMPLETE = 'c', ROUTE_TYPE__WORKING_ROUTE = 'w' }
 
enum  Fields {
  TOTAL_NUMBER_SENTENCES = 1, CURRENT_SENTENCE_INDEX = 2, ROUTE_TYPE = 3, NAME = 4,
  FIRST_WAYPOINT_NAME = 5
}
 

Public Member Functions

 RTE ()=default
 
 RTE (const NMEASentence &sentence)
 
void parse (const NMEASentence &sentence)
 
NMEASentence serialize (std::string talker_id="EC") const
 

Public Attributes

boost::optional< std::string > name
 
std::vector< std::string > waypoint_names
 
boost::optional< inttotal_number_sentences
 
boost::optional< intcurrent_sentence_index
 
RouteType type {ROUTE_TYPE__INVALID}
 

Static Public Attributes

constexpr static int min_size = FIRST_WAYPOINT_NAME + 1
 

Detailed Description

Definition at line 180 of file gps_sentence.h.

Member Enumeration Documentation

◆ Fields

Enumerator
TOTAL_NUMBER_SENTENCES 
CURRENT_SENTENCE_INDEX 
ROUTE_TYPE 
NAME 
FIRST_WAYPOINT_NAME 

Definition at line 202 of file gps_sentence.h.

◆ RouteType

Enumerator
ROUTE_TYPE__INVALID 
ROUTE_TYPE__COMPLETE 
ROUTE_TYPE__WORKING_ROUTE 

Definition at line 194 of file gps_sentence.h.

Constructor & Destructor Documentation

◆ RTE() [1/2]

goby::util::gps::RTE::RTE ( )
default

◆ RTE() [2/2]

goby::util::gps::RTE::RTE ( const NMEASentence sentence)
inline

Definition at line 185 of file gps_sentence.h.

Member Function Documentation

◆ parse()

void goby::util::gps::RTE::parse ( const NMEASentence sentence)

◆ serialize()

NMEASentence goby::util::gps::RTE::serialize ( std::string  talker_id = "EC") const

Member Data Documentation

◆ current_sentence_index

boost::optional<int> goby::util::gps::RTE::current_sentence_index

Definition at line 193 of file gps_sentence.h.

◆ min_size

constexpr static int goby::util::gps::RTE::min_size = FIRST_WAYPOINT_NAME + 1
staticconstexpr

Definition at line 211 of file gps_sentence.h.

◆ name

boost::optional<std::string> goby::util::gps::RTE::name

Definition at line 190 of file gps_sentence.h.

◆ total_number_sentences

boost::optional<int> goby::util::gps::RTE::total_number_sentences

Definition at line 192 of file gps_sentence.h.

◆ type

RouteType goby::util::gps::RTE::type {ROUTE_TYPE__INVALID}

Definition at line 200 of file gps_sentence.h.

◆ waypoint_names

std::vector<std::string> goby::util::gps::RTE::waypoint_names

Definition at line 191 of file gps_sentence.h.


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