Skip to content
Snippets Groups Projects
Commit 9a720b1b authored by Nicolò's avatar Nicolò
Browse files

MY_LIS3DSHData.h renaming + copyright header + doxigen

Renaming from LIS3DSHData -> MY_LIS3DSHData, added copyright header, doxygen comments

Renaming to MY_LIS3DSHData to avoid clash with the already existing LIS3DSHData inside boardcore
Added the copyright header.
Changed commenting convention to the doxygen convention 
Reformatted code
parent 1d780cff
No related branches found
No related tags found
No related merge requests found
/* Copyright (c) 2023 Skyward Experimental Rocketry
* Author: Nicolò Caruso
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#pragma once
......@@ -6,27 +27,29 @@
namespace Boardcore
{
struct LIS3DSHData : public AccelerometerData
struct MY_LIS3DSHData : public AccelerometerData
{
// Struct default inistialization / constructor
LIS3DSHData() : AccelerometerData(0,0,0,0){};
/*! Struct default inistialization / constructor */
MY_LIS3DSHData() : AccelerometerData(0, 0, 0, 0){};
// Constructor with Timestamp, accelerations on X,Y,Z axis
LIS3DSHData(uint64_t ts, float aX, float aY, float aZ)
/*! Constructor with Timestamp, accelerations on X,Y,Z axis */
MY_LIS3DSHData(uint64_t ts, float aX, float aY, float aZ)
: AccelerometerData(ts, aX, aY, aZ){};
// Accelerometer data as input constructor
explicit LIS3DSHData(AccelerometerData acc) : AccelerometerData(acc){};
/*! Accelerometer data as input constructor */
explicit MY_LIS3DSHData(AccelerometerData acc) : AccelerometerData(acc){};
// Struct header
static std::string header(){
/*! Struct header */
static std::string header()
{
return "timestamp, accelerationX, accelerationY, accelerationZ\n";
}
// Constant method to print to given stream the datastr.
void print(std::ostream& os) const{
os << accelerationTimestamp << ", " << accelerationX
<< ", " << accelerationY << ", " << accelerationZ << "\n";
/*! Constant method to print to given stream the datastr. */
void print(std::ostream& os) const
{
os << accelerationTimestamp << ", " << accelerationX << ", "
<< accelerationY << ", " << accelerationZ << "\n";
}
};
} // namespace Boardcore
\ No newline at end of file
} //! namespace Boardcore
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment