AMS Advanced Air Mobility Sensors UG
Loading...
Searching...
No Matches
CMagnetometerCompensator Class Reference

The class implements a SW component that applies calibration parameters to signals of magnetometers. More...

Inheritance diagram for CMagnetometerCompensator:
CSoftwareComponent< CMagnetometerCompensator, 1U >

Public Member Functions

void Init () override
bool IsInitialized () override
void CompensateMeasurements ()
 Apply calibration parameters to magnetometer measurements.
Public Member Functions inherited from CSoftwareComponent< CMagnetometerCompensator, 1U >
 CSoftwareComponent (CSoftwareComponent &)=delete
CSoftwareComponent & operator= (const CSoftwareComponent &orOther)=delete

Private Member Functions

 CMagnetometerCompensator (CMagnetometerCompensator &)=delete
 CMagnetometerCompensator (CMagnetometerCompensator &&)=delete
CMagnetometerCompensator & operator= (const CMagnetometerCompensator &orOther)=delete
CMagnetometerCompensator & operator= (CMagnetometerCompensator &&orOther)=delete
 CMagnetometerCompensator ()=default
 ~CMagnetometerCompensator ()=default

Static Private Member Functions

static CMagnetometerCompensator & getInstanceImpl (unsigned uInstanceIndex)

Private Attributes

bool bIsInitialized_ { false }
 True – SWC is initialized, false otherwise.
Eigen::Vector3f oHardIron_
 Hard-iron compensation parameters.
Eigen::Matrix3f oSoftIron_
 Soft-iron compensation parameters.

Friends

class CSoftwareComponent< CMagnetometerCompensator, 1U >

Additional Inherited Members

Static Public Member Functions inherited from CSoftwareComponent< CMagnetometerCompensator, 1U >
static CMagnetometerCompensator & GetInstance (unsigned uInstanceIndex=0U)
Static Public Attributes inherited from CSoftwareComponent< CMagnetometerCompensator, 1U >
static constexpr unsigned skuInstanceCount_
Protected Member Functions inherited from CSoftwareComponent< CMagnetometerCompensator, 1U >
 ~CSoftwareComponent ()=default

Detailed Description

The class implements a SW component that applies calibration parameters to signals of magnetometers.

Constructor & Destructor Documentation

◆ CMagnetometerCompensator() [1/3]

CMagnetometerCompensator::CMagnetometerCompensator ( CMagnetometerCompensator & )
privatedelete

◆ CMagnetometerCompensator() [2/3]

CMagnetometerCompensator::CMagnetometerCompensator ( CMagnetometerCompensator && )
privatedelete

◆ CMagnetometerCompensator() [3/3]

CMagnetometerCompensator::CMagnetometerCompensator ( )
privatedefault

◆ ~CMagnetometerCompensator()

CMagnetometerCompensator::~CMagnetometerCompensator ( )
privatedefault

Member Function Documentation

◆ CompensateMeasurements()

void CMagnetometerCompensator::CompensateMeasurements ( )

Apply calibration parameters to magnetometer measurements.

◆ getInstanceImpl()

CMagnetometerCompensator & CMagnetometerCompensator::getInstanceImpl ( unsigned uInstanceIndex)
staticprivate

◆ Init()

void CMagnetometerCompensator::Init ( )
overridevirtual

Initialize the software component.

Implements CSoftwareComponent< CMagnetometerCompensator, 1U >.

◆ IsInitialized()

bool CMagnetometerCompensator::IsInitialized ( )
overridevirtual

Get initialization status of the software component.

Returns
True – the component is initialized, false otherwise.

Implements CSoftwareComponent< CMagnetometerCompensator, 1U >.

◆ operator=() [1/2]

CMagnetometerCompensator & CMagnetometerCompensator::operator= ( CMagnetometerCompensator && orOther)
privatedelete

◆ operator=() [2/2]

CMagnetometerCompensator & CMagnetometerCompensator::operator= ( const CMagnetometerCompensator & orOther)
privatedelete

◆ CSoftwareComponent< CMagnetometerCompensator, 1U >

friend class CSoftwareComponent< CMagnetometerCompensator, 1U >
friend

Member Data Documentation

◆ bIsInitialized_

bool CMagnetometerCompensator::bIsInitialized_ { false }
private

True – SWC is initialized, false otherwise.

◆ oHardIron_

Eigen::Vector3f CMagnetometerCompensator::oHardIron_
private

Hard-iron compensation parameters.

◆ oSoftIron_

Eigen::Matrix3f CMagnetometerCompensator::oSoftIron_
private

Soft-iron compensation parameters.

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