summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2019-02-22 15:22:21 -0600
committerMatt Spinler <spinler@us.ibm.com>2019-04-05 15:05:32 +0000
commitea80c33dec0e331703e44f0f1d1286138c87cbcf (patch)
tree8caf3c2efe79ed9d2253986c873f48a7fcf11486
parent4511b33fe27dbb2cc8839f7e2ee365b12c398f20 (diff)
downloadphosphor-objmgr-ea80c33dec0e331703e44f0f1d1286138c87cbcf.zip
phosphor-objmgr-ea80c33dec0e331703e44f0f1d1286138c87cbcf.tar.gz
unit-test: Add some doc on Association
Next set of unit tests use this data structure so added some doc and an example Change-Id: Iabc89fc66ff68ccbf872e8cb48dc75b75c78908f Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
-rw-r--r--src/associations.hpp3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/associations.hpp b/src/associations.hpp
index 7cd3842..91a9fcd 100644
--- a/src/associations.hpp
+++ b/src/associations.hpp
@@ -45,6 +45,9 @@ using AssociationPaths =
using AssociationOwnersType = boost::container::flat_map<
std::string, boost::container::flat_map<std::string, AssociationPaths>>;
+// Store the contents of the associations property on the interface
+// For example:
+// ["inventory", "activation", "/xyz/openbmc_project/inventory/system/chassis"]
using Association = std::tuple<std::string, std::string, std::string>;
/** @brief Remove input association
OpenPOWER on IntegriCloud