lola: Remove EventDataControlCompositeImpl

These Impl classes were previously added to avoid having to change
calling code to explicitly use the default template argument (i.e.
EventDataControl<>). Using the explicit template argument makes the code
more explicit and also removes the additional code complexity of having
the alias and Impl class.

Author: bemerybmw

score/mw/com/design/events_fields/event_lola_model.puml

@@ -39,7 +39,7 @@ abstract class SkeletonBinding {
 ' Concrete classes
 class lola::SkeletonEvent<SampleType> {
   -event_data_storage: EventDataStorage<SampleType>*
-  -event_data_control: score::cpp::optional<EventDataControlComposite>
+  -event_data_control: score::cpp::optional<EventDataControlComposite<>>
   +SkeletonEvent(parent: Skeleton&, event_fqn: const ElementFqId, max_number_of_slots: const std::size_t, enforce_max_samples: const bool)
   +Send(SampleType const&): void
   +Send(SampleAllocateePtr<SampleType>): void
@@ -71,7 +71,7 @@ class lola::Skeleton {
   +Skeleton(const InstanceIdentifier&, SkeletonEvents&)
   +PrepareOffer(): ResultBlank
   +PrepareStopOffer(): ResultBlank
-  +Register(ElementFqId, size_t numberOfSlots): std::pair<EventDataStorage*, EventDataControlComposite>
+  +Register(ElementFqId, size_t numberOfSlots): std::pair<EventDataStorage*, EventDataControlComposite<>>
   +GetInstanceQualityType() const: QualityType
 }
 
@@ -136,7 +136,7 @@ class lola::SampleAllocateePtr<SampleType> {
   -event_data_control_: EventDataControlComposite
   +SampleAllocateePtr()
   +SampleAllocateePtr(std::nullptr_t)
-  +SampleAllocateePtr(ptr: pointer, const EventDataControlComposite&, const EventDataControl::SlotIndexType)
+  +SampleAllocateePtr(ptr: pointer, const EventDataControlComposite<>&, const EventDataControl::SlotIndexType)
   +GetReferencedSlot() const: EventDataControl::SlotIndexType
   +get() const: SampleType*
   +reset(std::nullptr_t): void
@@ -159,7 +159,7 @@ class lola::SamplePtr<SampleType> {
   -event_data_control_: EventDataControl*
   +SamplePtr()
   +SamplePtr(std::nullptr_t)
-  +SamplePtr(pointer ptr, const EventDataControlComposite&, const EventDataControl::SlotIndexType)
+  +SamplePtr(pointer ptr, const EventDataControlComposite<>&, const EventDataControl::SlotIndexType)
   +get() const: pointer
   +swap(): void
 }
@@ -213,11 +213,11 @@ class "<<SharedMemory>>\nlola::EventSlotStatus" {
   +IsTimeStampBetween(EventTimeStamp min, EventTimeStamp max): bool
 }
 
-class EventDataControlCompositeImpl<memory::shared::AtomicIndirectorType> {
+class EventDataControlComposite<memory::shared::AtomicIndirectorType> {
   -asil_qm_control_: EventDataControl*
   -asil_b_control_: EventDataControl*
-  +EventDataControlCompositeImpl(asil_qm_control: EventDataControl* const)
-  +EventDataControlCompositeImpl(asil_qm_control: EventDataControl* const, asil_b_control: EventDataControl* const)
+  +EventDataControlComposite(asil_qm_control: EventDataControl* const)
+  +EventDataControlComposite(asil_qm_control: EventDataControl* const, asil_b_control: EventDataControl* const)
   +AllocateNextSlot(): std::optional<EventDataControl::SlotIndexType>
   +EventReady(EventDataControl::SlotIndexType, EventSlotStatus::EventTimeStamp): void
   +Discard(EventDataControl::SlotIndexType): void
@@ -238,18 +238,18 @@ lola::Skeleton *-- SkeletonDataStorage : "1..1"
 lola::Skeleton *-- "<<SharedMemory>>\nlola::SkeletonDataControl" : "1..2"
 "<<SharedMemory>>\nlola::SkeletonDataControl" *-- "<<SharedMemory>>\nlola::EventDataControlImpl" : "0..n"
 lola::SkeletonEvent o-- "EventDataStorage"
-lola::SkeletonEvent *-- EventDataControlCompositeImpl
+lola::SkeletonEvent *-- EventDataControlComposite
 "<<SharedMemory>>\nlola::EventDataControlImpl" ..> "<<SharedMemory>>\nlola::EventSlotStatus"
 SampleAllocateePtr o-- lola::SampleAllocateePtr
 SamplePtr o-- lola::SamplePtr
 lola::ProxyEvent *-- lola::ProxyEventCommon
 lola::ProxyEventCommon *-- lola::SubscriptionStateMachine
 lola::ProxyEventCommon --* lola::SlotCollector
 ProxyEventBindingBase o-- SubscriptionState
-lola::SampleAllocateePtr *-- EventDataControlCompositeImpl
-EventDataControlCompositeImpl o-- "<<SharedMemory>>\nlola::EventDataControlImpl" : "2"
+lola::SampleAllocateePtr *-- EventDataControlComposite
+EventDataControlComposite o-- "<<SharedMemory>>\nlola::EventDataControlImpl" : "2"
 lola::Skeleton ..> lola::ShmPathBuilder : uses
-lola::Skeleton ..> EventDataControlCompositeImpl
+lola::Skeleton ..> EventDataControlComposite
 lola::SubscriptionStateMachine ..> lola::SlotCollector : <<creates>>
 SkeletonEventBinding ..> SampleAllocateePtr
 lola::ProxyEvent ..> lola::SamplePtr

score/mw/com/design/skeleton_proxy/generic_proxy/README.md

@@ -87,7 +87,7 @@ The map containing the meta-information gets initialized by the skeleton instanc
 the vectors containing the sample slots in
 ```
 template <typename SampleType>
-std::pair<EventDataStorage<SampleType>*, EventDataControlComposite> lola::Skeleton::Register(ElementFqId event_fqn,
+std::pair<EventDataStorage<SampleType>*, EventDataControlComposite<>> lola::Skeleton::Register(ElementFqId event_fqn,
    std::size_t number_of_slots)
 ```
 

score/mw/com/design/skeleton_proxy/skeleton_binding_model.puml

@@ -150,7 +150,7 @@ class "lola::Skeleton" as lola_Skeleton {
     +PrepareStopOffer(): void
 
     template <typename SampleType>
-    +Register(ElementFqId, size_t num_slots): std::pair<EventDataStorage<SampleType>*,EventDataControlComposite>
+    +Register(ElementFqId, size_t num_slots): std::pair<EventDataStorage<SampleType>*,EventDataControlComposite<>>
 }
 
 class "lola::SkeletonEvent<SampleType>" as lola_SkeletonEvent {

score/mw/com/design/skeleton_proxy/skeleton_proxy_binding_model.puml

@@ -35,7 +35,7 @@ class "lola::Skeleton" as LolaSkeleton {
   +PrepareOffer(SkeletonBinding::SkeletonEventBindings&, SkeletonBinding::SkeletonFieldBindings&): ResultBlank
   +PrepareStopOffer(): void
 
-  +template <typename SampleType>\n Register(ElementFqId, size_t num_slots): std::pair<EventDataStorage<SampleType>*, EventDataControlComposite>
+  +template <typename SampleType>\n Register(ElementFqId, size_t num_slots): std::pair<EventDataStorage<SampleType>*, EventDataControlComposite<>>
 }
 
 class "SkeletonBindingFactory" {

score/mw/com/impl/bindings/lola/event_data_control.h

@@ -46,15 +46,12 @@ class EventDataControlAttorney;
 // coverity[autosar_cpp14_m3_2_3_violation]
 class EventDataControlCompositeAttorney;
 
-namespace detail_event_data_control_composite
-{
 // Suppress The rule AUTOSAR C++14 M3-2-3: "A type, object or function that is used in multiple translation units shall
 // be declared in one and only one file."
 // This is a forward declaration that does not vioalate this rule.
 // coverity[autosar_cpp14_m3_2_3_violation]
 template <template <class> class T>
-class EventDataControlCompositeImpl;
-}  // namespace detail_event_data_control_composite
+class EventDataControlComposite;
 
 namespace detail_event_data_control
 {
@@ -82,6 +79,14 @@ class EventDataControlImpl final
     // coverity[autosar_cpp14_a11_3_1_violation]
     friend class lola::EventDataControlCompositeAttorney;
 
+    template <template <typename> class T>
+    // Suppress "AUTOSAR C++14 A11-3-1", The rule declares: "Friend declarations shall not be used".
+    // In order that users do not depend on implementation details, we only expose on user facing classes the bare
+    // necessary. Thus, we have friend classes that expose internals for our implementation. Design decision for better
+    // encapsulation.
+    // coverity[autosar_cpp14_a11_3_1_violation]
+    friend class lola::EventDataControlComposite;
+
   public:
     using EventControlSlots =
         score::containers::DynamicArray<ControlSlotType,
@@ -232,14 +237,6 @@ class EventDataControlImpl final
     static inline std::atomic_uint_fast64_t num_ref_misses{0U};
     static inline std::atomic_uint_fast64_t num_alloc_retries{0U};
     static inline std::atomic_uint_fast64_t num_ref_retries{0U};
-
-    template <template <typename> class T>
-    // Suppress "AUTOSAR C++14 A11-3-1", The rule declares: "Friend declarations shall not be used".
-    // In order that users do not depend on implementation details, we only expose on user facing classes the bare
-    // necessary. Thus, we have friend classes that expose internals for our implementation. Design decision for better
-    // encapsulation.
-    // coverity[autosar_cpp14_a11_3_1_violation]
-    friend class detail_event_data_control_composite::EventDataControlCompositeImpl;
 };
 
 }  // namespace detail_event_data_control

score/mw/com/impl/bindings/lola/event_data_control_composite.cpp

@@ -11,28 +11,29 @@
  * SPDX-License-Identifier: Apache-2.0
  ********************************************************************************/
 #include "score/mw/com/impl/bindings/lola/event_data_control_composite.h"
+
 #include <utility>
 
-namespace score::mw::com::impl::lola::detail_event_data_control_composite
+namespace score::mw::com::impl::lola
 {
 
 namespace
 {
+
 constexpr std::size_t MAX_MULTI_ALLOCATE_RETRY_COUNT{100U};
+
 }
 
 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init): all members are initialized in the delegated constructor
 template <template <class> class AtomicIndirectorType>
-EventDataControlCompositeImpl<AtomicIndirectorType>::EventDataControlCompositeImpl(
-    EventDataControl* const asil_qm_control)
-    : EventDataControlCompositeImpl{asil_qm_control, nullptr}
+EventDataControlComposite<AtomicIndirectorType>::EventDataControlComposite(EventDataControl* const asil_qm_control)
+    : EventDataControlComposite{asil_qm_control, nullptr}
 {
 }
 
 template <template <class> class AtomicIndirectorType>
-EventDataControlCompositeImpl<AtomicIndirectorType>::EventDataControlCompositeImpl(
-    EventDataControl* const asil_qm_control,
-    EventDataControl* const asil_b_control)
+EventDataControlComposite<AtomicIndirectorType>::EventDataControlComposite(EventDataControl* const asil_qm_control,
+                                                                           EventDataControl* const asil_b_control)
     : asil_qm_control_{asil_qm_control}, asil_b_control_{asil_b_control}, ignore_qm_control_{false}
 {
     CheckForValidDataControls();
@@ -45,7 +46,7 @@ template <template <class> class AtomicIndirectorType>
 // throwing std::bad_optional_access which leds to std::terminate(). This suppression should be removed after fixing
 // [Ticket-173043](broken_link_j/Ticket-173043)
 // coverity[autosar_cpp14_a15_5_3_violation : FALSE]
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::GetNextFreeMultiSlot() const noexcept
+auto EventDataControlComposite<AtomicIndirectorType>::GetNextFreeMultiSlot() const noexcept
     -> ControlSlotCompositeIndicator
 {
     EventSlotStatus::EventTimeStamp oldest_time_stamp{EventSlotStatus::TIMESTAMP_MAX};
@@ -120,8 +121,8 @@ template <template <class> class AtomicIndirectorType>
 // in case the index goes outside the range. As we already do an index check before accessing, so no way for
 // segmentation fault which leds to calling std::terminate().
 // coverity[autosar_cpp14_a15_5_3_violation : FALSE]
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::TryLockSlot(
-    ControlSlotCompositeIndicator slot_indicator) noexcept -> bool
+auto EventDataControlComposite<AtomicIndirectorType>::TryLockSlot(ControlSlotCompositeIndicator slot_indicator) noexcept
+    -> bool
 {
     auto& slot_value_qm = slot_indicator.GetSlotQM();
     auto& slot_value_asil_b = slot_indicator.GetSlotAsilB();
@@ -163,8 +164,7 @@ template <template <class> class AtomicIndirectorType>
 // have a value but as we check before with 'has_value()' so no way for throwing std::bad_optional_access which leds
 // to std::terminate().
 // coverity[autosar_cpp14_a15_5_3_violation : FALSE]
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::AllocateNextMultiSlot() noexcept
-    -> ControlSlotCompositeIndicator
+auto EventDataControlComposite<AtomicIndirectorType>::AllocateNextMultiSlot() noexcept -> ControlSlotCompositeIndicator
 {
     // \todo we should also monitor retry counts in the multi-slot/EventDataControlComposite case, like we are doing in
     //  EventDataControl! Currently we are "blind", if we have retries, because ASIL-QM/ASIL-B consumers do influence
@@ -185,7 +185,7 @@ auto EventDataControlCompositeImpl<AtomicIndirectorType>::AllocateNextMultiSlot(
 }
 
 template <template <class> class AtomicIndirectorType>
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::AllocateNextSlot() noexcept -> ControlSlotCompositeIndicator
+auto EventDataControlComposite<AtomicIndirectorType>::AllocateNextSlot() noexcept -> ControlSlotCompositeIndicator
 {
     if (asil_b_control_ == nullptr)
     {
@@ -233,9 +233,9 @@ auto EventDataControlCompositeImpl<AtomicIndirectorType>::AllocateNextSlot() noe
 }
 
 template <template <class> class AtomicIndirectorType>
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::EventReady(
-    ControlSlotCompositeIndicator slot_indicator,
-    EventSlotStatus::EventTimeStamp time_stamp) noexcept -> void
+auto EventDataControlComposite<AtomicIndirectorType>::EventReady(ControlSlotCompositeIndicator slot_indicator,
+                                                                 EventSlotStatus::EventTimeStamp time_stamp) noexcept
+    -> void
 {
     if (asil_b_control_ != nullptr)
     {
@@ -249,7 +249,7 @@ auto EventDataControlCompositeImpl<AtomicIndirectorType>::EventReady(
 }
 
 template <template <class> class AtomicIndirectorType>
-auto EventDataControlCompositeImpl<AtomicIndirectorType>::Discard(ControlSlotCompositeIndicator slot_indicator) -> void
+auto EventDataControlComposite<AtomicIndirectorType>::Discard(ControlSlotCompositeIndicator slot_indicator) -> void
 {
     if (asil_b_control_ != nullptr)
     {
@@ -263,20 +263,19 @@ auto EventDataControlCompositeImpl<AtomicIndirectorType>::Discard(ControlSlotCom
 }
 
 template <template <class> class AtomicIndirectorType>
-bool EventDataControlCompositeImpl<AtomicIndirectorType>::IsQmControlDisconnected() const noexcept
+bool EventDataControlComposite<AtomicIndirectorType>::IsQmControlDisconnected() const noexcept
 {
     return ignore_qm_control_;
 }
 
 template <template <class> class AtomicIndirectorType>
-EventDataControl& EventDataControlCompositeImpl<AtomicIndirectorType>::GetQmEventDataControl() const noexcept
+EventDataControl& EventDataControlComposite<AtomicIndirectorType>::GetQmEventDataControl() const noexcept
 {
     return *asil_qm_control_;
 }
 
 template <template <class> class AtomicIndirectorType>
-std::optional<EventDataControl*>
-EventDataControlCompositeImpl<AtomicIndirectorType>::GetAsilBEventDataControl() noexcept
+std::optional<EventDataControl*> EventDataControlComposite<AtomicIndirectorType>::GetAsilBEventDataControl() noexcept
 {
     if (asil_b_control_ != nullptr)
     {
@@ -286,7 +285,7 @@ EventDataControlCompositeImpl<AtomicIndirectorType>::GetAsilBEventDataControl()
 }
 
 template <template <class> class AtomicIndirectorType>
-EventSlotStatus::EventTimeStamp EventDataControlCompositeImpl<AtomicIndirectorType>::GetEventSlotTimestamp(
+EventSlotStatus::EventTimeStamp EventDataControlComposite<AtomicIndirectorType>::GetEventSlotTimestamp(
     const SlotIndexType slot) const noexcept
 {
     if (asil_b_control_ != nullptr)
@@ -304,7 +303,7 @@ EventSlotStatus::EventTimeStamp EventDataControlCompositeImpl<AtomicIndirectorTy
 }
 
 template <template <class> class AtomicIndirectorType>
-void EventDataControlCompositeImpl<AtomicIndirectorType>::CheckForValidDataControls() const noexcept
+void EventDataControlComposite<AtomicIndirectorType>::CheckForValidDataControls() const noexcept
 {
     if (asil_qm_control_ == nullptr)
     {
@@ -318,7 +317,7 @@ template <template <class> class AtomicIndirectorType>
 // in case the index goes outside the range. As we already do an index check before accessing, so no way for
 // segmentation fault which leds to calling std::terminate().
 // coverity[autosar_cpp14_a15_5_3_violation : FALSE]
-EventSlotStatus::EventTimeStamp EventDataControlCompositeImpl<AtomicIndirectorType>::GetLatestTimestamp() const noexcept
+EventSlotStatus::EventTimeStamp EventDataControlComposite<AtomicIndirectorType>::GetLatestTimestamp() const noexcept
 {
     EventSlotStatus::EventTimeStamp latest_time_stamp{1U};
     EventDataControl* control = (asil_b_control_ != nullptr) ? asil_b_control_ : asil_qm_control_;
@@ -343,7 +342,7 @@ EventSlotStatus::EventTimeStamp EventDataControlCompositeImpl<AtomicIndirectorTy
     return latest_time_stamp;
 }
 
-template class EventDataControlCompositeImpl<memory::shared::AtomicIndirectorReal>;
-template class EventDataControlCompositeImpl<memory::shared::AtomicIndirectorMock>;
+template class EventDataControlComposite<memory::shared::AtomicIndirectorReal>;
+template class EventDataControlComposite<memory::shared::AtomicIndirectorMock>;
 
-}  // namespace score::mw::com::impl::lola::detail_event_data_control_composite
+}  // namespace score::mw::com::impl::lola

score/mw/com/impl/bindings/lola/event_data_control_composite.h

@@ -10,8 +10,8 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  ********************************************************************************/
-#ifndef DDAD_SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_
-#define DDAD_SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_
+#ifndef SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_
+#define SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_
 
 #include "score/mw/com/impl/bindings/lola/control_slot_composite_indicator.h"
 #include "score/mw/com/impl/bindings/lola/control_slot_types.h"
@@ -29,9 +29,6 @@ namespace score::mw::com::impl::lola
 
 class EventDataControlCompositeAttorney;
 
-namespace detail_event_data_control_composite
-{
-
 /// \brief Encapsulates multiple EventDataControl instances
 ///
 /// \details Due to the fact that we have multiple EventDataControl instances (one for ASIL, one for QM) we need to
@@ -40,21 +37,20 @@ namespace detail_event_data_control_composite
 /// control structures. Please be aware that the control structures will live in different shared memory segments, thus
 /// it is not possible to store them by value, but rather as pointer.
 template <template <class> class AtomicIndirectorType = memory::shared::AtomicIndirectorReal>
-class EventDataControlCompositeImpl
+class EventDataControlComposite
 {
     // Suppress "AUTOSAR C++14 A11-3-1", The rule declares: "Friend declarations shall not be used".
     // The "EventDataControlCompositeAttorney" class is a helper, which sets the internal state of
-    // "EventDataControlCompositeImpl" accessing private members and used for testing purposes only.
+    // "EventDataControlComposite" accessing private members and used for testing purposes only.
     // coverity[autosar_cpp14_a11_3_1_violation]
     friend class lola::EventDataControlCompositeAttorney;
 
   public:
     /// \brief Constructs a composite which will only manage a single QM control (no ASIL use-case)
-    explicit EventDataControlCompositeImpl(EventDataControl* const asil_qm_control);
+    explicit EventDataControlComposite(EventDataControl* const asil_qm_control);
 
     /// \brief Constructs a composite which will manage QM and ASIL control at the same time
-    explicit EventDataControlCompositeImpl(EventDataControl* const asil_qm_control,
-                                           EventDataControl* const asil_b_control);
+    explicit EventDataControlComposite(EventDataControl* const asil_qm_control, EventDataControl* const asil_b_control);
 
     /// \brief Checks for the oldest unused slot and acquires for writing (thread-safe, wait-free)
     ///
@@ -116,9 +112,6 @@ class EventDataControlCompositeImpl
     void CheckForValidDataControls() const noexcept;
 };
 
-}  // namespace detail_event_data_control_composite
-
-using EventDataControlComposite = detail_event_data_control_composite::EventDataControlCompositeImpl<>;
-
 }  // namespace score::mw::com::impl::lola
-#endif  // DDAD_SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_
+
+#endif  // SCORE_MW_COM_IMPL_BINDINGS_LOLA_EVENT_DATA_CONTROL_COMPOSITE_H_