Digital_IO_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Digital_IO_Base.h
//! @brief      Digital I/O base class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2021 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/SPI_Master_Base.h $
//!             $Revision: 2339 $
//!             $Date: 2021-01-08 14:06:54 +0500 (Fr, 08 Jan 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// 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 project files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief Digital I/O base class
class TDigital_IO_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TDigital_IO_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TDigital_IO_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Digital I/O initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Digital I/O finalisation method
    //! @note      Override method must initialise hardware dependent SPI bus unit and related GPIO.
    //! @return    None
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Done() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO initialisation method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Init() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     PIO reinitialisation as GPIO method
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID PIO_Done() = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Get digital output state
    //! @note      None
    //! @param     [in] u8_Index - Index of digital input
    //! @param     [in] bool_State - Digital output state
    //! @return    BOOL - Operation status
    //! @retval    false - Operation failed, output not found
    //! @retval    true - Operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Set_Output( U8 u8_Index, BOOL bool_State ) = 0;
 
    //!-------------------------------------------------------------------------
    //! @brief     Get digital input state
    //! @note      None
    //! @param     [in] u8_Index - Index of digital input
    //! @param     [out] bool_State - Digital input state
    //! @return    BOOL - Operation status
    //! @retval    false - Operation failed, input not found
    //! @retval    true - Operation successed
    //! \par       Override
    //!            Requered
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Input( U8 u8_Index, BOOL *bool_State ) = 0;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------