Component.h

00001 /**
00002  ******************************************************************************
00003  * @file    Component.h
00004  * @author  AST
00005  * @version V1.0.0
00006  * @date    April 13th, 2015
00007  * @brief   This file contains the abstract class describing the interface of a
00008  *          generic component.
00009  ******************************************************************************
00010  * @attention
00011  *
00012  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013  *
00014  * Redistribution and use in source and binary forms, with or without modification,
00015  * are permitted provided that the following conditions are met:
00016  *   1. Redistributions of source code must retain the above copyright notice,
00017  *      this list of conditions and the following disclaimer.
00018  *   2. Redistributions in binary form must reproduce the above copyright notice,
00019  *      this list of conditions and the following disclaimer in the documentation
00020  *      and/or other materials provided with the distribution.
00021  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022  *      may be used to endorse or promote products derived from this software
00023  *      without specific prior written permission.
00024  *
00025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035  *
00036  ******************************************************************************
00037  */
00038 
00039 
00040 /* Define to prevent recursive inclusion -------------------------------------*/
00041 
00042 #ifndef __COMPONENT_CLASS_H
00043 #define __COMPONENT_CLASS_H
00044 
00045 
00046 /* Includes ------------------------------------------------------------------*/
00047 
00048 #include <stdint.h>
00049 
00050 
00051 /* Classes  ------------------------------------------------------------------*/
00052 
00053 /**
00054  * An abstract class for Generic components.
00055  */
00056 class Component {
00057 public:
00058 
00059     /**
00060      * @brief     Initializing the component.
00061      * @param[in] init pointer to device specific initalization structure.
00062      * @retval    "0" in case of success, an error code otherwise.
00063      */
00064     virtual int init(void *init) = 0;
00065 
00066     /**
00067      * @brief      Getting the ID of the component.
00068      * @param[out] id pointer to an allocated variable to store the ID into.
00069      * @retval     "0" in case of success, an error code otherwise.
00070      */
00071     virtual int read_id(uint8_t *id) = 0;
00072 
00073     /**
00074      * @brief Destructor.
00075      */
00076     virtual ~Component() {};
00077 };
00078 
00079 #endif /* __COMPONENT_CLASS_H */
00080 
00081 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/