ST / X_NUCLEO_IKA01A1

mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.

Dependents:   HelloWorld_IKA01A1

Fork of X_NUCLEO_IKA01A1 by ST Expansion SW Team

Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.

Components/Interfaces/Instrumentation_amp_class.h@0:8d2ff26a1946, 2016-02-24 (annotated)

Committer:
hemddabral
Date:
Wed Feb 24 12:16:21 2016 +0000
Revision:
0:8d2ff26a1946
first version of IKA01A1 mbed library;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hemddabral 0:8d2ff26a1946 1 /**
hemddabral 0:8d2ff26a1946 2 ******************************************************************************
hemddabral 0:8d2ff26a1946 3 * @file Instrumentation_amp_class.h
hemddabral 0:8d2ff26a1946 4 * @author AST
hemddabral 0:8d2ff26a1946 5 * @version V1.0.0
hemddabral 0:8d2ff26a1946 6 * @date April 13th, 2015
hemddabral 0:8d2ff26a1946 7 * @brief This file contains the abstract class describing the interface of a
hemddabral 0:8d2ff26a1946 8 * instrumentation_amp component.
hemddabral 0:8d2ff26a1946 9 ******************************************************************************
hemddabral 0:8d2ff26a1946 10 * @attention
hemddabral 0:8d2ff26a1946 11 *
hemddabral 0:8d2ff26a1946 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
hemddabral 0:8d2ff26a1946 13 *
hemddabral 0:8d2ff26a1946 14 * Redistribution and use in source and binary forms, with or without modification,
hemddabral 0:8d2ff26a1946 15 * are permitted provided that the following conditions are met:
hemddabral 0:8d2ff26a1946 16 * 1. Redistributions of source code must retain the above copyright notice,
hemddabral 0:8d2ff26a1946 17 * this list of conditions and the following disclaimer.
hemddabral 0:8d2ff26a1946 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
hemddabral 0:8d2ff26a1946 19 * this list of conditions and the following disclaimer in the documentation
hemddabral 0:8d2ff26a1946 20 * and/or other materials provided with the distribution.
hemddabral 0:8d2ff26a1946 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
hemddabral 0:8d2ff26a1946 22 * may be used to endorse or promote products derived from this software
hemddabral 0:8d2ff26a1946 23 * without specific prior written permission.
hemddabral 0:8d2ff26a1946 24 *
hemddabral 0:8d2ff26a1946 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
hemddabral 0:8d2ff26a1946 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
hemddabral 0:8d2ff26a1946 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
hemddabral 0:8d2ff26a1946 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
hemddabral 0:8d2ff26a1946 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
hemddabral 0:8d2ff26a1946 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
hemddabral 0:8d2ff26a1946 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
hemddabral 0:8d2ff26a1946 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
hemddabral 0:8d2ff26a1946 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
hemddabral 0:8d2ff26a1946 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
hemddabral 0:8d2ff26a1946 35 *
hemddabral 0:8d2ff26a1946 36 ******************************************************************************
hemddabral 0:8d2ff26a1946 37 */
hemddabral 0:8d2ff26a1946 38
hemddabral 0:8d2ff26a1946 39
hemddabral 0:8d2ff26a1946 40 /* Generated with STM32CubeTOO -----------------------------------------------*/
hemddabral 0:8d2ff26a1946 41
hemddabral 0:8d2ff26a1946 42
hemddabral 0:8d2ff26a1946 43 /* Revision ------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 44 /*
hemddabral 0:8d2ff26a1946 45 Repository: http://svn.x-nucleodev.codex.cro.st.com/svnroot/X-NucleoDev
hemddabral 0:8d2ff26a1946 46 Branch/Trunk/Tag: trunk
hemddabral 0:8d2ff26a1946 47 Based on: X-CUBE-IKA01A1/trunk/Drivers/BSP/Components/Common/instrumentation_amp.h
hemddabral 0:8d2ff26a1946 48 Revision: 385
hemddabral 0:8d2ff26a1946 49 */
hemddabral 0:8d2ff26a1946 50
hemddabral 0:8d2ff26a1946 51
hemddabral 0:8d2ff26a1946 52 /* Define to prevent recursive inclusion -------------------------------------*/
hemddabral 0:8d2ff26a1946 53
hemddabral 0:8d2ff26a1946 54 #ifndef __INSTRUMENTATION_AMP_CLASS_H
hemddabral 0:8d2ff26a1946 55 #define __INSTRUMENTATION_AMP_CLASS_H
hemddabral 0:8d2ff26a1946 56
hemddabral 0:8d2ff26a1946 57
hemddabral 0:8d2ff26a1946 58 /* Includes ------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 59
hemddabral 0:8d2ff26a1946 60 #include <Component_class.h>
hemddabral 0:8d2ff26a1946 61
hemddabral 0:8d2ff26a1946 62
hemddabral 0:8d2ff26a1946 63 /* Classes ------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 64
hemddabral 0:8d2ff26a1946 65 /** An abstract class for Instrumentation_amp components.
hemddabral 0:8d2ff26a1946 66 */
hemddabral 0:8d2ff26a1946 67 class Instrumentation_amp : public Component
hemddabral 0:8d2ff26a1946 68 {
hemddabral 0:8d2ff26a1946 69 public:
hemddabral 0:8d2ff26a1946 70 /* ACTION 1 --------------------------------------------------------------*
hemddabral 0:8d2ff26a1946 71 * Declare here the interface's methods. *
hemddabral 0:8d2ff26a1946 72 * They should be: *
hemddabral 0:8d2ff26a1946 73 * + Methods with the same name of the C component's virtual table *
hemddabral 0:8d2ff26a1946 74 * (and extended virtual table, if any)'s functions, provided that *
hemddabral 0:8d2ff26a1946 75 * the component's driver implements them (i.e.: the corresponding *
hemddabral 0:8d2ff26a1946 76 * pointer to function is not "0"). *
hemddabral 0:8d2ff26a1946 77 * *
hemddabral 0:8d2ff26a1946 78 * Example: *
hemddabral 0:8d2ff26a1946 79 * virtual int GetValue(float *f) = 0; *
hemddabral 0:8d2ff26a1946 80 *------------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 81 virtual int GetVoltage(unsigned int *ptrVoltage) = 0;
hemddabral 0:8d2ff26a1946 82 virtual int GetCurrent(unsigned int *ptrCurrent) = 0;
hemddabral 0:8d2ff26a1946 83 };
hemddabral 0:8d2ff26a1946 84
hemddabral 0:8d2ff26a1946 85 #endif /* __INSTRUMENTATION_AMP_CLASS_H */
hemddabral 0:8d2ff26a1946 86
hemddabral 0:8d2ff26a1946 87 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
hemddabral 0:8d2ff26a1946 88