upm/include/interfaces/iMagnetometer.hpp
Mihai Tudor Panu 89d5de43e0 license: update to SPDX style license text throughout
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
2020-03-05 15:13:36 -08:00

36 lines
883 B
C++

/*
* Author: Serban Waltter <serban.waltter@rinftech.com>
* Copyright (c) 2018 Intel Corporation.
*
* This program and the accompanying materials are made available under the
* terms of the The MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
*/
#pragma once
#include <vector>
namespace upm
{
/**
* @brief Interface for acceleration sensors
*/
class iMagnetometer
{
public:
virtual ~iMagnetometer() {}
/**
* Return gyroscope data in degrees per second in the form of
* a floating point vector in micro Tesla.
*
* @return A floating point vector containing x, y, and z in
* that order in micro Tesla.
*/
virtual std::vector<float> getMagnetometer() = 0;
};
} // upm