ProviderSegment.cpp
Go to the documentation of this file.
1 // Header
2 #include "ProviderSegment.h"
3 
4 #include <memory>
5 
6 // ArmarX
9 
12 
14 {
16  const std::string& exportName,
17  const armem::MemoryID& memoryId /* UNESCAPED */,
18  const std::shared_ptr<Processors>& filters,
19  const std::shared_ptr<persistence::MemoryPersistenceStrategy>& persistenceStrategy) :
20  ProviderSegmentBase(exportName, memoryId, filters),
21  persistenceStrategy_(persistenceStrategy)
22  {
23  //start();
24  }
25 
26  bool
27  ProviderSegment::forEachEntity(std::function<void(Entity&)> func) const
28  {
29  std::lock_guard l(ltm_mutex);
30 
32 
33  ARMARX_DEBUG << "For each entity (provider segment id=" << id().cleanID().str();
34 
35  for (std::string& entityName : persistenceStrategy_->getContainerKeys(id()))
36  {
37  ARMARX_DEBUG << "Found entity=" << entityName;
38 
39  std::shared_ptr<persistence::MemoryPersistenceStrategy> entityPersistenceStrategy(
40  persistenceStrategy_);
41 
42  Entity ltmEntity(getExportName(),
43  id().withEntityName(entityName),
44  processors,
45  entityPersistenceStrategy);
46 
47  func(ltmEntity);
48  }
49 
50  return true;
51  }
52 
53  bool
54  ProviderSegment::hasEntity(const std::string& entityName) const
55  {
56  std::lock_guard l(ltm_mutex);
57 
59 
60  return persistenceStrategy_->containsContainer(id(), entityName);
61  }
62 
63  std::shared_ptr<Entity>
64  ProviderSegment::findEntity(const std::string& entityName) const
65  {
66  std::lock_guard l(ltm_mutex);
67 
69 
70  if (!hasEntity(entityName))
71  {
72  return nullptr;
73  }
74 
75  return std::make_shared<Entity>(
76  getExportName(), id().withEntityName(entityName), processors, persistenceStrategy_);
77  }
78 
79  void
81  {
82  std::lock_guard l(ltm_mutex);
83 
85 
86  wmProviderSegment.id() = id().getProviderSegmentID().cleanID();
87 
88  auto& conv = processors->defaultTypeConverter;
89  if (persistenceStrategy_->containsItem(
91  {
92  // load and set type
93  auto& conv = processors->defaultTypeConverter;
94 
95  auto filecontent = persistenceStrategy_->retrieveItem(
97  auto aron = conv.convert(filecontent, "");
98  wmProviderSegment.aronType() = aron;
99  }
100 
102  [&wmProviderSegment](auto& ltmEntity)
103  {
104  armem::wm::Entity wmEntity;
105  ltmEntity.loadAllReferences(wmEntity);
106 
107  // Because there might be multiple LTMs with the same entity
108  if (wmProviderSegment.hasEntity(wmEntity.name()))
109  {
110  armem::wm::Entity existingWmEntity =
111  wmProviderSegment.getEntity(wmEntity.name());
112  existingWmEntity.append(wmEntity);
113  }
114  else
115  {
116  wmProviderSegment.addEntity(wmEntity);
117  }
118  });
119  }
120 
121  void
123  {
124  std::lock_guard l(ltm_mutex);
125 
126  ARMARX_TRACE;
127 
128  wmProviderSegment.id() = id().getProviderSegmentID().cleanID();
129 
130  auto& conv = processors->defaultTypeConverter;
131 
132  if (persistenceStrategy_->containsItem(
134  {
135  // load and set type
136  auto& conv = processors->defaultTypeConverter;
137 
138  auto filecontent = persistenceStrategy_->retrieveItem(
140  auto aron = conv.convert(filecontent, "");
141  wmProviderSegment.aronType() = aron;
142  }
143 
145  [&wmProviderSegment, &n](auto& ltmEntity)
146  {
147  armem::wm::Entity wmEntity;
148  ltmEntity.loadLatestNReferences(n, wmEntity);
149 
150  // Because there might be multiple LTMs with the same entity
151  if (wmProviderSegment.hasEntity(wmEntity.name()))
152  {
153  armem::wm::Entity existingWmEntity =
154  wmProviderSegment.getEntity(wmEntity.name());
155  existingWmEntity.append(wmEntity);
156  }
157  else
158  {
159  wmProviderSegment.addEntity(wmEntity);
160  }
161  });
162  }
163 
164  void
166  {
167  std::lock_guard l(ltm_mutex);
168 
169  ARMARX_TRACE;
170 
171  ARMARX_DEBUG << "Resolve provider segment id=" << id().cleanID().str();
172 
173  wmProviderSegment.forEachEntity(
174  [&](auto& wmEntity)
175  {
176  std::shared_ptr<persistence::MemoryPersistenceStrategy> entityPersistenceStrategy(
177  persistenceStrategy_);
178 
179  Entity ltmEntity(getExportName(),
180  id().withEntityName(wmEntity.id().entityName),
181  processors,
182  entityPersistenceStrategy);
183  ltmEntity.resolve(wmEntity);
184  });
185  }
186 
187  void
189  bool simulatedVersion)
190  {
191  std::lock_guard l(ltm_mutex);
192 
193  ARMARX_TRACE;
194 
195  if (id().providerSegmentName.empty())
196  {
198  << "During storage of segment '" << wmProviderSegment.id().str()
199  << "' I noticed that the corresponding LTM has no id set. "
200  << "I set the id of the LTM to the same name, however this should not happen!";
201  id().providerSegmentName = wmProviderSegment.id().providerSegmentName;
202  }
203 
204  ARMARX_DEBUG << "Store provider segment id=" << id().cleanID().str();
205 
206  if (wmProviderSegment.hasAronType())
207  {
208  auto& conv = processors->defaultTypeConverter;
209 
210  auto type = wmProviderSegment.aronType();
211 
212  auto [vec, modeSuffix] = conv.convert(type);
213  ARMARX_CHECK_EMPTY(modeSuffix);
214 
215  std::string key = (persistence::MemoryPersistenceStrategy::TYPE_FILENAME + conv.suffix);
216  persistenceStrategy_->storeItem(id(), key, vec);
217 
218  ARMARX_DEBUG << "Stored type information at " << key;
219  }
220  else
221  {
222  ARMARX_DEBUG << "ProviderSegment " << wmProviderSegment.id().providerSegmentName
223  << " does not seem to have an aron type, so aron type "
224  "information connot be exported";
225  //writeForeignKeyToPreviousDocument();
226  }
227 
228  wmProviderSegment.forEachEntity(
229  [&](const auto& wmEntity)
230  {
231  std::shared_ptr<persistence::MemoryPersistenceStrategy> entityPersistenceStrategy(
232  persistenceStrategy_);
233 
234  Entity ltmEntity(getExportName(),
235  id().withEntityName(wmEntity.id().entityName),
236  processors,
237  entityPersistenceStrategy);
238 
239  ltmEntity.store(wmEntity, simulatedVersion);
240  statistics.recordedEntities++;
241  });
242  }
243 
244 } // namespace armarx::armem::server::ltm
armarx::armem::server::ltm::ProviderSegment::_loadLatestNReferences
void _loadLatestNReferences(int n, armem::wm::ProviderSegment &wmProviderSegment) override
Definition: ProviderSegment.cpp:122
armarx::armem::server::ltm::ProviderSegment::hasEntity
bool hasEntity(const std::string &entityName) const override
check if entity segment exists
Definition: ProviderSegment.cpp:54
armarx::armem::server::ltm::detail::MemoryItem::processors
std::shared_ptr< Processors > processors
Definition: MemoryItem.h:54
armarx::armem::wm::ProviderSegment
Client-side working memory provider segment.
Definition: memory_definitions.h:105
armarx::armem::MemoryID::providerSegmentName
std::string providerSegmentName
Definition: MemoryID.h:52
armarx::armem::server::ltm::detail::EntityBase::resolve
void resolve(armem::wm::Entity &e)
convert the references of the input into a wm::Memory
Definition: EntityBase.h:46
MemoryPersistenceStrategy.h
armarx::armem::server::ltm::persistence::MemoryPersistenceStrategy::TYPE_FILENAME
static const constexpr char * TYPE_FILENAME
Definition: MemoryPersistenceStrategy.h:191
ARMARX_CHECK_EMPTY
#define ARMARX_CHECK_EMPTY(c)
Definition: ExpressionException.h:218
armarx::armem::MemoryID::str
std::string str(bool escapeDelimiters=true) const
Get a string representation of this memory ID.
Definition: MemoryID.cpp:102
armarx::armem::server::ltm::Entity
A memory storing data in mongodb (needs 'armarx memory start' to start the mongod instance)
Definition: Entity.h:14
armarx::armem::base::detail::AronTyped::aronType
aron::type::ObjectPtr & aronType()
Definition: AronTyped.cpp:19
armarx::armem::server::ltm::detail::ProviderSegmentBase< Entity >::ltm_mutex
std::recursive_mutex ltm_mutex
Definition: ProviderSegmentBase.h:99
armarx::armem::server::ltm::ProviderSegment::ProviderSegment
ProviderSegment(const std::string &exportName, const MemoryID &memoryId, const std::shared_ptr< Processors > &filters, const std::shared_ptr< persistence::MemoryPersistenceStrategy > &persistenceStrategy)
Definition: ProviderSegment.cpp:15
magic_enum::detail::n
constexpr auto n() noexcept
Definition: magic_enum.hpp:418
memory_definitions.h
ARMARX_TRACE
#define ARMARX_TRACE
Definition: trace.h:77
armarx::armem::server::ltm::ProviderSegment::forEachEntity
bool forEachEntity(std::function< void(Entity &)> func) const override
iterate over all core segments of this ltm
Definition: ProviderSegment.cpp:27
armarx::armem::MemoryID
A memory ID.
Definition: MemoryID.h:47
armarx::armem::server::ltm::ProviderSegment::findEntity
std::shared_ptr< Entity > findEntity(const std::string &entityName) const override
find entity segment
Definition: ProviderSegment.cpp:64
armarx::armem::base::ProviderSegmentBase::hasEntity
bool hasEntity(const std::string &name) const
Definition: ProviderSegmentBase.h:112
ARMARX_DEBUG
#define ARMARX_DEBUG
Definition: Logging.h:184
armarx::armem::server::ltm::ProviderSegment::_resolve
void _resolve(armem::wm::ProviderSegment &wmProviderSegment) override
Definition: ProviderSegment.cpp:165
ProviderSegment.h
armarx::armem::server::ltm::detail::ProviderSegmentBase< Entity >::statistics
Statistics statistics
Definition: ProviderSegmentBase.h:101
armarx::armem::server::ltm::detail::MemoryItem::getExportName
virtual std::string getExportName() const
Definition: MemoryItem.h:27
armarx::armem::MemoryID::getProviderSegmentID
MemoryID getProviderSegmentID() const
Definition: MemoryID.cpp:302
armarx::armem::server::ltm::ProviderSegment::_store
void _store(const armem::wm::ProviderSegment &wmProviderSegment, bool simulatedVersion) override
Definition: ProviderSegment.cpp:188
armarx::armem::base::detail::MemoryItem::id
MemoryID & id()
Definition: MemoryItem.h:25
armarx::armem::server::ltm::ProviderSegment::_loadAllReferences
void _loadAllReferences(armem::wm::ProviderSegment &wmProviderSegment) override
Definition: ProviderSegment.cpp:80
armarx::armem::server::ltm::detail::EntityBase::store
void store(const armem::wm::Entity &e, bool simulatedVersion)
encode the content of a wm::Memory and store
Definition: EntityBase.h:53
armarx::armem::server::ltm
Definition: forward_declarations.h:20
armarx::armem::server::ltm::detail::MemoryItem::id
MemoryID id() const
Definition: MemoryItem.cpp:37
armarx::armem::MemoryID::cleanID
MemoryID cleanID() const
Definition: MemoryID.cpp:133
TimeUtil.h
armarx::armem::base::ProviderSegmentBase::forEachEntity
bool forEachEntity(EntityFunctionT &&func)
Definition: ProviderSegmentBase.h:193
armarx::armem::base::detail::AronTyped::hasAronType
bool hasAronType() const
Definition: AronTyped.cpp:13
armarx::armem::wm::Entity
Client-side working memory entity.
Definition: memory_definitions.h:93
Logging.h
ARMARX_WARNING
#define ARMARX_WARNING
Definition: Logging.h:193
armarx::armem::base::EntityBase::name
std::string & name()
Definition: EntityBase.h:94