Emmanuel L. / X_NUCLEO_IHM04A1

Use BDCMotor_class.h instead of motor_class.h

Dependents:   HelloWorld_IHM04A1

Fork of X_NUCLEO_IHM04A1 by ST

Components/Interfaces/Component_class.h@3:b06e38d365d7, 2016-06-14 (annotated)

Committer:
Manu_L
Date:
Tue Jun 14 12:14:28 2016 +0000
Revision:
3:b06e38d365d7
Parent:
0:2cb6ce8e07bd 
Use BDCMotor_class.h instead of Motor_class.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
brdirais 0:2cb6ce8e07bd 1 /**
brdirais 0:2cb6ce8e07bd 2 ******************************************************************************
brdirais 0:2cb6ce8e07bd 3 * @file Component_class.h
brdirais 0:2cb6ce8e07bd 4 * @author AST
brdirais 0:2cb6ce8e07bd 5 * @version V1.0.0
brdirais 0:2cb6ce8e07bd 6 * @date April 13th, 2015
brdirais 0:2cb6ce8e07bd 7 * @brief This file contains the abstract class describing the interface of a
brdirais 0:2cb6ce8e07bd 8 * generic component.
brdirais 0:2cb6ce8e07bd 9 ******************************************************************************
brdirais 0:2cb6ce8e07bd 10 * @attention
brdirais 0:2cb6ce8e07bd 11 *
brdirais 0:2cb6ce8e07bd 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
brdirais 0:2cb6ce8e07bd 13 *
brdirais 0:2cb6ce8e07bd 14 * Redistribution and use in source and binary forms, with or without modification,
brdirais 0:2cb6ce8e07bd 15 * are permitted provided that the following conditions are met:
brdirais 0:2cb6ce8e07bd 16 * 1. Redistributions of source code must retain the above copyright notice,
brdirais 0:2cb6ce8e07bd 17 * this list of conditions and the following disclaimer.
brdirais 0:2cb6ce8e07bd 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
brdirais 0:2cb6ce8e07bd 19 * this list of conditions and the following disclaimer in the documentation
brdirais 0:2cb6ce8e07bd 20 * and/or other materials provided with the distribution.
brdirais 0:2cb6ce8e07bd 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
brdirais 0:2cb6ce8e07bd 22 * may be used to endorse or promote products derived from this software
brdirais 0:2cb6ce8e07bd 23 * without specific prior written permission.
brdirais 0:2cb6ce8e07bd 24 *
brdirais 0:2cb6ce8e07bd 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
brdirais 0:2cb6ce8e07bd 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
brdirais 0:2cb6ce8e07bd 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
brdirais 0:2cb6ce8e07bd 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
brdirais 0:2cb6ce8e07bd 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
brdirais 0:2cb6ce8e07bd 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
brdirais 0:2cb6ce8e07bd 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
brdirais 0:2cb6ce8e07bd 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
brdirais 0:2cb6ce8e07bd 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
brdirais 0:2cb6ce8e07bd 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
brdirais 0:2cb6ce8e07bd 35 *
brdirais 0:2cb6ce8e07bd 36 ******************************************************************************
brdirais 0:2cb6ce8e07bd 37 */
brdirais 0:2cb6ce8e07bd 38
brdirais 0:2cb6ce8e07bd 39
brdirais 0:2cb6ce8e07bd 40 /* Define to prevent recursive inclusion -------------------------------------*/
brdirais 0:2cb6ce8e07bd 41
brdirais 0:2cb6ce8e07bd 42 #ifndef __COMPONENT_CLASS_H
brdirais 0:2cb6ce8e07bd 43 #define __COMPONENT_CLASS_H
brdirais 0:2cb6ce8e07bd 44
brdirais 0:2cb6ce8e07bd 45
brdirais 0:2cb6ce8e07bd 46 /* Includes ------------------------------------------------------------------*/
brdirais 0:2cb6ce8e07bd 47
brdirais 0:2cb6ce8e07bd 48 #include <stdint.h>
brdirais 0:2cb6ce8e07bd 49
brdirais 0:2cb6ce8e07bd 50
brdirais 0:2cb6ce8e07bd 51 /* Classes ------------------------------------------------------------------*/
brdirais 0:2cb6ce8e07bd 52
brdirais 0:2cb6ce8e07bd 53 /** An abstract class for Generic components.
brdirais 0:2cb6ce8e07bd 54 */
brdirais 0:2cb6ce8e07bd 55 class Component
brdirais 0:2cb6ce8e07bd 56 {
brdirais 0:2cb6ce8e07bd 57 public:
brdirais 0:2cb6ce8e07bd 58 /**
brdirais 0:2cb6ce8e07bd 59 * @brief Initializing the component.
brdirais 0:2cb6ce8e07bd 60 * @param[in] init pointer to device specific initalization structure.
brdirais 0:2cb6ce8e07bd 61 * @retval "0" in case of success, an error code otherwise.
brdirais 0:2cb6ce8e07bd 62 */
brdirais 0:2cb6ce8e07bd 63 virtual int Init(void *init) = 0;
brdirais 0:2cb6ce8e07bd 64
brdirais 0:2cb6ce8e07bd 65 /**
brdirais 0:2cb6ce8e07bd 66 * @brief Getting the ID of the component.
brdirais 0:2cb6ce8e07bd 67 * @param[out] id pointer to an allocated variable to store the ID into.
brdirais 0:2cb6ce8e07bd 68 * @retval "0" in case of success, an error code otherwise.
brdirais 0:2cb6ce8e07bd 69 */
brdirais 0:2cb6ce8e07bd 70 virtual int ReadID(uint8_t *id) = 0;
brdirais 0:2cb6ce8e07bd 71 };
brdirais 0:2cb6ce8e07bd 72
brdirais 0:2cb6ce8e07bd 73 #endif /* __COMPONENT_CLASS_H */
brdirais 0:2cb6ce8e07bd 74
brdirais 0:2cb6ce8e07bd 75 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
brdirais 0:2cb6ce8e07bd 76