Main MRPT website > C++ reference for MRPT 1.4.0
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 72 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 }
 

Public Member Functions

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

Static Public Member Functions

static gnss_messagereadAndBuildFromStream (mrpt::utils::CStream &in)
 Load from binary stream and creates object detecting its type (class factory). Launches an exception upon error. 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::utils::CStream &out) const =0
 Save to binary stream. Launches an exception upon error. More...
 
virtual void internal_readFromStream (mrpt::utils::CStream &in)=0
 Save to binary stream. Launches an exception upon error. More...
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
msg_type 

Definition at line 75 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 76 of file gnss_messages_ascii_nmea.h.

Member Function Documentation

◆ dumpToConsole()

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

Dumps the contents of the observation in a human-readable form to an std::ostream (default=console)

◆ dumpToStream()

void mrpt::obs::gnss::Message_NMEA_GLL::dumpToStream ( mrpt::utils::CStream out) const
virtual

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.

◆ Factory()

static gnss_message* mrpt::obs::gnss::gnss_message::Factory ( const gnss_message_type_t  msg_id)
staticinherited

Creates message.

Returns
NULL on unknown msg type

◆ FactoryKnowsMsgType()

static bool mrpt::obs::gnss::gnss_message::FactoryKnowsMsgType ( const gnss_message_type_t  msg_id)
staticinherited

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

◆ getAllFieldDescriptions()

bool mrpt::obs::gnss::Message_NMEA_GLL::getAllFieldDescriptions ( std::ostream &  o) const
virtual

Dumps a header for getAllFieldValues()

Returns
false if not implemented for this message type

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

◆ getAllFieldValues()

bool mrpt::obs::gnss::Message_NMEA_GLL::getAllFieldValues ( std::ostream &  o) const
virtual

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

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

◆ getMessageTypeAsString()

const std::string& mrpt::obs::gnss::gnss_message::getMessageTypeAsString ( ) const
inherited

Returns "NMEA_GGA", etc.

◆ internal_readFromStream()

virtual void mrpt::obs::gnss::gnss_message::internal_readFromStream ( mrpt::utils::CStream in)
protectedpure virtualinherited

◆ internal_writeToStream()

virtual void mrpt::obs::gnss::gnss_message::internal_writeToStream ( mrpt::utils::CStream out) const
protectedpure virtualinherited

◆ isOfClass()

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

Definition at line 33 of file gnss_messages_common.h.

◆ isOfType()

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

◆ readAndBuildFromStream()

static gnss_message* mrpt::obs::gnss::gnss_message::readAndBuildFromStream ( mrpt::utils::CStream in)
staticinherited

Load from binary stream and creates object detecting its type (class factory). Launches an exception upon error.

◆ readFromStream()

void mrpt::obs::gnss::gnss_message::readFromStream ( mrpt::utils::CStream in)
inherited

Load from binary stream into this existing object. Launches an exception upon error.

◆ writeToStream()

void mrpt::obs::gnss::gnss_message::writeToStream ( mrpt::utils::CStream out) const
inherited

Save to binary stream. Launches an exception upon error.

Member Data Documentation

◆ fields

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

Message content, accesible by individual fields.

Definition at line 86 of file gnss_messages_ascii_nmea.h.

◆ message_type

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

Type of GNSS message.

Definition at line 25 of file gnss_messages_common.h.




Page generated by Doxygen 1.9.1 for MRPT 1.4.0 SVN: at Sat Jan 30 21:34:41 UTC 2021