LibMultiSense
LibMultiSense Documentation
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
crl::multisense::imu::Sample Class Reference

Class containing a single IMU sample. More...

#include <MultiSenseTypes.hh>

Public Types

typedef uint16_t Type
 Typedef used to determine which data source a sample came from. More...
 

Public Member Functions

double time () const
 A convenience function used for getting the time of the specific sample. More...
 

Public Attributes

Type type
 The type of data contained in the instance of imu::Sample. More...
 
uint32_t timeSeconds
 The time seconds value corresponding to the specific sample. More...
 
uint32_t timeMicroSeconds
 The time microseconds value corresponding to the specific sample. More...
 
float x
 x data for each sample More...
 
float y
 y data for each sample More...
 
float z
 z data for each sample More...
 

Static Public Attributes

static CRL_CONSTEXPR Type Type_Accelerometer = 1
 
static CRL_CONSTEXPR Type Type_Gyroscope = 2
 
static CRL_CONSTEXPR Type Type_Magnetometer = 3
 

Detailed Description

Class containing a single IMU sample.

A sample can contain data either accelerometer data, gyroscope data, or magnetometer data.

Definition at line 2167 of file MultiSenseTypes.hh.

Member Typedef Documentation

◆ Type

typedef uint16_t crl::multisense::imu::Sample::Type

Typedef used to determine which data source a sample came from.

Definition at line 2171 of file MultiSenseTypes.hh.

Member Function Documentation

◆ time()

double crl::multisense::imu::Sample::time ( ) const
inline

A convenience function used for getting the time of the specific sample.

return The time corresponding to the sample as a double

Definition at line 2214 of file MultiSenseTypes.hh.

Member Data Documentation

◆ timeMicroSeconds

uint32_t crl::multisense::imu::Sample::timeMicroSeconds

The time microseconds value corresponding to the specific sample.

Definition at line 2182 of file MultiSenseTypes.hh.

◆ timeSeconds

uint32_t crl::multisense::imu::Sample::timeSeconds

The time seconds value corresponding to the specific sample.

Definition at line 2180 of file MultiSenseTypes.hh.

◆ type

Type crl::multisense::imu::Sample::type

The type of data contained in the instance of imu::Sample.

Definition at line 2178 of file MultiSenseTypes.hh.

◆ Type_Accelerometer

CRL_CONSTEXPR Type crl::multisense::imu::Sample::Type_Accelerometer = 1
static

Definition at line 2173 of file MultiSenseTypes.hh.

◆ Type_Gyroscope

CRL_CONSTEXPR Type crl::multisense::imu::Sample::Type_Gyroscope = 2
static

Definition at line 2174 of file MultiSenseTypes.hh.

◆ Type_Magnetometer

CRL_CONSTEXPR Type crl::multisense::imu::Sample::Type_Magnetometer = 3
static

Definition at line 2175 of file MultiSenseTypes.hh.

◆ x

float crl::multisense::imu::Sample::x

x data for each sample

The units vary by source and can be queried with crl::multisense::Channel::getImuInfo

Definition at line 2190 of file MultiSenseTypes.hh.

◆ y

float crl::multisense::imu::Sample::y

y data for each sample

The units vary by source and can be queried with crl::multisense::Channel::getImuInfo

Definition at line 2198 of file MultiSenseTypes.hh.

◆ z

float crl::multisense::imu::Sample::z

z data for each sample

The units vary by source and can be queried with crl::multisense::Channel::getImuInfo

Definition at line 2206 of file MultiSenseTypes.hh.

The documentation for this class was generated from the following file: