property.h

Go to the documentation of this file.

// === property.h ======================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_META_PROPERTY_H
#define SEN_CORE_META_PROPERTY_H
 
#include "sen/core/base/class_helpers.h"
#include "sen/core/meta/event.h"
#include "sen/core/meta/method.h"
#include "sen/core/meta/type.h"
 
// std
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
 
namespace sen
{


enum class PropertyCategory
{
  staticRO,   
  staticRW,   
  dynamicRW,  
  dynamicRO,  
};

struct PropertySpec final
{
  PropertySpec(std::string name,
               std::string description,
               ConstTypeHandle<> type,
               PropertyCategory category = PropertyCategory::dynamicRO,
               TransportMode transportMode = TransportMode::multicast,
               bool checkedSet = false,
               std::vector<std::string> tags = {})
    : name(std::move(name))
    , description(std::move(description))
    , category(category)
    , type(std::move(type))
    , transportMode(transportMode)
    , tags(std::move(tags))
    , checkedSet(checkedSet)
  {
  }
 
  // Comparison operators
  friend bool operator==(const PropertySpec& lhs, const PropertySpec& rhs) noexcept
  {
    return lhs.name == rhs.name && lhs.description == rhs.description && lhs.category == rhs.category &&
           lhs.transportMode == rhs.transportMode && lhs.tags == rhs.tags && lhs.checkedSet == rhs.checkedSet &&
           lhs.type == rhs.type;
  }
  friend bool operator!=(const PropertySpec& lhs, const PropertySpec& rhs) noexcept { return !(lhs == rhs); }
 
public:
  std::string name;                                         // NOLINT(misc-non-private-member-variables-in-classes)
  std::string description;                                  // NOLINT(misc-non-private-member-variables-in-classes)
  PropertyCategory category = PropertyCategory::dynamicRO;  // NOLINT(misc-non-private-member-variables-in-classes)
  ConstTypeHandle<> type;                                   // NOLINT(misc-non-private-member-variables-in-classes)
  TransportMode transportMode = TransportMode::multicast;   // NOLINT(misc-non-private-member-variables-in-classes)
  std::vector<std::string> tags;                            // NOLINT(misc-non-private-member-variables-in-classes)
  bool checkedSet = false;                                  // NOLINT(misc-non-private-member-variables-in-classes)
};

class Property final
{
  SEN_NOCOPY_NOMOVE(Property)
  SEN_PRIVATE_TAG
 
public:
  [[nodiscard]] static std::shared_ptr<Property> make(PropertySpec spec);
 
public:  // special members
  Property(PropertySpec spec, Private notUsable);
  ~Property() = default;
 
public:
  [[nodiscard]] std::string_view getName() const noexcept;

  [[nodiscard]] std::string_view getDescription() const noexcept;

  [[nodiscard]] MemberHash getId() const noexcept;

  [[nodiscard]] PropertyCategory getCategory() const noexcept;

  [[nodiscard]] ConstTypeHandle<> getType() const noexcept;

  [[nodiscard]] TransportMode getTransportMode() const noexcept;

  [[nodiscard]] const Method& getGetterMethod() const noexcept;

  [[nodiscard]] const Method& getSetterMethod() const noexcept;

  [[nodiscard]] const Event& getChangeEvent() const noexcept;

  [[nodiscard]] const std::vector<std::string>& getTags() const noexcept;

  [[nodiscard]] bool getCheckedSet() const noexcept;

  [[nodiscard]] static std::string makeGetterMethodName(const PropertySpec& spec);

  [[nodiscard]] static std::string makeSetterMethodName(const PropertySpec& spec);

  [[nodiscard]] static std::string makeChangeNotificationEventName(const PropertySpec& spec);

  [[nodiscard]] bool operator==(const Property& other) const noexcept;

  [[nodiscard]] bool operator!=(const Property& other) const noexcept;

  [[nodiscard]] MemberHash getHash() const noexcept;
 
private:
  PropertySpec spec_;
  MemberHash id_;
  MemberHash hash_;
  std::shared_ptr<const Method> setterMethod_;
  std::shared_ptr<const Method> getterMethod_;
  std::shared_ptr<const Event> changeEvent_;
};

 
//----------------------------------------------------------------------------------------------------------------------
// Inline implementation
//----------------------------------------------------------------------------------------------------------------------

template <>
struct impl::hash<PropertySpec>
{
  u32 operator()(const PropertySpec& spec) const noexcept
  {
    auto result = hashCombine(hashSeed, spec.name, spec.category, spec.transportMode, spec.type->getHash());
 
    for (const auto& tag: spec.tags)
    {
      result = hashCombine(result, tag);
    }
    return result;
  }
};
 
}  // namespace sen
 
#endif  // SEN_CORE_META_PROPERTY_H