PowerSwitch.h

00001 /**
00002  ******************************************************************************
00003  * @file    PowerSwitch.h
00004  * @author  ADG
00005  * @version V1.0.1
00006  * @date    01-July-2016
00007  * @brief   This file contains the abstract class describing in general
00008  *          the interfaces of a generic intelligent power switch (IPS)
00009  ******************************************************************************
00010  * @attention
00011  *
00012  * <h2><center>&copy; COPYRIGHT(c) 2016 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 /* Define to prevent from recursive inclusion --------------------------------*/
00040 #ifndef __GENERIC_IPS_CLASS_H
00041 #define __GENERIC_IPS_CLASS_H
00042  
00043 /* Includes ------------------------------------------------------------------*/
00044 #include <stdint.h>
00045 #include <Component.h>
00046  
00047 /* Classes  ------------------------------------------------------------------*/
00048 /** An abstract class for Generic Power Switch
00049  */
00050 class PowerSwitch : public Component
00051 {
00052 public:
00053     /* Provide Ch current w/o checking status of convertion */
00054     virtual float get_current(int Ch) = 0;
00055 
00056     /**
00057      * @brief Destructor.
00058      */
00059     virtual ~PowerSwitch() {};
00060 };
00061  
00062 #endif /* __GENERIC_IPS_CLASS_H */
00063  
00064 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 
00065  
00066