Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions
mrpt::obs::gnss::Message_NMEA_GLL Struct Referenceabstract

Detailed Description

NMEA datum: GLL.

See also
mrpt::obs::CObservationGPS

Definition at line 108 of file gnss_messages_ascii_nmea.h.

#include <mrpt/obs/gnss_messages_ascii_nmea.h>

Inheritance diagram for mrpt::obs::gnss::Message_NMEA_GLL:
Inheritance graph

Classes

struct  content_t
 

Public Types

enum  { msg_type = NMEA_GLL }
 Static msg type (member expected by templates) More...
 

Public Member Functions

 Message_NMEA_GLL ()
 
void dumpToStream (std::ostream &out) const override
 Dumps the contents of the observation in a human-readable form to a given output stream. More...
 
bool getAllFieldDescriptions (std::ostream &o) const override
 Dumps a header for getAllFieldValues() More...
 
bool getAllFieldValues (std::ostream &o) const override
 Dumps a line with the sequence of all field values (without a line feed at the end). More...
 
void writeToStream (mrpt::serialization::CArchive &out) const
 Save to binary stream. More...
 
void readFromStream (mrpt::serialization::CArchive &in)
 Load from binary stream into this existing object. More...
 
bool isOfType (const gnss_message_type_t type_id) const
 
template<class MSG_CLASS >
bool isOfClass () const
 
void dumpToConsole (std::ostream &o) const
 Dumps the contents of the observation in a human-readable form to an std::ostream (set to std::cout to print to console) More...
 
const std::stringgetMessageTypeAsString () const
 Returns "NMEA_GGA", etc. More...
 

Static Public Member Functions

static gnss_messagereadAndBuildFromStream (mrpt::serialization::CArchive &in)
 Load from binary stream and creates object detecting its type (class factory). More...
 
static gnss_messageFactory (const gnss_message_type_t msg_id)
 Creates message. More...
 
static bool FactoryKnowsMsgType (const gnss_message_type_t msg_id)
 Returns true if Factory() has a registered constructor for this msg type. More...
 

Public Attributes

content_t fields
 Message content, accesible by individual fields. More...
 
gnss_message_type_t message_type
 Type of GNSS message. More...
 

Protected Member Functions

virtual void internal_writeToStream (mrpt::serialization::CArchive &out) const =0
 Save to binary stream. More...
 
virtual void internal_readFromStream (mrpt::serialization::CArchive &in)=0
 Save to binary stream. More...
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Static msg type (member expected by templates)

Enumerator
msg_type 

Definition at line 112 of file gnss_messages_ascii_nmea.h.

Constructor & Destructor Documentation

◆ Message_NMEA_GLL()

mrpt::obs::gnss::Message_NMEA_GLL::Message_NMEA_GLL ( )
inline

Definition at line 116 of file gnss_messages_ascii_nmea.h.

Member Function Documentation

◆ dumpToConsole()

void mrpt::obs::gnss::gnss_message::dumpToConsole ( std::ostream &  o) const
inherited

Dumps the contents of the observation in a human-readable form to an std::ostream (set to std::cout to print to console)

◆ dumpToStream()

void Message_NMEA_GLL::dumpToStream ( std::ostream &  out) const
overridevirtual

◆ Factory()

gnss_message * gnss_message::Factory ( const gnss_message_type_t  msg_id)
staticinherited

Creates message.

Returns
nullptr on unknown msg type

Definition at line 47 of file gnss_messages_common.cpp.

References LIST_ALL_MSGS.

◆ FactoryKnowsMsgType()

bool gnss_message::FactoryKnowsMsgType ( const gnss_message_type_t  msg_id)
staticinherited

Returns true if Factory() has a registered constructor for this msg type.

Definition at line 60 of file gnss_messages_common.cpp.

References LIST_ALL_MSGS.

◆ getAllFieldDescriptions()

bool Message_NMEA_GLL::getAllFieldDescriptions ( std::ostream &  o) const
overridevirtual

Dumps a header for getAllFieldValues()

Returns
false if not implemented for this message type

Reimplemented from mrpt::obs::gnss::gnss_message.

Definition at line 113 of file gnss_messages_ascii_nmea.cpp.

◆ getAllFieldValues()

bool Message_NMEA_GLL::getAllFieldValues ( std::ostream &  o) const
overridevirtual

◆ getMessageTypeAsString()

const std::string & gnss_message::getMessageTypeAsString ( ) const
inherited

Returns "NMEA_GGA", etc.

Definition at line 74 of file gnss_messages_common.cpp.

References LIST_ALL_MSGS.

Referenced by mrpt::hwdrivers::CGPSInterface::implement_parser_NOVATEL_OEM6().

◆ internal_readFromStream()

virtual void mrpt::obs::gnss::gnss_message::internal_readFromStream ( mrpt::serialization::CArchive in)
protectedpure virtualinherited

◆ internal_writeToStream()

virtual void mrpt::obs::gnss::gnss_message::internal_writeToStream ( mrpt::serialization::CArchive out) const
protectedpure virtualinherited

◆ isOfClass()

template<class MSG_CLASS >
bool mrpt::obs::gnss::gnss_message::isOfClass ( ) const
inlineinherited

Definition at line 40 of file gnss_messages_common.h.

References mrpt::obs::gnss::gnss_message::isOfType().

◆ isOfType()

bool mrpt::obs::gnss::gnss_message::isOfType ( const gnss_message_type_t  type_id) const
inherited

◆ readAndBuildFromStream()

gnss_message * gnss_message::readAndBuildFromStream ( mrpt::serialization::CArchive in)
staticinherited

Load from binary stream and creates object detecting its type (class factory).

Launches an exception upon error

Definition at line 107 of file gnss_messages_common.cpp.

References mrpt::obs::gnss::gnss_message::internal_readFromStream(), and THROW_EXCEPTION_FMT.

Referenced by mrpt::obs::gnss::gnss_message_ptr::gnss_message_ptr(), and mrpt::obs::gnss::gnss_message_ptr::operator=().

◆ readFromStream()

void gnss_message::readFromStream ( mrpt::serialization::CArchive in)
inherited

Load from binary stream into this existing object.

Launches an exception upon error.

Definition at line 97 of file gnss_messages_common.cpp.

References ASSERT_EQUAL_.

◆ writeToStream()

void gnss_message::writeToStream ( mrpt::serialization::CArchive out) const
inherited

Save to binary stream.

Launches an exception upon error

Definition at line 90 of file gnss_messages_common.cpp.

References mrpt::serialization::CArchive::WriteAs().

Referenced by mrpt::obs::gnss::gnss_message_ptr::gnss_message_ptr(), and mrpt::obs::gnss::gnss_message_ptr::operator=().

Member Data Documentation

◆ fields

content_t mrpt::obs::gnss::Message_NMEA_GLL::fields

Message content, accesible by individual fields.

Definition at line 130 of file gnss_messages_ascii_nmea.h.

Referenced by dumpToStream(), getAllFieldValues(), mrpt::hwdrivers::CGPSInterface::parse_NMEA(), and TEST().

◆ message_type

gnss_message_type_t mrpt::obs::gnss::gnss_message::message_type
inherited



Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019