Function_Block_Ballast_Control.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Ballast_Control.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      18.05.2016
//! @brief     Ballast control block class header file.
//! @attention
//!
//! COPYRIGHT(C) 2016, 2017 ANVILEX GmbH
//!
//! Redistribution and use in source and binary forms, with or without
//! modification, are permitted provided that the following conditions are met:
//!
//! 1. Redistributions of source code must retain the above copyright notice,
//!    this list of conditions and the following disclaimer.
//!
//! 2. 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.
//!
//! 3. Neither the name of ANVILEX nor the names of its contributors may be
//!    used to endorse or promote products derived from this software without 
//!    specific prior written permission.
//!
//! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
//! LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
//! CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Class declaration description
//------------------------------------------------------------------------------
 
class TFunction_Block_Ballast_Control : public TFunction_Block_Base
{
  
  //----------------------------------------------------------------------------
  // Public metods and variables
  //----------------------------------------------------------------------------
  
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Ballast_Control(); 
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Ballast_Control();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about Function block over communication link protocol
    //! @note      This method sends information about Function block over specified communication link protocol.
    //! @param     [in] TProtocol_Base *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
  
    //--------------------------------------------------------------------------
    // Function block parameter connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_Sample_Time; //!< Sample time given in seconds parameter  
    TBlock_Input_Connector object_f32_On_Level; //!< Ballast activation level in volt
    TBlock_Input_Connector object_f32_Off_Level; //!< Ballast deactivation level in volt
    TBlock_Input_Connector object_f32_R_Ballast; //!< Ballast active resistance in ohm
    TBlock_Input_Connector object_f32_Energy_Warning_Limit; //!< Energy warning level for ballast unit, value given in Ws
    TBlock_Input_Connector object_f32_Energy_Alarm_Limit; //!< Energy alarm level for ballast unit, value given in Ws
    TBlock_Input_Connector object_f32_Energy_Trip_Limit; //!< Energy trip level for ballast unit, value given in Ws
    TBlock_Input_Connector object_f32_Cooling_Time_Constant; //!< Ballast unit cooling time constant, value given in seconds
    TBlock_Input_Connector object_f32_Test_Mode_On_Delay; //!< Test mode on delay, value given in seconds
    TBlock_Input_Connector object_f32_Test_Mode_Off_Delay; //!< Test mode off delay, value given in seconds
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
    TBlock_Input_Connector object_f32_DC_Bus_Voltage; //!< d.c. bus voltage input, value givven in volts
    TBlock_Input_Connector object_bool_Test_Mode_Enable; //!< Test mode enable input, value given in volts
    TBlock_Input_Connector object_bool_Self_Test_Enable; //!< Enable self test : Not implementet
    TBlock_Input_Connector object_bool_Force_Operation; //!< Force ballast operation
    
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    TBlock_Output_Connector object_bool_Control; //!< Ballast control output
    TBlock_Output_Connector object_bool_Overload_Warning; //!< Ballast unit overload warning
    TBlock_Output_Connector object_bool_Overload_Alarm; //!< Ballast unit overload alarm
    TBlock_Output_Connector object_bool_Overload_Trip; //!< Ballast unit overload trip
    TBlock_Output_Connector object_f32_Energy; //!< Stored energy in ballast unit
 
  //----------------------------------------------------------------------------
  // Protected methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    // FSM state definition
    typedef enum
    {
 
      enum_Deactivated,
      enum_Activated,
      enum_Test_Mode_Activated,
      enum_Test_Mode_Deactivated,
      enum_Forced_Operation,
 
    } TGlobal_FSM_State;
    
    TGlobal_FSM_State enum_FSM_State; //!< FSM state
    
    // Internal variables
    F32 f32_1_Div_R;
    BOOL bool_State; //!< Ballast state
    F32 f32_Ki_Cooling; //!< Ballast cooling constant
    F32 f32_Energy_Integral_Limit; //!< Energy integral limit
    F32 f32_Energy_Integral; //!< Stored energy integral
    U32 u32_Active_Cycle_Counter; //!< Ballast active control cycle counter
    U32 u32_Test_Mode_On_Delay; //!< Test mode on time delay    
    U32 u32_Test_Mode_Off_Delay; //!< Test mode off time delay
    U32 u32_Timeout_Counter; //!< Timeout counter
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------