Librairie adaptée au laboratoire 2
Dependencies: ST_INTERFACES X_NUCLEO_COMMON
Fork of X_NUCLEO_6180XA1 by
Revision 47:2fc173b227d4, committed 2016-05-23
- Comitter:
- mapellil
- Date:
- Mon May 23 09:59:39 2016 +0000
- Parent:
- 46:116dadbc80f1
- Child:
- 48:e799ad44dab7
- Commit message:
- Aligned Component/Interface/Component_class.h to automatic conversion script output generating Component class instead of GenericSensor class.
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Components/Interfaces/Component_class.h Mon May 23 09:59:39 2016 +0000 @@ -0,0 +1,75 @@ +/** + ****************************************************************************** + * @file Component_class.h + * @author Davide Aliprandi, STMicrolectronics + * @version V1.0.0 + * @date April 13th, 2015 + * @brief This file contains the abstract class describing the interface of a + * generic 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. + * + ****************************************************************************** + */ + + +/* Define to prevent from recursive inclusion --------------------------------*/ + +#ifndef __COMPONENT_CLASS_H +#define __COMPONENT_CLASS_H + + +/* Includes ------------------------------------------------------------------*/ + +#include <stdint.h> + + +/* Classes ------------------------------------------------------------------*/ + +/** An abstract class for Generic components. + */ +class Component +{ +public: + /** + * @brief Initializing the component. + * @param init Pointer to device specific initalization structure. + * @retval "0" in case of success, an error code otherwise. + */ + virtual int Init(void *init) = 0; + + /** + * @brief Getting the ID of the component. + * @param id Pointer to an allocated variable to store the ID into. + * @retval "0" in case of success, an error code otherwise. + */ + virtual int ReadID(uint8_t *id) = 0; +}; + +#endif /* __COMPONENT_CLASS_H */ + +/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
--- a/Components/Interfaces/GenericSensor.h Thu May 19 14:11:25 2016 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,67 +0,0 @@ -/** - ****************************************************************************** - * @file GenericSensor.h - * @author AST / EST - * @version V0.0.1 - * @date 13-April-2015 - * @brief This file contains the abstract class describing in general - * the interfaces of a generic sensor - ****************************************************************************** - * @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. - * - ****************************************************************************** - */ - -/* Define to prevent from recursive inclusion --------------------------------*/ -#ifndef __GENERIC_SENSOR_CLASS_H -#define __GENERIC_SENSOR_CLASS_H - -/* Includes ------------------------------------------------------------------*/ -#include <stdint.h> - -/* Classes ------------------------------------------------------------------*/ -/** An abstract class for Generic sensors - */ -class GenericSensor -{ - public: - /** - * @brief Initialization of sensor - * @param[out] ptr Pointer to device specific initalization structure - * @return 0 in case of success, an error code otherwise - */ - virtual int Init(void *ptr) = 0; - - /** - * @brief Get ID of sensor - * @param[out] id Pointer to where to store the ID to - * @return 0 in case of success, an error code otherwise - */ - virtual int ReadID(uint8_t *id) = 0; -}; - -#endif /* __GENERIC_SENSOR_CLASS_H */
--- a/Components/Interfaces/LightSensor.h Thu May 19 14:11:25 2016 +0000 +++ b/Components/Interfaces/LightSensor.h Mon May 23 09:59:39 2016 +0000 @@ -41,12 +41,12 @@ #define __LIGHT_SENSOR_CLASS_H /* Includes ------------------------------------------------------------------*/ -#include "GenericSensor.h" +#include "Component_class.h" /* Classes ------------------------------------------------------------------*/ /** An abstract class for ambient light sensors */ -class LightSensor : public GenericSensor +class LightSensor : public Component { public: /**
--- a/Components/Interfaces/RangeSensor.h Thu May 19 14:11:25 2016 +0000 +++ b/Components/Interfaces/RangeSensor.h Mon May 23 09:59:39 2016 +0000 @@ -41,12 +41,12 @@ #define __RANGE_SENSOR_CLASS_H /* Includes ------------------------------------------------------------------*/ -#include "GenericSensor.h" +#include "Component_class.h" /* Classes ------------------------------------------------------------------*/ /** An abstract class for range sensors */ -class RangeSensor : public GenericSensor +class RangeSensor : public Component { public: /**