RuntimeTimer.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_RUNTIMETIMER_H
#define IMT_BASE_DFF_RUNTIMETIMER_H
 
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Core.Platform/StaticClass.h>
#include <Imt.Base.Dff.Runtime/RuntimeCore.h>
 
namespace imt {
namespace base {
namespace dff {
namespace runtime {
 
class RuntimeTimer final : private ::imt::base::core::platform::StaticClass {
 
public:
 
    using TimerHandle = int16_t;
 
    static constexpr TimerHandle TIMERHANDLE_INVALID {0};
 
    static void initTimerModule(uint32_t initialTimeMs = 0);
 
    static TimerHandle startOneShotTimer(RuntimeCore::CoreHandle const apHandle, TimerHandle timerToStart, uint32_t const timerTicksMs);
 
    static TimerHandle startPeriodicTimer(RuntimeCore::CoreHandle const apHandle, TimerHandle timerToStart, uint32_t const intervalMs);
 
    static TimerHandle updatePeriodicTimer(TimerHandle timerToUpdate, uint32_t const intervalMs);
 
    static TimerHandle killTimer(TimerHandle timerToKill);
 
    static void process1msTick();
 
    static uint32_t getTickCountMs();
 
    static bool getIsRunningState(TimerHandle const timerToCheck);
 
    // AXIVION Construct AutosarC++19_03-A9.6.1: Implementation does not rely on trivial layout.
    struct TimeItem {
 
        TimerHandle identifier;
 
        RuntimeCore::CoreHandle receiverHandle;
 
        uint32_t ticksMs;
 
        uint32_t intervalMs;
 
        bool isRunning;
 
        // AXIVION Next Line AutosarC++19_03-M2.10.1: Allowed usage, compatibility purposes
        TimeItem* next;
 
        TimeItem* prev;
    };
 
private:
 
    static TimerHandle createOneShotTimer(RuntimeCore::CoreHandle const apHandle, uint32_t const ticksMs);
 
    static TimerHandle updateOneShotTimer(RuntimeCore::CoreHandle const apHandle, TimerHandle timerToUpdate, uint32_t const ticksMs);
 
    static TimerHandle createTimer(RuntimeCore::CoreHandle const apHandle, uint32_t const ticksMs, uint32_t const intervalMs);
 
    static TimeItem* findActiveTimer(TimerHandle const timerToSearch);
 
    static TimeItem* s_pActiveTimerListHead;
    // we need to have unique id's for both kind of timers (e.g. an executable uses one-shot and periodic timers)
    static int16_t s_periodicTimerUniqueId;
    static int16_t s_oneShotTimerUniqueId;
    static uint32_t s_tickCountMs;
};
 
} // namespace runtime
} // namespace dff
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_DFF_RUNTIMETIMER_H