Stage-1 Students SoCEM / Mbed OS ReferredCoursework2016

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.

Dependencies:   X_NUCLEO_COMMON

Fork of X_NUCLEO_IKS01A1 by ST

Components/Common/Magneto.h@18:1cb4ae9d83e7, 2015-05-29 (annotated)

Committer:
Wolfgang Betz
Date:
Fri May 29 14:23:22 2015 +0200
Revision:
18:1cb4ae9d83e7
Parent:
4:566f2c41dc1d 
Remove Cube specific types from abstract classes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 3:088aa5839e0d 1 /**
Wolfgang Betz 3:088aa5839e0d 2 ******************************************************************************
Wolfgang Betz 3:088aa5839e0d 3 * @file Magneto.h
Wolfgang Betz 3:088aa5839e0d 4 * @author AST / EST
Wolfgang Betz 3:088aa5839e0d 5 * @version V0.0.1
Wolfgang Betz 3:088aa5839e0d 6 * @date 13-April-2015
Wolfgang Betz 3:088aa5839e0d 7 * @brief This file contains the abstract class describing in general
Wolfgang Betz 3:088aa5839e0d 8 * the interfaces of a magnetometer
Wolfgang Betz 3:088aa5839e0d 9 ******************************************************************************
Wolfgang Betz 3:088aa5839e0d 10 * @attention
Wolfgang Betz 3:088aa5839e0d 11 *
Wolfgang Betz 3:088aa5839e0d 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 3:088aa5839e0d 13 *
Wolfgang Betz 3:088aa5839e0d 14 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 3:088aa5839e0d 15 * are permitted provided that the following conditions are met:
Wolfgang Betz 3:088aa5839e0d 16 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 3:088aa5839e0d 17 * this list of conditions and the following disclaimer.
Wolfgang Betz 3:088aa5839e0d 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 3:088aa5839e0d 19 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 3:088aa5839e0d 20 * and/or other materials provided with the distribution.
Wolfgang Betz 3:088aa5839e0d 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 3:088aa5839e0d 22 * may be used to endorse or promote products derived from this software
Wolfgang Betz 3:088aa5839e0d 23 * without specific prior written permission.
Wolfgang Betz 3:088aa5839e0d 24 *
Wolfgang Betz 3:088aa5839e0d 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 3:088aa5839e0d 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 3:088aa5839e0d 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 3:088aa5839e0d 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 3:088aa5839e0d 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 3:088aa5839e0d 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 3:088aa5839e0d 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 3:088aa5839e0d 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 3:088aa5839e0d 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 3:088aa5839e0d 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 3:088aa5839e0d 35 *
Wolfgang Betz 3:088aa5839e0d 36 ******************************************************************************
Wolfgang Betz 3:088aa5839e0d 37 */
Wolfgang Betz 3:088aa5839e0d 38
Wolfgang Betz 3:088aa5839e0d 39 /* Define to prevent from recursive inclusion --------------------------------*/
Wolfgang Betz 3:088aa5839e0d 40 #ifndef __MAGNETO_CLASS_H
Wolfgang Betz 3:088aa5839e0d 41 #define __MAGNETO_CLASS_H
Wolfgang Betz 3:088aa5839e0d 42
Wolfgang Betz 3:088aa5839e0d 43 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 3:088aa5839e0d 44 #include "mbed.h"
Wolfgang Betz 3:088aa5839e0d 45
Wolfgang Betz 3:088aa5839e0d 46 /* Classes ------------------------------------------------------------------*/
Wolfgang Betz 3:088aa5839e0d 47 /** An abstract class for Magneto components
Wolfgang Betz 3:088aa5839e0d 48 */
Wolfgang Betz 3:088aa5839e0d 49 class Magneto
Wolfgang Betz 3:088aa5839e0d 50 {
Wolfgang Betz 3:088aa5839e0d 51 public:
Wolfgang Betz 18:1cb4ae9d83e7 52 virtual int Init(void*) = 0;
Wolfgang Betz 18:1cb4ae9d83e7 53 virtual int Read_M_ID(uint8_t*) = 0;
Wolfgang Betz 18:1cb4ae9d83e7 54 virtual int Get_M_Axes(int32_t*) = 0;
Wolfgang Betz 3:088aa5839e0d 55
Wolfgang Betz 3:088aa5839e0d 56 protected:
Wolfgang Betz 3:088aa5839e0d 57 Magneto(void) {};
Wolfgang Betz 3:088aa5839e0d 58 };
Wolfgang Betz 3:088aa5839e0d 59
Wolfgang Betz 3:088aa5839e0d 60 #endif /* __MAGNETO_CLASS_H */