Table of Contents

Class MagneticTorqueBar

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

[Nominal] This component models a singular magnetic torque bar. These magnetic torque bars can be added as children of Magnetic Torque Bar arrays.

[UniverseParent(typeof(MagneticTorqueBarArray))]
public class MagneticTorqueBar : PhysicalObject
Inheritance
MagneticTorqueBar

Constructors

MagneticTorqueBar()

Default constructor

protected MagneticTorqueBar()

Fields

ArrayIndex

The index of this Magnetic Torque bat within the MTB Array.

[Unit(UnitType.NONE)]
[ReadOnly]
public int ArrayIndex

Field Value

int

Out_MTBConfigMsg

The message storing data relating to this torque bar.

public MTBConfigMessage? Out_MTBConfigMsg

Field Value

MTBConfigMessage

Properties

BarAxis_B

Magnetic torque bar alignment in Body frame components

[Unit(UnitType.NONE)]
[Metadata(ContainedIn = "Out_MTBConfigMsg")]
public Vector3 BarAxis_B { get; set; }

Property Value

Vector3

MaxDipoles

Maximum commanded dipole.

[Unit("A·m²")]
[Metadata(ContainedIn = "Out_MTBConfigMsg")]
public double MaxDipoles { get; set; }

Property Value

double

Torque_B

Current magnetic torque bar torque in the body frame.

[Unit(UnitType.NEWTON_METRE)]
[ReadOnly]
[Metadata(ContainedIn = "Out_MTBConfigMsg")]
public Vector3 Torque_B { get; set; }

Property Value

Vector3

Methods

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