text_message.h
Go to the documentation of this file.
1 // this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-
2 
3 // -- BEGIN LICENSE BLOCK ----------------------------------------------
4 // Copyright 2019 FZI Forschungszentrum Informatik
5 // Created on behalf of Universal Robots A/S
6 //
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
10 //
11 // http://www.apache.org/licenses/LICENSE-2.0
12 //
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 // -- END LICENSE BLOCK ------------------------------------------------
19 
20 //----------------------------------------------------------------------
27 //----------------------------------------------------------------------
28 
29 #ifndef UR_CLIENT_LIBRARY_TEXT_MESSAGE_H_INCLUDED
30 #define UR_CLIENT_LIBRARY_TEXT_MESSAGE_H_INCLUDED
31 
33 
34 namespace urcl
35 {
36 namespace rtde_interface
37 {
41 class TextMessage : public RTDEPackage
42 {
43 public:
49  TextMessage(uint16_t protocol_version)
51  {
52  }
53  virtual ~TextMessage() = default;
54 
63  virtual bool parseWith(comm::BinParser& bp);
69  virtual std::string toString() const;
70 
71  uint8_t message_length_;
72  std::string message_;
73  uint8_t source_length_;
74  std::string source_;
75  uint8_t warning_level_;
76 
77  uint8_t message_type_;
78 
80 };
81 
82 } // namespace rtde_interface
83 } // namespace urcl
84 
85 #endif // UR_CLIENT_LIBRARY_TEXT_MESSAGE_H_INCLUDED
urcl::rtde_interface::TextMessage
This class handles RTDE text messages sent by the robot.
Definition: text_message.h:41
urcl::rtde_interface::TextMessage::source_length_
uint8_t source_length_
Definition: text_message.h:73
urcl::rtde_interface::TextMessage::parseWith
virtual bool parseWith(comm::BinParser &bp)
Sets the attributes of the package by parsing a serialized representation of the package.
Definition: text_message.cpp:35
urcl::rtde_interface::TextMessage::protocol_version_
uint16_t protocol_version_
Definition: text_message.h:79
urcl
Definition: bin_parser.h:36
urcl::rtde_interface::TextMessage::toString
virtual std::string toString() const
Produces a human readable representation of the package object.
Definition: text_message.cpp:53
urcl::rtde_interface::TextMessage::source_
std::string source_
Definition: text_message.h:74
rtde_package.h
urcl::rtde_interface::TextMessage::warning_level_
uint8_t warning_level_
Definition: text_message.h:75
urcl::rtde_interface::RTDEPackage
Definition: rtde_package.h:43
urcl::rtde_interface::TextMessage::~TextMessage
virtual ~TextMessage()=default
urcl::rtde_interface::TextMessage::message_type_
uint8_t message_type_
Definition: text_message.h:77
urcl::rtde_interface::PackageType
PackageType
Possible package types.
Definition: rtde/package_header.h:45
urcl::rtde_interface::TextMessage::message_
std::string message_
Definition: text_message.h:72
urcl::rtde_interface::TextMessage::message_length_
uint8_t message_length_
Definition: text_message.h:71
urcl::rtde_interface::TextMessage::TextMessage
TextMessage(uint16_t protocol_version)
Creates a new TextMessage object.
Definition: text_message.h:49
urcl::rtde_interface::PackageType::RTDE_TEXT_MESSAGE
@ RTDE_TEXT_MESSAGE
urcl::comm::BinParser
The BinParser class handles a byte buffer and functionality to iteratively parse the content.
Definition: bin_parser.h:44


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Mon May 26 2025 02:35:58