libcluon  0.0.148
cluon::LCMToGenericMessage Class Reference

#include <LCMToGenericMessage.hpp>

Public Member Functions

 LCMToGenericMessage ()=default
 
int32_t setMessageSpecification (const std::string &ms) noexcept
 
cluon::GenericMessage getGenericMessage (const std::string &data) noexcept
 

Detailed Description

This class transforms a given LCM message into a GenericMessage.

Constructor & Destructor Documentation

◆ LCMToGenericMessage()

cluon::LCMToGenericMessage::LCMToGenericMessage ( )
default

Member Function Documentation

◆ getGenericMessage()

cluon::GenericMessage cluon::LCMToGenericMessage::getGenericMessage ( const std::string &  data)
noexcept

This method transforms the given LCM payload into a GenericMessage.

Parameters
dataLCM Payload.
Returns
GenericMessage representation using the given message specification.

References cluon::GenericMessage::accept(), cluon::GenericMessage::createFrom(), and cluon::FromLCMVisitor::decodeFrom().

◆ setMessageSpecification()

int32_t cluon::LCMToGenericMessage::setMessageSpecification ( const std::string &  ms)
noexcept

This method sets the message specification to be used for interpreting a given LCM-encoded message.

Parameters
msMessage specification following the ODVD format.
Returns
-1 in case of invalid message specification; otherwise, number of successfully parsed messages from given message specification.

References mm, cluon::MessageParser::parse(), and retVal.