ActivePartAbs.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_ACTIVEPARTABS_H
#define IMT_BASE_DFF_ACTIVEPARTS_ACTIVEPARTABS_H
 
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Dff.ActiveParts/PortInput.h>
#include <Imt.Base.Dff.ActiveParts/TimerServiceIfc.h>
#include <Imt.Base.Dff.Runtime/ExecutableIfc.h>
#include <Imt.Base.Dff.Runtime/RuntimeTimer.h>
 
#ifdef USE_BUFFERPOOL
#include <Imt.Base.Dff.Runtime/BufferAbs.h>
#include <Imt.Base.Dff.Runtime/RuntimeBuffer.h>
#endif // USE_BUFFERPOOL
 
namespace imt {
namespace base {
namespace dff {
namespace activeparts {
 
class ActivePartAbs : public ::imt::base::dff::runtime::ExecutableIfc,
                      public ::imt::base::dff::runtime::TimerServiceIfc,
                      private ::imt::base::core::platform::Nonmovable {
 
public:
 
    explicit ActivePartAbs(::imt::base::dff::runtime::RuntimePriority const priority, ::imt::base::dff::runtime::ExecutableConfiguration const configuration = ::imt::base::dff::runtime::ExecutableConfiguration());
 
    ::imt::base::dff::runtime::ExecutableConfiguration const& getExecutableConfiguration() const final;
 
    ::imt::base::dff::runtime::RuntimePriority getPriority() const final;
 
    void initialize();
 
    void start();
 
    bool isInitialized() const;
 
    bool isStarted() const;
 
    ::imt::base::dff::runtime::RuntimeTimer::TimerHandle startOneShotTimer(::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToStart, uint32_t const timerTicksMs) const final;
 
    ::imt::base::dff::runtime::RuntimeTimer::TimerHandle startPeriodicTimer(::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToStart, uint32_t const intervalMs) const final;
 
    ::imt::base::dff::runtime::RuntimeTimer::TimerHandle killTimer(::imt::base::dff::runtime::RuntimeTimer::TimerHandle timerToKill) const final;
 
#ifdef USE_BUFFERPOOL
    virtual void registerBuffer(::imt::base::dff::runtime::BufferAbs& buffer, uint16_t const eventSettings) const;
#endif // USE_BUFFERPOOL
 
protected:
 
    virtual void onInitialize() = 0;
 
    virtual void onStart() = 0;
 
private:
 
    PortInput m_input;
    ::imt::base::dff::runtime::RuntimePriority m_priority;
    ::imt::base::dff::runtime::ExecutableConfiguration const m_executableConfiguration;
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    bool m_isInitialized;
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    bool m_isStarted;
 
public:
 
    // AXIVION Next Codeline AutosarC++19_03-M11.0.1: Allowed usage, compatibility purposes / PortIn port must always be defined
    // AXIVION Next Codeline CodingStyle-Naming.ClassField: Naming exception for dff components
    // AXIVION Next Codeline AutosarC++19_03-M0.1.4: field will be reference in the projects
    PortInput const& PortIn;
};
 
} // namespace activeparts
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_ACTIVEPARTS_ACTIVEPARTABS_H