Jamie Satchell
/
JSatchell_SOFT253ReferredCoursework
Finished project.
Fork of ReferredCoursework2016 by
Components/Interfaces/GenericSensor.h
- Committer:
- J_Satchell
- Date:
- 2017-08-17
- Revision:
- 91:cd9fcd45ecf6
- Parent:
- 50:f507d4465c31
File content as of revision 91:cd9fcd45ecf6:
/** ****************************************************************************** * @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 */