Function_Block_Cabinet_Cooling_System_Model.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        Function_Block_Cabinet_Cooling_System_Model.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        13.05.2021
//! @brief       Functional block Function_Block_Cabinet_Cooling_System_Model class header file.
//! @attention   No special attention requered.
//! @copyright   (C) 2015-2021 ANVILEX LLC
//!
//! 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 "Generic_Cooling_Model.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Function block class declaration
//------------------------------------------------------------------------------
 
class TFunction_Block_Cabinet_Cooling_System_Model : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public variables and methods
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Constructor and destructor methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Cabinet_Cooling_System_Model();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TFunction_Block_Cabinet_Cooling_System_Model();
 
    //--------------------------------------------------------------------------
    // Function block data processing methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //--------------------------------------------------------------------------
    // Function block parameters
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block inputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // FUSES AND CONTROLS
    //--------------------------------------------------------------------------
 
    //! @brief EMU ICS fuse status
    TBlock_Input_Connector object_bool_EMU_ICS_Fuse_Status;
    
    //! @brief First cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_1_Fan_Control;
    
    //! @brief Second cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_2_Fan_Control;
    
    //! @brief Third cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_3_Fan_Control;
    
    //! @brief Fourth cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_4_Fan_Control;
    
    //! @brief Fifth cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_5_Fan_Control;
    
    //! @brief Sixth cabinet fan control signal
    TBlock_Input_Connector object_bool_Cabinet_6_Fan_Control;
 
    //--------------------------------------------------------------------------
    // AMBIENT TEMPERATURE
    //--------------------------------------------------------------------------
 
    //! @brief Ambient temperature value
    TBlock_Input_Connector object_f32_Ambient_Temperature_Value;
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // CABINET TEMPERATURES
    //--------------------------------------------------------------------------
 
    //! @brief First cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_1_Temperature_Value;
    
    //! @brief Second cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_2_Temperature_Value;
    
    //! @brief Third cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_3_Temperature_Value;
    
    //! @brief Fourth cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_4_Temperature_Value;
    
    //! @brief Fifth cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_5_Temperature_Value;
    
    //! @brief Sixth cabinet temperature value
    TBlock_Output_Connector object_f32_Cabinet_6_Temperature_Value;
    
    //--------------------------------------------------------------------------
    // CABINET FAN STATUS
    //--------------------------------------------------------------------------
 
    //! @brief First cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_1_Fan_Status;
    
    //! @brief Second cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_2_Fan_Status;
                            
    //! @brief Third cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_3_Fan_Status;
    
    //! @brief Fourth cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_4_Fan_Status;
    
    //! @brief Fifth cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_5_Fan_Status;
    
    //! @brief Sixth cabinet fan status
    TBlock_Output_Connector object_bool_Cabinet_6_Fan_Status;
    
    
    
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
  //----------------------------------------------------------------------------
  // Private methods
  //----------------------------------------------------------------------------
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the first cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_1_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
 
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the second cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_2_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the third cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_3_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the fourth cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_4_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the fifth cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_5_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //!---------------------------------------------------------------------------
  //! @brief     Switches the state of the fan in the sixth cabinet depending on the control signal.
  //! @note      None
  //! @param     [in] Fan_Control_Status - The state of the fan control signal
  //!            [in] u32_Timestamp_On - Turn-on delay timer
  //!            [in] u32_Timestamp_Off - Turn-off delay timer
  //! @return    None
  //! \par       Override
  //!            Not allowed 
  //! @attention None
  //----------------------------------------------------------------------------
  
  void Cabinet_6_Fan_Status_Changer(BOOL Fan_Control_Status, U32 &u32_Timestamp_On, U32 &u32_Timestamp_Off);
  
  //----------------------------------------------------------------------------
  // Private variables
  //----------------------------------------------------------------------------
 
  //! @brief Variable that sets the rise time of the fan curve proportional factor
  F32 f32_Tau_k_fan;
  
  //----------------------------------------------------------------------------
  // Private objects
  //----------------------------------------------------------------------------
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_1_Cooling_model;
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_2_Cooling_model;
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_3_Cooling_model;
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_4_Cooling_model;
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_5_Cooling_model;
  
  //! @brief Class Generic_Cooling_Model object
  TGeneric_Cooling_Model object_Cabinet_6_Cooling_model;
  
  //----------------------------------------------------------------------------
  // First cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the first cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_1_Fan_On;
  
  //! @brief Variable for the first cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_1_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Second cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the second cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_2_Fan_On;
  
  //! @brief Variable for the second cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_2_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Third cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the third cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_3_Fan_On;
  
  //! @brief Variable for the third cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_3_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Fourth cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the fourth cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_4_Fan_On;
  
  //! @brief Variable for the fourth cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_4_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Fifth cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the fifth cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_5_Fan_On;
  
  //! @brief Variable for the fifth cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_5_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Sixth cabinet fan status delay timers
  //----------------------------------------------------------------------------
  
  //! @brief Variable for the sixth cabinet fan status delay on
  U32 u32_Timestamp_Cabinet_6_Fan_On;
  
  //! @brief Variable for the sixth cabinet fan status delay off
  U32 u32_Timestamp_Cabinet_6_Fan_Off;
  
  //----------------------------------------------------------------------------
  // Variables for storing cabinets fan statuses
  //----------------------------------------------------------------------------
  
  //! @brief Variable for storing first cabinet fan state
  BOOL bool_Cabinet_1_Fan_State; 
  
  //! @brief Variable for storing second cabinet fan state
  BOOL bool_Cabinet_2_Fan_State;
  
  //! @brief Variable for storing third cabinet fan state
  BOOL bool_Cabinet_3_Fan_State;
  
  //! @brief Variable for storing fourth cabinet fan state
  BOOL bool_Cabinet_4_Fan_State;
  
  //! @brief Variable for storing fifth cabinet fan state
  BOOL bool_Cabinet_5_Fan_State;
  
  //! @brief Variable for storing sixth cabinet fan state
  BOOL bool_Cabinet_6_Fan_State;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------