mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.
Dependents: HelloWorld_IKA01A1
Fork of X_NUCLEO_IKA01A1 by
Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.
Components/Interfaces/InstrumentationAmp.h
- Committer:
- Davidroid
- Date:
- 2017-07-13
- Revision:
- 23:807f66b435d6
- Parent:
- 22:ff8d071bf79e
File content as of revision 23:807f66b435d6:
/** ****************************************************************************** * @file InstrumentationAmp.h * @author AST * @version V1.0.0 * @date April 13th, 2015 * @brief This file contains the abstract class describing the interface of a * instrumentation_amp component. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * 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 STMicroelectronics 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. * ****************************************************************************** */ /* Generated with STM32CubeTOO -----------------------------------------------*/ /* Revision ------------------------------------------------------------------*/ /* Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev Branch/Trunk/Tag: trunk Based on: X-CUBE-IKA01A1/trunk/Drivers/BSP/Components/Common/instrumentation_amp.h Revision: 385 */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __INSTRUMENTATION_AMP_CLASS_H #define __INSTRUMENTATION_AMP_CLASS_H /* Includes ------------------------------------------------------------------*/ #include <Component.h> /* Classes ------------------------------------------------------------------*/ /** An abstract class for InstrumentationAmp components. */ class InstrumentationAmp : public Component { public: /* ACTION 1 --------------------------------------------------------------* * Declare here the interface's methods. * * They should be: * * + Methods with the same name of the C component's virtual table * * (and extended virtual table, if any)'s functions, provided that * * the component's driver implements them (i.e.: the corresponding * * pointer to function is not "0"). * * * * Example: * * virtual int get_value(float *f) = 0; * *------------------------------------------------------------------------*/ /** * @brief abstract method to obtain the amplified differential voltage in instrumentation Amplifier configuration * @retval amplified differential voltage in instrumentation Amplifier configuration */ virtual unsigned int get_voltage(void) = 0; /** * @brief abstract method to obtain the current consumed by the application in Current sensing configuration * @retval current consumed by the application in Current sensing configuration */ virtual unsigned int get_current(void) = 0; /** * @brief Destructor. */ virtual ~InstrumentationAmp() {}; }; #endif /* __INSTRUMENTATION_AMP_CLASS_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/