Luca Istorico / X_NUCLEO_IHM02A1

Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the L6470 component.

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM02A1 by ST

Components/Interfaces/Component_class.h@1:b78dab6d2c58, 2015-11-25 (annotated)

Committer:
Davidroid
Date:
Wed Nov 25 11:59:37 2015 +0000
Revision:
1:b78dab6d2c58
Parent:
0:92706998571a
Child:
4:381d76f5b0b4
+ Implemented all the StepperMotor's APIs.

Who changed what in which revision?

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