rtde_package.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_RTDE_PACKAGE_H_INCLUDED
30 #define UR_CLIENT_LIBRARY_RTDE_PACKAGE_H_INCLUDED
31 
34 
35 namespace urcl
36 {
37 namespace rtde_interface
38 {
43 class RTDEPackage : public comm::URPackage<PackageHeader>
44 {
45 public:
49  RTDEPackage() = delete;
50  RTDEPackage(const PackageType type) : type_(type)
51  {
52  }
53  virtual ~RTDEPackage() = default;
54 
63  virtual bool parseWith(comm::BinParser& bp);
69  virtual std::string toString() const;
70 
71 protected:
72  std::unique_ptr<uint8_t[]> buffer_;
75 };
76 
77 } // namespace rtde_interface
78 } // namespace urcl
79 
80 #endif // UR_CLIENT_LIBRARY_RTDE_PACKAGE_H_INCLUDED
urcl::rtde_interface::RTDEPackage::RTDEPackage
RTDEPackage()=delete
Creates a new RTDEPackage object.
urcl::rtde_interface::RTDEPackage::~RTDEPackage
virtual ~RTDEPackage()=default
urcl::rtde_interface::RTDEPackage::buffer_
std::unique_ptr< uint8_t[]> buffer_
Definition: rtde_package.h:72
urcl::rtde_interface::RTDEPackage::toString
virtual std::string toString() const
Produces a human readable representation of the package object.
Definition: rtde_package.cpp:40
urcl
Definition: bin_parser.h:36
urcl::rtde_interface::RTDEPackage::RTDEPackage
RTDEPackage(const PackageType type)
Definition: rtde_package.h:50
urcl::rtde_interface::RTDEPackage::buffer_length_
size_t buffer_length_
Definition: rtde_package.h:73
urcl::rtde_interface::RTDEPackage::type_
PackageType type_
Definition: rtde_package.h:74
urcl::rtde_interface::RTDEPackage::parseWith
virtual bool parseWith(comm::BinParser &bp)
Sets the attributes of the package by parsing a serialized representation of the package.
Definition: rtde_package.cpp:34
urcl::rtde_interface::RTDEPackage
Definition: rtde_package.h:43
urcl::rtde_interface::PackageType
PackageType
Possible package types.
Definition: rtde/package_header.h:45
urcl::comm::URPackage
The URPackage a parent class. From that two implementations are inherited, one for the primary,...
Definition: package.h:43
package_header.h
package.h
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