Sensor_Link_Channel.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Sensor_Link_Channel.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      25.05.2015
//! @brief     Sensor link channel object header file.
//! @attention
//!
//! COPYRIGHT(C) 2015 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 Sensor link channel object class
class TSensor_Link_Channel : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    // Register structure for generic access
    typedef struct
    {
      
      union
      {
        U16 u16_Control;  //!< Sensor link module control register
        U16 u16_Status;   //!< Sensor link module status register
      };
 
      U16 u16_Reserve;
 
      I16 i16_Raw_Data_1;  //!< RAW data 1 register
      I16 i16_Raw_Data_2;  //!< RAW data 2 register 
      
    } TSensor_Link_Channel_Registers;
    
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    // Constructor and destructor
    TSensor_Link_Channel();   //!< Constructor
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TSensor_Link_Channel();
 
    VOID Map( TSensor_Link_Channel_Registers *struct_Registers_Base_Address );
 
    //!-------------------------------------------------------------------------
    //! @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();
    
    //--------------------------------------------------------------------------
    // Public variables
    //--------------------------------------------------------------------------
 
    // Inputs
 
    // Outputs
    I16 i16_Raw_Data_1;
    I16 i16_Raw_Data_2;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
  
  private:
  
    TSensor_Link_Channel_Registers *struct_Registers;  //!< FPGA mapped registers
 
};
 
//------------------------------------------------------------------------------
// Export references to the objects
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Export references to the functions
//------------------------------------------------------------------------------
  
//------------------------------------------------------------------------------
// End Of File 
//------------------------------------------------------------------------------