/**
 * @file JAModeControlGAM.h
 * @brief Header file for class JAModeControlGAM
 * @date Jan, 2019
 * @author kuchida
 *
 * @copyright Copyright 2015 F4E | European Joint Undertaking for ITER and
 * the Development of Fusion Energy ('Fusion for Energy').
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved
 * by the European Commission - subsequent versions of the EUPL (the "Licence")
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl
 *
 * @warning Unless required by applicable law or agreed to in writing,
 * software distributed under the Licence is distributed on an "AS IS"
 * basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence permissions and limitations under the Licence.

 * @details This header file contains the declaration of the class JAModeControlGAM
 * with all of its public, protected and private members. It may also include
 * definitions for inline methods which need to be visible to the compiler.
 */

#ifndef GAMS_JAMODECONTROLGAM_H_
#define GAMS_JAMODECONTROLGAM_H_

/*---------------------------------------------------------------------------*/
/*                        Standard header includes                           */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/*                        Project header includes                            */
/*---------------------------------------------------------------------------*/

#include "GAM.h"

/*---------------------------------------------------------------------------*/
/*                           Class declaration                               */
/*---------------------------------------------------------------------------*/

/**
 * @brief GAM that check the pulse lenght limit.
 *
 * The configuration syntax is (names and signal quantity are only given as an example):
 * <pre>
 *         +ModeLimitGAM = {
 *           Class = JAModeControlGAM
 *           InputSignals = {
 *               PLC_MODE1 = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               MD1_SHOTLEN_LIM = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               PLC_MODE2 = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               MD2_SHOTLEN_LIM = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               PLC_MODE3 = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               MD3_SHOTLEN_LIM = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               PLC_MODE4 = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               MD4_SHOTLEN_LIM = {
 *                   DataSource = EPICSCAInput
 *                   Type = uint32
 *               }
 *               RFON = {
 *                   DataSource = RealTimeThreadAsyncBridge
 *                   Type = uint32
 *               }
 *               Time = {
 *                   DataSource = DDB1
 *                   Type = uint32
 *               }
 *               HVInjection = {
 *               	DataSource = RealTimeThreadAsyncBridge
 *               	Type = uint32
 *               }
 *           }
 *           OutputSignals = {
 *               MODE_SHOTLEN_FLAG = {
 *                   DataSource = DDB1
 *                   Type = uint32
 *               }
 *           }
 *       }
 * </pre>
 * If MODE1 is ON and Time is exceed MD1_SHOTLEN_LIM, MODE_SHOTLEN_FLAG become ON.
 */

class JAModeControlGAM : public MARTe::GAM, public MARTe::StatefulI  {
public:
    CLASS_REGISTER_DECLARATION()

    JAModeControlGAM();

    virtual ~JAModeControlGAM();

    virtual bool Initialise(MARTe::StructuredDataI & data);

    virtual bool Setup();

    virtual bool Execute();

    virtual bool PrepareNextState(const MARTe::char8 * const currentStateName,
                                  const MARTe::char8 * const nextStateName);

private:

     MARTe::uint32 CalcPulseLengthLimit(MARTe::uint32 **inputSignals);

    // Input signals
    MARTe::uint32 **inputSignals;

    // Output signals
    MARTe::uint32 *outputSignal;

    // Calculated pulse lenght limit.
    MARTe::uint32 pulseLengthLimit;

    // Amount of time passed per execution cycle.
    MARTe::uint32 rfonTime;

    // reset flag
    bool resetRemainingTime;
    MARTe::uint32 previousState;
};



/*---------------------------------------------------------------------------*/
/*                        Inline method definitions                          */
/*---------------------------------------------------------------------------*/

#endif /* GAMS_JAMODECONTROLGAM_H_ */
