Table of Contents

Class Magnetometer

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

[Nominal] Class for the Three Axis Magnetometer (TAM) sensor that is able to detect the magnetic field of the craft.

public class Magnetometer : Sensor
Inheritance
Magnetometer

Constructors

Magnetometer()

Default constructor

protected Magnetometer()

Fields

Bias

Sensor bias value

[Unit(UnitType.TESLA)]
[Range(0, 1.7976931348623157E+308)]
[Metadata(IsAdvanced = true)]
public Vector3 Bias

Field Value

Vector3

In_MagneticFieldMsg

Input message for the magnetic field data in the inertial frame N

public MagneticFieldMessage? In_MagneticFieldMsg

Field Value

MagneticFieldMessage

MaxOutput

Maximum output (ceiling) for saturation application

[Unit(UnitType.TESLA)]
[Range(0, 1.7976931348623157E+308)]
public double MaxOutput

Field Value

double

MinOutput

Minimum sense (floor) for saturation application

[Unit(UnitType.TESLA)]
public double MinOutput

Field Value

double

NoiseStd

Sensor noise value

[Unit(UnitType.TESLA)]
[Range(0, 1.7976931348623157E+308)]
[Metadata(IsAdvanced = true)]
public Vector3 NoiseStd

Field Value

Vector3

Out_TAMDataMsg

Output message for TAM data in sensor frame S

public TAMDataMessage? Out_TAMDataMsg

Field Value

TAMDataMessage

ScaleFactor

Scale factor applied to sensor

[Unit(UnitType.NONE)]
[Range(0, 1.7976931348623157E+308)]
[Metadata(IsAdvanced = true)]
public double ScaleFactor

Field Value

double

WalkBounds

"3-sigma" errors to permit for Gauss Markov walk bounds

[Unit(UnitType.TESLA)]
[Metadata(IsAdvanced = true)]
public Vector3 WalkBounds

Field Value

Vector3

Properties

SensedNanos

The sensed nano value from the magnetometer in the sensor frame.

[Unit(UnitPrefix.NANO, UnitType.TESLA)]
[ReadOnly]
public Vector3 SensedNanos { get; }

Property Value

Vector3

SensedValue

The sensed value from the magnetometer in the sensor frame.

[Unit(UnitType.TESLA)]
[ReadOnly]
[Metadata(ContainedIn = "Out_TAMDataMsg")]
public Vector3 SensedValue { get; }

Property Value

Vector3

Methods

OnBegin(double)

Called when the object is beginning ticking for the first time. This is when the simulation calls the very first tick and will run before the update call.

protected override void OnBegin(double time)

Parameters

time double

[s] Current time of the simulation before the tick

OnCreate()

Called when the 'Component' is created from the controller.

protected override void OnCreate()

OnLoad(double)

Called after all of the data has been loaded from a save state on this object. This enables any post-load operations to be performed and extra data to be loaded from the metadata.

protected override void OnLoad(double time)

Parameters

time double

[s] The current clock time of the simulation

OnUpdate(double, double)

Called when the object should update from the simulation tick. This will take in a time and a step, where the time is the time of the clock before updating the object.

protected override void OnUpdate(double time, double step)

Parameters

time double

[s] Current time of the simulation before the update

step double

[s] The time-step to update during this tick