Adapt HRN, CancellationContext and Condition to coding style. (#594)

This commit adapt the above-mentioned classes the coding style,
also marks the public members of HRN as deprecated and to be
scoped to private by 05.2020 as it is not recommended by HERE Platform
to interpret the HRN in any way. Users should only use public methods
available and not care about the composition of the HRN string.

Relates-to: OLPEDGE-567

Signed-off-by: Andrei Popescu <[email protected]>

Author: andescu

olp-cpp-sdk-core/include/olp/core/client/CancellationContext.h

@@ -22,9 +22,9 @@
 #include <functional>
 #include <memory>
 #include <mutex>
-#include "CancellationToken.h"
 
 #include <olp/core/CoreApi.h>
+#include <olp/core/client/CancellationToken.h>
 
 namespace olp {
 namespace client {

olp-cpp-sdk-core/include/olp/core/client/Condition.h

@@ -19,11 +19,12 @@
 
 #pragma once
 
-#include <olp/core/client/CancellationContext.h>
 #include <chrono>
 #include <condition_variable>
 #include <mutex>
 
+#include <olp/core/client/CancellationContext.h>
+
 namespace olp {
 namespace client {
 
@@ -40,15 +41,13 @@ class Condition final {
    * routine.
    */
   void Notify() {
-    {
-      std::unique_lock<std::mutex> lock(mutex_);
-      signaled_ = true;
+    std::unique_lock<std::mutex> lock(mutex_);
+    signaled_ = true;
 
-      // Condition should be under the lock in order to not run into the data
-      // race, which might occur when spurious wakeup happens in the other
-      // thread while waiting for the condition's signal.
-      condition_.notify_one();
-    }
+    // Condition should be under the lock in order to not run into the data
+    // race, which might occur when spurious wakeup happens in the other
+    // thread while waiting for the condition's signal.
+    condition_.notify_one();
   }
 
   /**

olp-cpp-sdk-core/include/olp/core/client/HRN.h

@@ -26,75 +26,132 @@
 
 namespace olp {
 namespace client {
-/// \brief The Here Resource Name (HRN) class, this allows HRN's to be passed to
-/// the operations that require it.
+
+/**
+ * @brief The Here Resource Name (HRN) class, this allows HRN's to be passed to
+ * the operations that require it.
+ */
 class CORE_API HRN {
  public:
-  /// The ServiceType enum defines the different objects that a HRN can refer to
+  /**
+   * @brief The ServiceType enum defines the different objects that a HRN can
+   * refer to.
+   */
   enum ServiceType {
-    Unknown,  ///< the service type is unknown
-    Data,     ///< a data catalog
-    Schema,   ///< a schema type
-    Pipeline  ///< a pipeline instance
+    Unknown,  ///< The service type is unknown.
+    Data,     ///< This HRN represents a data catalog.
+    Schema,   ///< This HRN represents a schema type.
+    Pipeline  ///< This HRN represents a pipeline instance.
   };
 
-  /// the partition of the HRN
+  /**
+   * @brief Constructs a `HRN` from its string form.
+   *
+   * The passed string must start with "hrn:".
+   *
+   * @param input The `HRN` in string form.
+   */
+  explicit HRN(const std::string& input);
+
+  /**
+   * @brief Constructs a new instance of `HRN` from its string form.
+   *
+   * The passed string must start with "hrn:".
+   *
+   * @param input The `HRN` in string form.
+   *
+   * @return A new instance of `HRN` created from string.
+   */
+  static HRN FromString(const std::string& input);
+
+  /**
+   * @brief Constructs a unique instance of `HRN` from its string form.
+   *
+   * The passed string must start with "hrn:".
+   *
+   * @param input The `HRN` in string form.
+   *
+   * @return A new instance of `HRN` created from string.
+   */
+  static std::unique_ptr<HRN> UniqueFromString(const std::string& input);
+
+  HRN() = default;
+
+  /**
+   * @brief The HRN class equality operator.
+   */
+  bool operator==(const HRN& rhs) const;
+
+  /**
+   * @brief The HRN class inequality operator.
+   */
+  bool operator!=(const HRN& rhs) const;
+
+  /**
+   * @brief The HRN class bool operator.
+   *
+   * @return Returns true if this `HRN` instance has all service type relevant
+   * fields not empty, false otherwise.
+   */
+  explicit operator bool() const;
+
+  /**
+   * @brief Checks the internal status of the `HRN` instance.
+   *
+   * @return Returns true if this `HRN` instance has at least one of the service
+   * type relevant fields empty, false otherwise.
+   */
+  bool IsNull() const;
+
+  /**
+   * @brief Returns this `HRN` instance in its string form, prefixed with
+   * "hrn:".
+   */
+  std::string ToString() const;
+
+  /**
+   * @brief Returns this `HRN` instance in its string form for catalog ID,
+   * prefixed with "hrn:".
+   *
+   * @note Only relevant for when the `HRN` has ServiceType == Data.
+   */
+  std::string ToCatalogHRNString() const;
+
+  /// The partition of the HRN, must be valid when ServiceType == Data or when
+  /// when ServiceType == Pipeline
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string partition;
-  /// the service of the HRN
+  /// The service of the HRN.
+  /// @deprecated This field will be marked as private by 05.2020.
   ServiceType service{ServiceType::Unknown};
-  /// the region of the HRN
+  /// The region of the HRN.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string region;
-  /// the account of the HRN
+  /// The account of the HRN.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string account;
 
-  /// Catalog ID, valid when HRNServiceType == Data
+  /// The catalog ID, must be valid when ServiceType == Data.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string catalogId;
-  /// Layer ID, optional
+  /// The layer ID, optional.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string layerId;
 
-  /// Group ID, valid when HRNServiceType == Schema
+  /// The group ID, must be valid when ServiceType == Schema.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string groupId;
-  /// Schema Name
+  /// The schema name, must be valid when ServiceType == Schema.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string schemaName;
-  /// Version
+  /// The version, must be valid when ServiceType == Schema.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string version;
 
-  /// Pipeline ID, valid when HRNServiceType == Pipeline
+  /// Pipeline ID, valid when ServiceType == Pipeline.
+  /// @deprecated This field will be marked as private by 05.2020.
   std::string pipelineId;
-
-  /// \brief returns this HRN in its string form, prefixed with hrn:
-  std::string ToString() const;
-
-  /// \brief returns this HRN in its string form for catalog ID, prefixed with
-  /// hrn:
-  std::string ToCatalogHRNString() const;
-
-  /// \brief default constructor
-  HRN() = default;
-
-  /// \brief constructs a HRN from its string form. Must start with "hrn:".
-  /// As a special case to support existing command line clients, http: and
-  /// https: are also accepted
-  explicit HRN(const std::string& input);
-
-  /// \brief constructs a HRN from its string form. Must start with "hrn:".
-  /// As a special case to support existing command line clients, http: and
-  /// https: are also accepted
-  static HRN FromString(const std::string& input);
-
-  /// \brief constructs a HRN from its string form. Must start with "hrn:".
-  /// As a special case to support existing command line clients, http: and
-  /// https: are also accepted
-  static std::unique_ptr<HRN> UniqueFromString(const std::string& input);
-
-  /// \brief The HRN class equality operator
-  bool operator==(const HRN& other) const;
-
-  /// \brief The HRN class inequality operator
-  bool operator!=(const HRN& other) const;
-
-  /// \brief returns true if HRN is null (all fields empty), false otherwise
-  bool IsNull() const;
 };
+
 }  // namespace client
 }  // namespace olp