PortOutputJoin.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_PORTOUTPUTJOIN_H
#define IMT_BASE_DFF_ACTIVEPARTS_PORTOUTPUTJOIN_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/ChannelIfc.h>
#include <Imt.Base.Dff.ActiveParts/PortOutput.h>
 
namespace imt {
namespace base {
namespace dff {
namespace activeparts {
 
template<uint32_t NumberOfPortsToJoin>
class PortOutputJoin final : public PortOutput {
 
public:
 
    PortOutputJoin() = default;
 
    void setChannel(ChannelIfc& channel) final {
        // Forward to base class
        PortOutput::setChannel(channel);
 
        // Set the channel of the joined PortOutput
        for (uint_fast32_t i {0U}; i < m_numberOfRegisteredPorts; i++) {
            if (m_portOut[i] == nullptr) {
                ASSERT_DEBUG1(false, "Invalid port (PortOutputJoin::setChannel)");
                // return before the end of function, since this is parameter check
                return;
            }
            m_portOut[i]->setChannel(channel);
        }
    }
 
    bool join(PortOutput& portOut) {
        if (m_numberOfRegisteredPorts >= NumberOfPortsToJoin) {
            ASSERT_DEBUG1(false, "number of receivers exceeds template parameter (PortOutputJoin::join)");
            // return before the end of function, since this is parameter check
            return false;
        }
 
        // register the port
        m_portOut[m_numberOfRegisteredPorts] = &portOut;
        m_numberOfRegisteredPorts++;
 
        // set the channel if possible
        ChannelIfc* const pChannel {getChannel()};
        if (pChannel != nullptr) {
            portOut.setChannel(*pChannel);
        }
        return true;
    }
 
#ifdef _UNITTEST
    PortOutput* getPortOutput(uint32_t index) {
        PortOutput* pPort = nullptr;
        if (index < NumberOfPortsToJoin) {
            pPort = m_portOut[index];
        }
        return pPort;
    }
#endif //_UNITTEST
 
private:
 
    uint32_t m_numberOfRegisteredPorts {0U};
    std::array<PortOutput*, NumberOfPortsToJoin> m_portOut {nullptr};
};
 
} // namespace activeparts
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_ACTIVEPARTS_PORTOUTPUTJOIN_H