MagnetometerModel.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
#include <agxSensor/export.h>
#include <agxSensor/TriaxialCrossSensitivity.h>
#include <agxSensor/TriaxialRange.h>
#include <agxSensor/TriaxialSignalSystemNode.h>
 
#include <agxStream/Serializable.h>
 
#include <agx/Referenced.h>
 
namespace agxSensor
{
  AGX_DECLARE_POINTER_TYPES( MagnetometerModel );
 
  class AGXSENSOR_EXPORT MagnetometerModel : public agx::Referenced, public agxStream::Serializable
  {
    public:
      static MagnetometerModel* makeIdealModel();
 
    public:
      MagnetometerModel( TriaxialRange range = agx::RangeReal(
                            std::numeric_limits<agx::Real>::lowest(),
                            std::numeric_limits<agx::Real>::max() ),
                         TriaxialCrossSensitivity crossSensitivity = 0.01,
                         agx::Vec3 zeroFluxBias = agx::Vec3( 0.0 ),
                         ITriaxialSignalSystemNodeRefVector outputModifiers = ITriaxialSignalSystemNodeRefVector() );
 
      void setRange( const TriaxialRange& range );
 
      const TriaxialRange& getRange() const;
 
      void setCrossAxisSensitivity( const TriaxialCrossSensitivity& crossSensitivity );
 
      const TriaxialCrossSensitivity& getCrossAxisSensitivity() const;
 
      void setZeroFluxBias( const agx::Vec3& zeroFluxBias );
 
      const agx::Vec3& getZeroFluxBias() const;
 
      const ITriaxialSignalSystemNodeRefVector& getOutputModifiers() const;
 
      DOXYGEN_START_INTERNAL_BLOCK()
 
    public:
      virtual ~MagnetometerModel() = default;
 
      AGXSTREAM_DECLARE_SERIALIZABLE( agxSensor::MagnetometerModel );
 
      DOXYGEN_END_INTERNAL_BLOCK()
 
    private:
      TriaxialRange m_range;
      TriaxialCrossSensitivity m_crossAxisSensitivity;
      agx::Vec3 m_zeroFluxBias;
      ITriaxialSignalSystemNodeRefVector m_outputModifiers;
  };
}