MRPT  2.0.4
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions
mrpt::obs::gnss::Message_TOPCON_SATS Struct Reference

Detailed Description

TopCon mmGPS devices: SATS, a generic structure for statistics about tracked satelites and their positions.

See also
mrpt::obs::CObservationGPS

Definition at line 89 of file gnss_messages_topcon.h.

#include <mrpt/obs/gnss_messages_topcon.h>

Inheritance diagram for mrpt::obs::gnss::Message_TOPCON_SATS:

Public Types

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

Public Member Functions

 Message_TOPCON_SATS ()
 
void dumpToStream (std::ostream &out) const override
 Dumps the contents of the observation in a human-readable form to a given output stream. 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
 
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

std::vector< uint8_t > USIs
 The list of USI (Universal Sat ID) for the detected sats (See GRIL Manual, pag 4-31). More...
 
std::vector< int8_t > ELs
 Elevation (in degrees, 0-90) for each satellite in USIs. More...
 
std::vector< int16_t > AZs
 Azimuth (in degrees, 0-360) for each satellite in USIs. More...
 
gnss_message_type_t message_type
 Type of GNSS message. More...
 

Protected Member Functions

void internal_writeToStream (mrpt::serialization::CArchive &out) const override
 Save to binary stream. More...
 
void internal_readFromStream (mrpt::serialization::CArchive &in) override
 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 92 of file gnss_messages_topcon.h.

Constructor & Destructor Documentation

◆ Message_TOPCON_SATS()

Message_TOPCON_SATS::Message_TOPCON_SATS ( )

Definition at line 88 of file gnss_messages_topcon.cpp.

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 107 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_TOPCON_SATS::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 89 of file gnss_messages_topcon.cpp.

References ASSERT_, AZs, ELs, mrpt::format(), out, and USIs.

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 49 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 62 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()

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.

◆ getAllFieldValues()

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.

◆ getMessageTypeAsString()

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

Returns "NMEA_GGA", etc.

Definition at line 76 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()

void Message_TOPCON_SATS::internal_readFromStream ( mrpt::serialization::CArchive in)
overrideprotectedvirtual

Save to binary stream.

Launches an exception upon error

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

Definition at line 108 of file gnss_messages_topcon.cpp.

References AZs, ELs, and USIs.

◆ internal_writeToStream()

void Message_TOPCON_SATS::internal_writeToStream ( mrpt::serialization::CArchive out) const
overrideprotectedvirtual

Save to binary stream.

Launches an exception upon error

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

Definition at line 102 of file gnss_messages_topcon.cpp.

References AZs, ELs, out, and USIs.

◆ 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 117 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 99 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 92 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

◆ AZs

std::vector<int16_t> mrpt::obs::gnss::Message_TOPCON_SATS::AZs

Azimuth (in degrees, 0-360) for each satellite in USIs.

Definition at line 105 of file gnss_messages_topcon.h.

Referenced by dumpToStream(), internal_readFromStream(), and internal_writeToStream().

◆ ELs

std::vector<int8_t> mrpt::obs::gnss::Message_TOPCON_SATS::ELs

Elevation (in degrees, 0-90) for each satellite in USIs.

Definition at line 103 of file gnss_messages_topcon.h.

Referenced by dumpToStream(), internal_readFromStream(), and internal_writeToStream().

◆ message_type

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

◆ USIs

std::vector<uint8_t> mrpt::obs::gnss::Message_TOPCON_SATS::USIs

The list of USI (Universal Sat ID) for the detected sats (See GRIL Manual, pag 4-31).

Definition at line 101 of file gnss_messages_topcon.h.

Referenced by dumpToStream(), internal_readFromStream(), and internal_writeToStream().




Page generated by Doxygen 1.8.14 for MRPT 2.0.4 Git: 5711e29ae Wed May 27 14:29:47 2020 +0200 at miƩ may 27 14:30:10 CEST 2020