Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PJ::MessageParser Class Referenceabstract

The MessageParser is the base class used to parse a message with a specific encoding+schema. More...

#include <messageparser_base.h>

Inheritance diagram for PJ::MessageParser:
Inheritance graph
[legend]

Public Member Functions

bool clampLargeArray () const
 
virtual void enableEmbeddedTimestamp (bool enable)
 
unsigned maxArraySize () const
 
 MessageParser (const std::string &topic_name, PlotDataMapRef &plot_data)
 
virtual bool parseMessage (const MessageRef serialized_msg, double &timestamp)=0
 
virtual void setLargeArraysPolicy (bool clamp, unsigned max_size)
 
virtual bool useEmbeddedTimestamp () const
 
virtual ~MessageParser ()=default
 

Protected Member Functions

PlotDatagetSeries (const std::string &key)
 
StringSeriesgetStringSeries (const std::string &key)
 

Protected Attributes

PlotDataMapRef_plot_data
 
std::string _topic_name
 

Private Attributes

bool _clamp_large_arrays = false
 
unsigned _max_array_size = 10000
 
bool _use_embedded_timestamp = false
 

Detailed Description

The MessageParser is the base class used to parse a message with a specific encoding+schema.

Definition at line 75 of file messageparser_base.h.

Constructor & Destructor Documentation

◆ MessageParser()

PJ::MessageParser::MessageParser ( const std::string &  topic_name,
PlotDataMapRef plot_data 
)
inline

Definition at line 78 of file messageparser_base.h.

◆ ~MessageParser()

virtual PJ::MessageParser::~MessageParser ( )
virtualdefault

Member Function Documentation

◆ clampLargeArray()

bool PJ::MessageParser::clampLargeArray ( ) const
inline

Definition at line 101 of file messageparser_base.h.

◆ enableEmbeddedTimestamp()

virtual void PJ::MessageParser::enableEmbeddedTimestamp ( bool  enable)
inlinevirtual

Definition at line 111 of file messageparser_base.h.

◆ getSeries()

PlotData& PJ::MessageParser::getSeries ( const std::string &  key)
inlineprotected

Definition at line 120 of file messageparser_base.h.

◆ getStringSeries()

StringSeries& PJ::MessageParser::getStringSeries ( const std::string &  key)
inlineprotected

Definition at line 125 of file messageparser_base.h.

◆ maxArraySize()

unsigned PJ::MessageParser::maxArraySize ( ) const
inline

Definition at line 96 of file messageparser_base.h.

◆ parseMessage()

virtual bool PJ::MessageParser::parseMessage ( const MessageRef  serialized_msg,
double &  timestamp 
)
pure virtual

◆ setLargeArraysPolicy()

virtual void PJ::MessageParser::setLargeArraysPolicy ( bool  clamp,
unsigned  max_size 
)
inlinevirtual

Reimplemented in ParserROS.

Definition at line 90 of file messageparser_base.h.

◆ useEmbeddedTimestamp()

virtual bool PJ::MessageParser::useEmbeddedTimestamp ( ) const
inlinevirtual

Definition at line 106 of file messageparser_base.h.

Member Data Documentation

◆ _clamp_large_arrays

bool PJ::MessageParser::_clamp_large_arrays = false
private

Definition at line 131 of file messageparser_base.h.

◆ _max_array_size

unsigned PJ::MessageParser::_max_array_size = 10000
private

Definition at line 132 of file messageparser_base.h.

◆ _plot_data

PlotDataMapRef& PJ::MessageParser::_plot_data
protected

Definition at line 117 of file messageparser_base.h.

◆ _topic_name

std::string PJ::MessageParser::_topic_name
protected

Definition at line 118 of file messageparser_base.h.

◆ _use_embedded_timestamp

bool PJ::MessageParser::_use_embedded_timestamp = false
private

Definition at line 133 of file messageparser_base.h.


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


plotjuggler
Author(s): Davide Faconti
autogenerated on Sun Aug 11 2024 02:24:31