Class MagneticModel

Namespace

NominalSystems.Universe

Assembly

NominalSystems.Universe.dll

[Nominal] The magnetic model will be able to detect the presence of a magnetic field around the object. This will look at the magnetospheres that exists on the celestial bodies.

---

public class MagneticModel : UniverseModel<UniverseObject>

Inheritance

object

Object

UniverseEvent

UniverseModel

UniverseModel<UniverseObject>

MagneticModel

Extension Methods

SimulationExtension.GetState(Object)

Constructors

MagneticModel()

Default constructor for the Magnetic model

protected MagneticModel()

Fields

In_TransformMsg

A reference to the transform message that contains information about the current position of the object in the simulation.

public TransformMessage? In_TransformMsg

Field Value

TransformMessage

Out_MagneticFieldMsg

A message that contains all the information about the magnetic field at the current location.

public MagneticFieldMessage? Out_MagneticFieldMsg

Field Value

MagneticFieldMessage

Properties

Field_N

Local magnetic field at some inertial point in the inertial frame.

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

Property Value

Vector3

Methods

OnCreate()

Called when the object is created from the controller and has been attached to the parent object. By this point, it has been registered to the simulation and will run after the constructor.

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