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 //
6 // Licensed under the Apache License, Version 2.0 (the "License");
7 // you may not use this file except in compliance with the License.
8 // You may obtain a copy of the License at
9 //
10 // http://www.apache.org/licenses/LICENSE-2.0
11 //
12 // Unless required by applicable law or agreed to in writing, software
13 // distributed under the License is distributed on an "AS IS" BASIS,
14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 // See the License for the specific language governing permissions and
16 // limitations under the License.
17 // -- END LICENSE BLOCK ------------------------------------------------
18 
19 //----------------------------------------------------------------------
26 //----------------------------------------------------------------------
27 
28 #ifndef UR_CLIENT_LIBRARY_PRIMARY_PACKAGE_H_INCLUDED
29 #define UR_CLIENT_LIBRARY_PRIMARY_PACKAGE_H_INCLUDED
30 
33 
34 namespace urcl
35 {
36 namespace primary_interface
37 {
38 class AbstractPrimaryConsumer;
39 
45 class PrimaryPackage : public comm::URPackage<PackageHeader>
46 {
47 public:
52  {
53  }
54  virtual ~PrimaryPackage() = default;
55 
64  virtual bool parseWith(comm::BinParser& bp);
65 
74  virtual bool consumeWith(AbstractPrimaryConsumer& consumer) = 0;
75 
81  virtual std::string toString() const;
82 
83 protected:
84  std::unique_ptr<uint8_t> buffer_;
86 };
87 
88 } // namespace primary_interface
89 } // namespace urcl
90 
91 #endif /* UR_CLIENT_LIBRARY_PRIMARY_PACKAGE_H_INCLUDED */
virtual bool consumeWith(AbstractPrimaryConsumer &consumer)=0
Consume this package with a specific consumer. This should be overwritten in inherited packages...
virtual bool parseWith(comm::BinParser &bp)
Sets the attributes of the package by parsing a serialized representation of the package.
The BinParser class handles a byte buffer and functionality to iteratively parse the content...
Definition: bin_parser.h:44
std::unique_ptr< uint8_t > buffer_
The PrimaryPackage is solely an abstraction level. It inherits form the URPackage and is also a paren...
The URPackage a parent class. From that two implementations are inherited, one for the primary...
Definition: package.h:42
virtual std::string toString() const
Produces a human readable representation of the package object.
PrimaryPackage()
Creates a new PrimaryPackage object.


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Sun May 9 2021 02:16:26