primary_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_PRIMARY_PACKAGE_H_INCLUDED
30 #define UR_CLIENT_LIBRARY_PRIMARY_PACKAGE_H_INCLUDED
31 
34 
35 namespace urcl
36 {
37 namespace primary_interface
38 {
39 class AbstractPrimaryConsumer;
40 
46 class PrimaryPackage : public comm::URPackage<PackageHeader>
47 {
48 public:
53  {
54  }
55  virtual ~PrimaryPackage() = default;
56 
65  virtual bool parseWith(comm::BinParser& bp);
66 
75  virtual bool consumeWith(AbstractPrimaryConsumer& consumer) = 0;
76 
82  virtual std::string toString() const;
83 
84 protected:
85  std::unique_ptr<uint8_t[]> buffer_;
87 };
88 
89 } // namespace primary_interface
90 } // namespace urcl
91 
92 #endif /* UR_CLIENT_LIBRARY_PRIMARY_PACKAGE_H_INCLUDED */
urcl::primary_interface::PrimaryPackage::buffer_length_
size_t buffer_length_
Definition: primary_package.h:86
urcl::primary_interface::PrimaryPackage::~PrimaryPackage
virtual ~PrimaryPackage()=default
urcl::primary_interface::PrimaryPackage::PrimaryPackage
PrimaryPackage()
Creates a new PrimaryPackage object.
Definition: primary_package.h:52
package_header.h
urcl
Definition: bin_parser.h:36
urcl::primary_interface::PrimaryPackage::parseWith
virtual bool parseWith(comm::BinParser &bp)
Sets the attributes of the package by parsing a serialized representation of the package.
Definition: primary_package.cpp:36
urcl::primary_interface::PrimaryPackage::consumeWith
virtual bool consumeWith(AbstractPrimaryConsumer &consumer)=0
Consume this package with a specific consumer. This should be overwritten in inherited packages.
urcl::primary_interface::PrimaryPackage::toString
virtual std::string toString() const
Produces a human readable representation of the package object.
Definition: primary_package.cpp:42
urcl::primary_interface::PrimaryPackage::buffer_
std::unique_ptr< uint8_t[]> buffer_
Definition: primary_package.h:85
urcl::comm::URPackage
The URPackage a parent class. From that two implementations are inherited, one for the primary,...
Definition: package.h:43
package.h
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::PrimaryPackage
The PrimaryPackage is solely an abstraction level. It inherits form the URPackage and is also a paren...
Definition: primary_package.h:46
urcl::primary_interface::AbstractPrimaryConsumer
Base consumer for primary packages.
Definition: abstract_primary_consumer.h:50


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