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
Components/Common/Magneto.h
- Committer:
- Wolfgang Betz
- Date:
- 2015-04-14
- Revision:
- 4:566f2c41dc1d
- Parent:
- 3:088aa5839e0d
- Child:
- 18:1cb4ae9d83e7
File content as of revision 4:566f2c41dc1d:
/**
******************************************************************************
* @file Magneto.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 magnetometer
******************************************************************************
* @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 __MAGNETO_CLASS_H
#define __MAGNETO_CLASS_H
/* Includes ------------------------------------------------------------------*/
#include "mbed.h"
#include "magneto.h"
/* Classes ------------------------------------------------------------------*/
/** An abstract class for Magneto components
*/
class Magneto
{
public:
virtual MAGNETO_StatusTypeDef Init(MAGNETO_InitTypeDef*) = 0;
virtual MAGNETO_StatusTypeDef Read_M_ID(uint8_t*) = 0;
virtual MAGNETO_StatusTypeDef Get_M_Axes(int32_t*) = 0;
protected:
Magneto(void) {};
};
#endif /* __MAGNETO_CLASS_H */
