Writer.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  * @package RobotAPI::ArmarXObjects::
17  * @author Fabian Reister ( fabian dot reister at kit dot edu )
18  * @date 2021
19  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
20  * GNU General Public License
21  */
22 
23 #pragma once
24 
25 #include <mutex>
26 
28 
31 
33 {
34 
35  /**
36  * @defgroup Component-ExampleClient ExampleClient
37  * @ingroup RobotAPI-Components
38  * A description of the component ExampleClient.
39  *
40  * @class ExampleClient
41  * @ingroup Component-ExampleClient
42  * @brief Brief description of class ExampleClient.
43  *
44  * Detailed description of class ExampleClient.
45  */
47  {
48  public:
50  ~Writer() override;
51 
52  bool store(const armarx::navigation::human::Humans& humans,
53  // const std::string& name,
54  const std::string& providerName,
55  const armem::Time& timestamp);
56 
58  // const std::string& name,
59  const std::string& providerName,
60  const armem::Time& timestamp);
61 
62  protected:
63  std::string propertyPrefix() const override;
64  Properties defaultProperties() const override;
65 
66  private:
67  std::mutex writeMutex;
68  };
69 
70 
71 } // namespace armarx::navigation::memory::client::human
armarx::navigation::memory::client::human
Definition: Reader.cpp:24
armarx::armem::client::util::SimpleWriterBase::Properties
Definition: SimpleWriterBase.h:49
types.h
armarx::navigation::human::Humans
std::vector< Human > Humans
Definition: types.h:45
armarx::armem::client::util::SimpleWriterBase::SimpleWriterBase
SimpleWriterBase()
Definition: SimpleWriterBase.cpp:8
Costmap.h
armarx::navigation::memory::client::human::Writer::~Writer
~Writer() override
armarx::navigation::memory::client::human::Writer::store
bool store(const armarx::navigation::human::Humans &humans, const std::string &providerName, const armem::Time &timestamp)
Definition: Writer.cpp:18
armarx::navigation::memory::client::human::Writer::defaultProperties
Properties defaultProperties() const override
Definition: Writer.cpp:126
armarx::armem::client::util::SimpleWriterBase
Definition: SimpleWriterBase.h:38
armarx::navigation::memory::client::human::Writer
Definition: Writer.h:46
armarx::core::time::DateTime
Represents a point in time.
Definition: DateTime.h:24
SimpleWriterBase.h
armarx::navigation::human::HumanGroups
std::vector< HumanGroup > HumanGroups
Definition: types.h:58
armarx::navigation::memory::client::human::Writer::propertyPrefix
std::string propertyPrefix() const override
Definition: Writer.cpp:120