Function_Block_Simple_Grid_Model_Test.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file        Function_Block_Simple_Grid_Model_Test.h
//! @author      ANVILEX GmbH
//! @version     V1.0
//! @date        24.05.2021
//! @brief       Three phase electric grid with active load model.
//! @attention
//!
//! COPYRIGHT(C) 2021 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 "Grid_To_Code.h"             
 
#include "rtwtypes.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
//! @brief Function block class declaration
//------------------------------------------------------------------------------
 
class TFunction_Block_Simple_Grid_Model_Test : 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_Simple_Grid_Model_Test();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block class desstructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TFunction_Block_Simple_Grid_Model_Test();
 
    //--------------------------------------------------------------------------
    // 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
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block outputs
    //--------------------------------------------------------------------------
 
    //! @brief First load resistor voltage value
    TBlock_Output_Connector object_f32_R1_Voltage;
    
    //! @brief First load resistor voltage value
    TBlock_Output_Connector object_f32_R2_Voltage;
    
    //! @brief First load resistor voltage value
    TBlock_Output_Connector object_f32_R3_Voltage;
 
  //----------------------------------------------------------------------------
  // Protected variables and methods
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private variables and methods
  //----------------------------------------------------------------------------
 
  private:
    
  //!---------------------------------------------------------------------------
  //! @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 rt_OneStep(void);
 
  //! @brief GRID_MODEL_TESTModelClass class object
  GRID_MODEL_TESTModelClass rtObj;
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------