PortInputSplit.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_DFF_ACTIVEPARTS_PORTINPUTSPLIT_H
#define IMT_BASE_DFF_ACTIVEPARTS_PORTINPUTSPLIT_H
 
#include <array>
#include <Imt.Base.Core.Diagnostics/Diagnostics.h>
#include <Imt.Base.Core.Platform/Nonmovable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Dff.ActiveParts/ReceiverIfc.h>
#include <Imt.Base.Dff.Runtime/ExecutableIfc.h>
#include <Imt.Base.Dff.Runtime/RuntimeCore.h>
 
namespace imt {
namespace base {
namespace dff {
namespace activeparts {
 
template<uint32_t NumberOfPortsToSplit>
class PortInputSplit final : public ReceiverIfc,
                             private ::imt::base::core::platform::Nonmovable {
 
public:
 
    PortInputSplit() = default;
 
    void receive(uint16_t const protocolIdentifier, ::imt::base::core::serialization::SerializableIfc const* const pEventData, size_t const eventDataSizeBytes) const final {
        for (uint_fast32_t i {0U}; i < m_numberOfRegisteredReceivers; i++) {
            m_receiverDetails[i].m_pPortIn->receive(protocolIdentifier, pEventData, eventDataSizeBytes);
        }
    }
 
    ::imt::base::dff::runtime::RuntimeCore::CoreHandle getReceiveHandle() const final {
        if (m_numberOfRegisteredReceivers <= 0U) {
            return ::imt::base::dff::runtime::RuntimeCore::COREHANDLE_INVALID;
        }
        return m_receiverDetails[0U].m_pPortIn->getReceiveHandle();
    }
 
    ::imt::base::dff::runtime::RuntimePriority getReceivePriority() const final {
        if (m_numberOfRegisteredReceivers <= 0U) {
            return ::imt::base::dff::runtime::RuntimePriority::Prio_lowest;
        }
        return m_receiverDetails[0U].m_receiverPriority;
    }
 
    bool split(ReceiverIfc const& portIn) {
        if (m_numberOfRegisteredReceivers >= NumberOfPortsToSplit) {
            ASSERT_DEBUG1(false, "number of receivers exceeds template parameter (PortInputSplit::split)");
            // return before the end of function, since this is parameter check
            return false;
        }
 
        if (portIn.getReceiveHandle() == ::imt::base::dff::runtime::RuntimeCore::COREHANDLE_INVALID) {
            ASSERT_DEBUG1(false, "invalid handle passed (PortInputSplit::split)");
            // return before the end of function, since this is parameter check
            return false;
        }
 
        // keep array sorted with descending priority: scan the array from end and shift values back until the correct position is found
        uint32_t i {m_numberOfRegisteredReceivers};
        ::imt::base::dff::runtime::RuntimePriority const currentPriority {portIn.getReceivePriority()};
        while ((i >= 1U) && (currentPriority > m_receiverDetails[i - 1U].m_receiverPriority)) {
            // note: low number is low priority, high number is high priority
            m_receiverDetails[i] = m_receiverDetails[i - 1U];
            i--;
        }
 
        // remember receiver handle (in worst case we now have an invalid receiver handle)
        m_receiverDetails[i].m_pPortIn = &portIn;
        m_receiverDetails[i].m_receiverPriority = currentPriority;
        m_numberOfRegisteredReceivers++;
 
        return true;
    }
 
#ifdef _UNITTEST
    ReceiverIfc const* getPortInput(uint32_t index) {
        if (index < NumberOfPortsToSplit) {
            return m_receiverDetails[index].m_pPortIn;
        }
        return nullptr;
    }
#endif //_UNITTEST
 
private:
 
    // internal structure for a receivers
    struct ReceiverDetails { // AXIVION Construct AutosarC++19_03-A9.6.1: type is not used for interfacing with hardware
        ReceiverIfc const* m_pPortIn {nullptr};
        ::imt::base::dff::runtime::RuntimePriority m_receiverPriority {::imt::base::dff::runtime::RuntimePriority::Prio_lowest};
    }; // AXIVION Construct AutosarC++19_03-A2.7.3 / AutosarC++19_03-M11.0.1: no Doxygen required for internals / all members public is ok
 
    uint32_t m_numberOfRegisteredReceivers {0U};
    std::array<ReceiverDetails, NumberOfPortsToSplit> m_receiverDetails {};
};
 
} // namespace activeparts
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_ACTIVEPARTS_PORTINPUTSPLIT_H