Add Private function to world identifier (#414)

* Add Private function to world identifier Signed-off-by: Nate Koenig <[email protected]> * Update include/gz/fuel_tools/WorldIdentifier.hh Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Nate Koenig <[email protected]> * Wrap line Signed-off-by: Nate Koenig <[email protected]> --------- Signed-off-by: Nate Koenig <[email protected]> Co-authored-by: Alejandro Hernández Cordero <[email protected]>
gazebosim · Apr 16, 2024 · 6880aec · 6880aec
1 parent 6cbce88
commit 6880aec
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/include/gz/fuel_tools/WorldIdentifier.hh b/include/gz/fuel_tools/WorldIdentifier.hh
@@ -150,6 +150,16 @@ namespace gz
       /// \return World information string
       public: std::string AsPrettyString(const std::string &_prefix = "") const;
 
+      /// \brief Returns the privacy setting of the world.
+      /// \return True if the world is private, false if the world is
+      /// public.
+      public: bool Private() const;
+
+      /// \brief Set the privacy setting of the world.
+      /// \param[in] _private True indicates the world is private,
+      /// false indicates the world is public.
+      public: void SetPrivate(bool _private);
+
       /// \brief PIMPL
       private: std::unique_ptr<WorldIdentifierPrivate> dataPtr;
     };

diff --git a/src/WorldIdentifier.cc b/src/WorldIdentifier.cc
@@ -43,8 +43,12 @@ class gz::fuel_tools::WorldIdentifierPrivate
   /// \brief World version. Valid versions start from 1, 0 means the tip.
   public: unsigned int version{0};
 
-  /// \brief Path of this model in the local cache
+  /// \brief Path of this world in the local cache
   public: std::string localPath;
+
+  /// \brief True indicates the world is private, false indicates the
+  /// world is public.
+  public: bool privacy{false};
 };
 
 //////////////////////////////////////////////////
@@ -229,3 +233,14 @@ std::string WorldIdentifier::AsPrettyString(const std::string &_prefix) const
   return out.str();
 }
 
+//////////////////////////////////////////////////
+bool WorldIdentifier::Private() const
+{
+  return this->dataPtr->privacy;
+}
+
+//////////////////////////////////////////////////
+void WorldIdentifier::SetPrivate(bool _private)
+{
+  this->dataPtr->privacy = _private;
+}
diff --git a/src/WorldIdentifier_TEST.cc b/src/WorldIdentifier_TEST.cc
@@ -37,6 +37,12 @@ TEST(WorldIdentifier, SetFields)
   EXPECT_EQ(std::string("hello"), id.Name());
   EXPECT_EQ(std::string("acai"), id.Owner());
   EXPECT_EQ(6u, id.Version());
+
+  EXPECT_FALSE(id.Private());
+  id.SetPrivate(true);
+  EXPECT_TRUE(id.Private());
+  id.SetPrivate(false);
+  EXPECT_FALSE(id.Private());
 }
 
 /////////////////////////////////////////////////