Table of Contents

Class SolarModel

Namespace
NominalSystems.Universe
Assembly
NominalSystems.Universe.dll

[Nominal] Defines the behaviour for a solar observer that is able to determine the solar flux of the sun and the eclipse based on the planets at the current position of the attached target. This model can be placed on any particular universe object class.

public class SolarModel : UniverseModel<UniverseObject>
Inheritance
SolarModel
Extension Methods

Constructors

SolarModel()

Default constructor

protected SolarModel()

Fields

In_SunSpicePlanetStateMsg

A reference to the sun planet spice message from the simulation that includes the sun message.

public SpicePlanetStateMessage? In_SunSpicePlanetStateMsg

Field Value

SpicePlanetStateMessage

In_TransformMsg

A reference to the current transform of the object that is attached to this model.

public TransformMessage? In_TransformMsg

Field Value

TransformMessage

Out_EclipseMsg

The eclipse information at the current point of the simulation at the location of the object.

public EclipseMessage? Out_EclipseMsg

Field Value

EclipseMessage

Out_SolarFluxMsg

The solar flux information at the current point of the simulation at the location of the object.

public SolarFluxMessage? Out_SolarFluxMsg

Field Value

SolarFluxMessage

Properties

Flux

Flux at body position.

[Unit(UnitType.WATT_PER_SQUARE_METRE)]
[ReadOnly]
[Metadata(ContainedIn = "Out_SolarFluxMsg")]
public double Flux { get; }

Property Value

double

Visibility

The factor of visibility between the object and the sun (1.0 being fully visible).

[Unit(UnitType.NONE)]
[ReadOnly]
[Metadata(ContainedIn = "Out_EclipseMsg")]
public double Visibility { get; }

Property Value

double

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