HumanPoseReader.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * ArmarX is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * ArmarX is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * @author Fabian Reister ( fabian dot reister at kit dot edu )
17  * @date 2021
18  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
19  * GNU General Public License
20  */
21 
22 #pragma once
23 
27 
29 
31 {
32 
34  {
35  public:
37  ~Reader() override;
38 
39  struct Query
40  {
41  // if empty, will query all providers
42  std::string providerName;
44 
46  };
47 
48  struct Result
49  {
50  std::vector<HumanPose> humanPoses{};
51 
52  enum class Status
53  {
54  Success,
55  NoData,
56  Error
57  } status;
58 
59  std::string errorMessage = "";
60 
61  operator bool() const noexcept
62  {
63  return status != Status::Error;
64  }
65  };
66 
67  Result query(const Query& query) const;
68 
69 
70  protected:
72 
73  std::string propertyPrefix() const override;
74  Properties defaultProperties() const override;
75  };
76 
77 } // namespace armarx::armem::human::client
armarx::armem::human::client::Reader::defaultProperties
Properties defaultProperties() const override
Definition: HumanPoseReader.cpp:51
armarx::armem::human::client::Reader::Result::errorMessage
std::string errorMessage
Definition: HumanPoseReader.h:59
armarx::armem::human::client::Reader::Result::Status::Error
@ Error
armarx::armem::human::client::Reader::Result
Definition: HumanPoseReader.h:48
armarx::armem::human::client
Definition: HumanPoseReader.cpp:14
armarx::status
status
Definition: FiniteStateMachine.h:259
types.h
armarx::armem::human::client::Reader::Result::Status::Success
@ Success
armarx::armem::human::client::Reader::Query::maxAge
Duration maxAge
Definition: HumanPoseReader.h:45
armarx::armem::human::client::Reader::Result::humanPoses
std::vector< HumanPose > humanPoses
Definition: HumanPoseReader.h:50
armarx::armem::human::client::Reader::Query::providerName
std::string providerName
Definition: HumanPoseReader.h:42
armarx::core::time::DateTime
Represents a point in time.
Definition: DateTime.h:24
armarx::armem::human::client::Reader::Result::Status::NoData
@ NoData
armarx::armem::human::client::Reader::Result::status
enum armarx::armem::human::client::Reader::Result::Status status
armarx::core::time::Duration
Represents a duration.
Definition: Duration.h:17
Time.h
Builder.h
armarx::armem::client::util::SimpleReaderBase::SimpleReaderBase
SimpleReaderBase()
Definition: SimpleReaderBase.cpp:9
armarx::armem::human::client::Reader
Definition: HumanPoseReader.h:33
armarx::armem::client::query::Builder
The query::Builder class provides a fluent-style specification of hierarchical queries.
Definition: Builder.h:22
armarx::armem::human::client::Reader::Query::timestamp
armem::Time timestamp
Definition: HumanPoseReader.h:43
armarx::armem::human::client::Reader::buildQuery
::armarx::armem::client::query::Builder buildQuery(const Query &query) const
Definition: HumanPoseReader.cpp:19
armarx::armem::human::client::Reader::Result::Status
Status
Definition: HumanPoseReader.h:52
SimpleReaderBase.h
armarx::armem::client::util::SimpleReaderBase
Definition: SimpleReaderBase.h:38
armarx::armem::human::client::Reader::Query
Definition: HumanPoseReader.h:39
armarx::armem::human::client::Reader::~Reader
~Reader() override
armarx::armem::human::client::Reader::query
Result query(const Query &query) const
Definition: HumanPoseReader.cpp:106
armarx::armem::human::client::Reader::propertyPrefix
std::string propertyPrefix() const override
Definition: HumanPoseReader.cpp:45