src/modules/rt_events/rtesingle.h

/*******************************************************************************
 * Copyright (c) 2006 - 2015 ACIN, Profactor GmbH, fortiss GmbH
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Alois Zoitl, Gerhard Ebenhofer, Ingo Hegny
 *    - initial API and implementation and/or initial documentation
 *******************************************************************************/

#pragma once

#include <funcbloc.h>
#include <ecet.h>


/*!\brief Base class for all single output real-time event function blocks.
 *
 */
class CRTEventSingle: public CFunctionBlock{
private:
  CEventChainExecutionThread mECEO;
  CSyncObject mSyncObj;              //!<Lock for protected the RT_E_FB from mutual events
  bool mInitialized;

  /*! \brief check if the succeeding EC part needs to be activated.
  *
  * This function makes the assumption that the input event with
  * the id 0 is the INIT event input.
  * \param paEIID the event id of the event that triggered the FB
  * \return if true the succeeding EC part will be activated.
  */
  virtual bool checkActivation(TEventID paEIID) = 0;

  void executeEvent(TEventID paEIID, CEventChainExecutionThread *const paECET) override {
    if(paEIID) { //it is not the init event
      if(mInitialized && checkActivation(paEIID)) {
        CEventConnection *eoCon = getEOConUnchecked(1);
        if(eoCon->isConnected()) {
          eoCon->triggerEvent(&mECEO);
          mECEO.resumeSelfSuspend();
        }
      }
    } else { // we got init
      if(var_QI == true) {
        if(!mInitialized) {
          mECEO.changeExecutionState(EMGMCommandType::Start);
          mInitialized = true;
        }
        mECEO.setDeadline(var_Deadline);
      } else {
        mECEO.changeExecutionState(EMGMCommandType::Stop);
        mInitialized = false;
      }
      var_QO = var_QI;
      sendOutputEvent(0, paECET);
    }
  }

public:
  CRTEventSingle(forte::core::CFBContainer &paContainer, const SFBInterfaceSpec *paInterfaceSpec,
                 const CStringDictionary::TStringId paInstanceNameId) :
          CFunctionBlock(paContainer, paInterfaceSpec, paInstanceNameId) {
  };

  CIEC_BOOL var_QI;
  CIEC_TIME var_Deadline;
  CIEC_BOOL var_QO;
};