version_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_VERSION_MESSAGE_H_INCLUDED
30 #define UR_CLIENT_LIBRARY_VERSION_MESSAGE_H_INCLUDED
31 
33 
34 namespace urcl
35 {
36 namespace primary_interface
37 {
42 {
43 public:
44  VersionMessage() = delete;
51  VersionMessage(uint64_t timestamp, uint8_t source) : RobotMessage(timestamp, source)
52  {
53  }
54  virtual ~VersionMessage() = default;
55 
64  virtual bool parseWith(comm::BinParser& bp);
65 
73  virtual bool consumeWith(AbstractPrimaryConsumer& consumer);
74 
80  virtual std::string toString() const;
81 
83  std::string project_name_;
84  uint8_t major_version_;
85  uint8_t minor_version_;
86  int32_t svn_version_;
87  int32_t build_number_;
88  std::string build_date_;
89 };
90 } // namespace primary_interface
91 } // namespace urcl
92 
93 #endif // ifndef UR_CLIENT_LIBRARY_VERSION_MESSAGE_H_INCLUDED
urcl::primary_interface::VersionMessage::toString
virtual std::string toString() const
Produces a human readable representation of the package object.
Definition: version_message.cpp:57
robot_message.h
urcl::primary_interface::VersionMessage::minor_version_
uint8_t minor_version_
Definition: version_message.h:85
urcl
Definition: bin_parser.h:36
urcl::primary_interface::RobotMessage
The RobotMessage class is a parent class for the different received robot messages.
Definition: robot_message.h:57
urcl::primary_interface::VersionMessage::major_version_
uint8_t major_version_
Definition: version_message.h:84
urcl::primary_interface::VersionMessage::project_name_
std::string project_name_
Definition: version_message.h:83
urcl::primary_interface::VersionMessage::~VersionMessage
virtual ~VersionMessage()=default
urcl::primary_interface::VersionMessage::VersionMessage
VersionMessage()=delete
urcl::primary_interface::VersionMessage
The VersionMessage class handles the version messages sent via the primary UR interface.
Definition: version_message.h:41
urcl::primary_interface::VersionMessage::build_date_
std::string build_date_
Definition: version_message.h:88
urcl::primary_interface::VersionMessage::svn_version_
int32_t svn_version_
Definition: version_message.h:86
urcl::comm::BinParser
The BinParser class handles a byte buffer and functionality to iteratively parse the content.
Definition: bin_parser.h:44
urcl::primary_interface::VersionMessage::build_number_
int32_t build_number_
Definition: version_message.h:87
urcl::primary_interface::VersionMessage::VersionMessage
VersionMessage(uint64_t timestamp, uint8_t source)
Creates a new VersionMessage object to be filled from a package.
Definition: version_message.h:51
urcl::primary_interface::VersionMessage::project_name_length_
int8_t project_name_length_
Definition: version_message.h:82
urcl::primary_interface::VersionMessage::consumeWith
virtual bool consumeWith(AbstractPrimaryConsumer &consumer)
Consume this package with a specific consumer.
Definition: version_message.cpp:52
urcl::primary_interface::AbstractPrimaryConsumer
Base consumer for primary packages.
Definition: abstract_primary_consumer.h:50
urcl::primary_interface::VersionMessage::parseWith
virtual bool parseWith(comm::BinParser &bp)
Sets the attributes of the package by parsing a serialized representation of the package.
Definition: version_message.cpp:39


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