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 104 of file gnss_messages_ascii_nmea.h.

#include <mrpt/obs/gnss_messages_ascii_nmea.h>

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

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
 
bool getAllFieldValues (std::ostream &o) const override
 
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
 
virtual void fixEndianness ()
 If we are in a big endian system, reverse all fields >1 byte to fix its representation. More...
 
virtual 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...
 
virtual bool getAllFieldDescriptions ([[maybe_unused]] std::ostream &o) const
 Dumps a header for getAllFieldValues() More...
 
virtual bool getAllFieldValues ([[maybe_unused]] std::ostream &o) const
 Dumps a line with the sequence of all field values (without a line feed at the end). More...
 
const std::string & getMessageTypeAsString () 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 108 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 112 of file gnss_messages_ascii_nmea.h.

Member Function Documentation

◆ dumpToConsole()

void gnss_message::dumpToConsole ( std::ostream &  o) const
virtualinherited

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

Definition at line 106 of file gnss_messages_common.cpp.

References mrpt::obs::gnss::getAllFieldDescriptions(), and mrpt::obs::gnss::getAllFieldValues().

Here is the call graph for this function:

◆ dumpToStream()

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

Dumps the contents of the observation in a human-readable form to a given output stream.

See also
dumpToConsole()

Implements mrpt::obs::gnss::gnss_message.

Definition at line 83 of file gnss_messages_ascii_nmea.cpp.

References fields, mrpt::format(), mrpt::obs::gnss::UTC_time::hour, mrpt::obs::gnss::Message_NMEA_GLL::content_t::latitude_degrees, mrpt::obs::gnss::Message_NMEA_GLL::content_t::longitude_degrees, mrpt::obs::gnss::UTC_time::minute, out, mrpt::obs::gnss::UTC_time::sec, mrpt::obs::gnss::Message_NMEA_GLL::content_t::UTCTime, and mrpt::obs::gnss::Message_NMEA_GLL::content_t::validity_char.

Here is the call graph for this function:

◆ 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 48 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 61 of file gnss_messages_common.cpp.

References LIST_ALL_MSGS.

◆ fixEndianness()

virtual void mrpt::obs::gnss::gnss_message::fixEndianness ( )
inlinevirtualinherited

If we are in a big endian system, reverse all fields >1 byte to fix its representation.

Only in binary frames, text-based derived classes obviously do not need to reimplement this one.

Reimplemented in mrpt::obs::gnss::Message_NV_OEM6_VERSION, mrpt::obs::gnss::Message_NV_OEM6_GENERIC_SHORT_FRAME, and mrpt::obs::gnss::Message_NV_OEM6_GENERIC_FRAME.

Definition at line 62 of file gnss_messages_common.h.

◆ getAllFieldDescriptions() [1/2]

virtual bool mrpt::obs::gnss::gnss_message::getAllFieldDescriptions ( [[maybe_unused] ] std::ostream &  o) const
inlinevirtualinherited

Dumps a header for getAllFieldValues()

Returns
false if not implemented for this message type

Definition at line 70 of file gnss_messages_common.h.

◆ getAllFieldDescriptions() [2/2]

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

Definition at line 95 of file gnss_messages_ascii_nmea.cpp.

◆ getAllFieldValues() [1/2]

virtual bool mrpt::obs::gnss::gnss_message::getAllFieldValues ( [[maybe_unused] ] std::ostream &  o) const
inlinevirtualinherited

Dumps a line with the sequence of all field values (without a line feed at the end).

See also
getAllFieldDescriptions()
Returns
false if not implemented for this message type

Definition at line 77 of file gnss_messages_common.h.

◆ getAllFieldValues() [2/2]

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

◆ getMessageTypeAsString()

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

Returns "NMEA_GGA", etc.

Definition at line 75 of file gnss_messages_common.cpp.

References LIST_ALL_MSGS.

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

Here is the caller graph for this function:

◆ internal_readFromStream()

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

Save to binary stream.

Launches an exception upon error

Implemented in mrpt::obs::gnss::Message_NV_OEM6_VERSION, mrpt::obs::gnss::Message_NV_OEM6_RANGECMP, mrpt::obs::gnss::Message_NV_OEM6_GENERIC_SHORT_FRAME, mrpt::obs::gnss::Message_NV_OEM6_GENERIC_FRAME, mrpt::obs::gnss::Message_TOPCON_SATS, and mrpt::obs::gnss::Message_TOPCON_PZS.

Referenced by mrpt::obs::gnss::gnss_message::readAndBuildFromStream().

Here is the caller graph for this function:

◆ 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().

Here is the call graph for this function:

◆ isOfType()

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

Referenced by mrpt::obs::gnss::gnss_message::isOfClass().

Here is the caller graph for this function:

◆ 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 116 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::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 98 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 91 of file gnss_messages_common.cpp.

References out.

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

Here is the caller graph for this function:

Member Data Documentation

◆ fields

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

◆ 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: 7e629e01a Sat Dec 14 00:05:55 2019 +0100 at sáb dic 14 00:15:10 CET 2019