Robotique FIP / X_NUCLEO_IHM01A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of X_NUCLEO_IHM01A1 by ST

Components/Interfaces/Component_class.h@20:a8e81b65f0af, 2016-01-15 (annotated)

Committer:
Davidroid
Date:
Fri Jan 15 16:42:39 2016 +0000
Revision:
20:a8e81b65f0af
Parent:
10:c3824af0caf4
Child:
22:ed3a6990a6eb
+ Added comments within the "L6474_class.h" header file.

Who changed what in which revision?

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