From b21f4f09f2ef943ebb99cc8fddb212cbfd403a11 Mon Sep 17 00:00:00 2001
From: Rainer Kartmann <rainer.kartmann@kit.edu>
Date: Wed, 30 Aug 2023 08:31:45 +0200
Subject: [PATCH] Add docs
---
.../armem/core/wm/memory_definitions.cpp | 22 ++---
.../armem/core/wm/memory_definitions.h | 95 ++++++++++---------
2 files changed, 58 insertions(+), 59 deletions(-)
diff --git a/source/RobotAPI/libraries/armem/core/wm/memory_definitions.cpp b/source/RobotAPI/libraries/armem/core/wm/memory_definitions.cpp
index bfc408ac9..1da7db6bc 100644
--- a/source/RobotAPI/libraries/armem/core/wm/memory_definitions.cpp
+++ b/source/RobotAPI/libraries/armem/core/wm/memory_definitions.cpp
@@ -1,25 +1,23 @@
#include "memory_definitions.h"
-#include "error.h"
-
-#include <RobotAPI/libraries/aron/core/data/variant/container/Dict.h>
-#include <ArmarXCore/core/exceptions/local/ExpressionException.h>
-
#include <map>
#include <vector>
+#include <ArmarXCore/core/exceptions/local/ExpressionException.h>
+#include <RobotAPI/libraries/aron/core/data/variant/container/Dict.h>
+
+#include "error.h"
namespace armarx::armem::wm
{
- bool EntityInstance::equalsDeep(const EntityInstance& other) const
+ bool
+ EntityInstance::equalsDeep(const EntityInstance& other) const
{
if (_data and other.data())
{
- return id() == other.id()
- && _metadata == other.metadata()
- && *_data == *other.data();
+ return id() == other.id() && _metadata == other.metadata() && *_data == *other.data();
}
if (_data or other.data())
{
@@ -28,8 +26,8 @@ namespace armarx::armem::wm
return id() == other.id() && _metadata == other.metadata();
}
-
- void EntityInstance::update(const EntityUpdate& update)
+ void
+ EntityInstance::update(const EntityUpdate& update)
{
ARMARX_CHECK_FITS_SIZE(this->index(), update.instancesData.size());
@@ -42,4 +40,4 @@ namespace armarx::armem::wm
this->_metadata.arrivedTime = update.arrivedTime;
}
-}
+} // namespace armarx::armem::wm
diff --git a/source/RobotAPI/libraries/armem/core/wm/memory_definitions.h b/source/RobotAPI/libraries/armem/core/wm/memory_definitions.h
index 642cc50ed..ae338328d 100644
--- a/source/RobotAPI/libraries/armem/core/wm/memory_definitions.h
+++ b/source/RobotAPI/libraries/armem/core/wm/memory_definitions.h
@@ -1,35 +1,42 @@
#pragma once
-#include "detail/data_lookup_mixins.h"
-
+#include <RobotAPI/libraries/armem/core/base/CoreSegmentBase.h>
+#include <RobotAPI/libraries/armem/core/base/EntityBase.h>
#include <RobotAPI/libraries/armem/core/base/EntityInstanceBase.h>
#include <RobotAPI/libraries/armem/core/base/EntitySnapshotBase.h>
-#include <RobotAPI/libraries/armem/core/base/EntityBase.h>
-#include <RobotAPI/libraries/armem/core/base/ProviderSegmentBase.h>
-#include <RobotAPI/libraries/armem/core/base/CoreSegmentBase.h>
#include <RobotAPI/libraries/armem/core/base/MemoryBase.h>
-
+#include <RobotAPI/libraries/armem/core/base/ProviderSegmentBase.h>
#include <RobotAPI/libraries/aron/core/data/variant/forward_declarations.h>
+#include "detail/data_lookup_mixins.h"
namespace armarx::armem::wm
{
+ /**
+ * @brief Client-side working memory entity instance metadata.
+ */
using EntityInstanceMetadata = base::EntityInstanceMetadata;
+ /**
+ * @brief Client-side working memory entity instance data (payload).
+ */
using EntityInstanceData = armarx::aron::data::Dict;
+ /**
+ * @brief Pointer type of EntityInstanceData.
+ */
using EntityInstanceDataPtr = armarx::aron::data::DictPtr;
-
- /// @see base::EntityInstanceBase
+ /**
+ * @brief Client-side working entity instance.
+ * @see base::EntityInstanceBase
+ */
class EntityInstance :
public base::EntityInstanceBase<EntityInstanceDataPtr, EntityInstanceMetadata>
{
using Base = base::EntityInstanceBase<EntityInstanceDataPtr, EntityInstanceMetadata>;
public:
-
using Base::EntityInstanceBase;
-
/**
* @brief Fill `*this` with the update's values.
* @param update The update.
@@ -38,78 +45,72 @@ namespace armarx::armem::wm
void update(const EntityUpdate& update);
bool equalsDeep(const EntityInstance& other) const;
-
};
-
-
- /// @see base::EntitySnapshotBase
+ /**
+ * @brief Client-side working memory entity snapshot.
+ * @see base::EntitySnapshotBase
+ */
class EntitySnapshot :
- public base::EntitySnapshotBase<EntityInstance, EntitySnapshot>
- , public detail::FindInstanceDataMixinForSnapshot<EntitySnapshot>
+ public base::EntitySnapshotBase<EntityInstance, EntitySnapshot>,
+ public detail::FindInstanceDataMixinForSnapshot<EntitySnapshot>
{
public:
-
using base::EntitySnapshotBase<EntityInstance, EntitySnapshot>::EntitySnapshotBase;
-
};
-
- /// @see base::EntityBase
+ /**
+ * @brief Client-side working memory entity.
+ * @see base::EntityBase
+ */
class Entity :
- public base::EntityBase<EntitySnapshot, Entity>
- , public detail::FindInstanceDataMixinForEntity<Entity>
+ public base::EntityBase<EntitySnapshot, Entity>,
+ public detail::FindInstanceDataMixinForEntity<Entity>
{
public:
-
using base::EntityBase<EntitySnapshot, Entity>::EntityBase;
-
};
-
-
- /// @see base::ProviderSegmentBase
+ /**
+ * @brief Client-side working memory provider segment.
+ * @see base::ProviderSegmentBase
+ */
class ProviderSegment :
- public base::ProviderSegmentBase<Entity, ProviderSegment>
- , public detail::FindInstanceDataMixin<ProviderSegment>
+ public base::ProviderSegmentBase<Entity, ProviderSegment>,
+ public detail::FindInstanceDataMixin<ProviderSegment>
{
using Base = base::ProviderSegmentBase<Entity, ProviderSegment>;
public:
-
using Base::ProviderSegmentBase;
-
};
-
-
- /// @see base::CoreSegmentBase
+ /**
+ * @brief Client-side working memory core segment.
+ * @see base::CoreSegmentBase
+ */
class CoreSegment :
- public base::CoreSegmentBase<ProviderSegment, CoreSegment>
- , public detail::FindInstanceDataMixin<CoreSegment>
+ public base::CoreSegmentBase<ProviderSegment, CoreSegment>,
+ public detail::FindInstanceDataMixin<CoreSegment>
{
using Base = base::CoreSegmentBase<ProviderSegment, CoreSegment>;
public:
-
using Base::CoreSegmentBase;
-
};
-
-
- /// @see base::MemoryBase
+ /**
+ * @brief Client-side working memory.
+ * @see base::MemoryBase
+ */
class Memory :
- public base::MemoryBase<CoreSegment, Memory>
- , public detail::FindInstanceDataMixin<Memory>
+ public base::MemoryBase<CoreSegment, Memory>,
+ public detail::FindInstanceDataMixin<Memory>
{
using Base = base::MemoryBase<CoreSegment, Memory>;
public:
-
using Base::MemoryBase;
-
};
-}
-
+} // namespace armarx::armem::wm
--
GitLab