Table of Contents

Class GuidanceComputer

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

[Nominal] A guidance computer can be added to a spacecraft which can control the guidance modes of the software. This is useful for having different behaviours, making use of the Guidance Software Chain Sequence.

public class GuidanceComputer : Computer
Inheritance
GuidanceComputer
Derived

Constructors

GuidanceComputer()

Default constructor

protected GuidanceComputer()

Fields

In_AttitudeErrorMsg

Stores a reference the current guidance error message from the pointing chain, for reference and copy, if it exists. This will change as the software chains change between modes.

[Hidden]
public AttitudeErrorMessage? In_AttitudeErrorMsg

Field Value

AttitudeErrorMessage

In_AttitudeReferenceMsg

Stores a reference the current guidance reference message from the pointing chain, for reference and copy, if it exists. This will change as the software chains change between modes.

[Hidden]
public AttitudeReferenceMessage? In_AttitudeReferenceMsg

Field Value

AttitudeReferenceMessage

In_CommandTorqueMsg

Stores a reference the current torque message from the controller chain,for reference and copy, if it exists. This will change as the software chains change between modes.

[Hidden]
public CommandTorqueMessage? In_CommandTorqueMsg

Field Value

CommandTorqueMessage

In_NavigationAttitudeMsg

Stores a reference the current navigation attitude message from the navigation chain, for reference and copy, if it exists. This will change as the software chains change between modes.

[Hidden]
public NavigationAttitudeMessage? In_NavigationAttitudeMsg

Field Value

NavigationAttitudeMessage

In_NavigationTranslationMsg

Stores a reference the current navigation translation message from the navigation chain, for reference and copy, if it exists. This will change as the software chains change between modes.

[Hidden]
public NavigationTranslationMessage? In_NavigationTranslationMsg

Field Value

NavigationTranslationMessage

Out_AttitudeErrorMsg

Gets the current guidance attitude error message from the pointing chain, if it exists.

public AttitudeErrorMessage? Out_AttitudeErrorMsg

Field Value

AttitudeErrorMessage

Out_AttitudeReferenceMsg

Gets the current guidance attitude reference message from the pointing chain, if it exists.

public AttitudeReferenceMessage? Out_AttitudeReferenceMsg

Field Value

AttitudeReferenceMessage

Out_CommandTorqueMsg

Gets the current torque message from the controller chain, if it exists.

public CommandTorqueMessage? Out_CommandTorqueMsg

Field Value

CommandTorqueMessage

Out_GuidanceChainMsg

This is the output message from the computer software chain, describing the current state of the guidance.

public GuidanceChainMessage? Out_GuidanceChainMsg

Field Value

GuidanceChainMessage

Out_NavigationAttitudeMsg

Gets the current navigation attitude message from the navigation chain, if it exists.

public NavigationAttitudeMessage? Out_NavigationAttitudeMsg

Field Value

NavigationAttitudeMessage

Out_NavigationTranslationMsg

Gets the current navigation translation message from the navigation chain, if it exists.

public NavigationTranslationMessage? Out_NavigationTranslationMsg

Field Value

NavigationTranslationMessage

Sequence

The guidance software chain sequence associated with this particular guidance computer.

[Hidden]
public GuidanceSoftwareChainSequence? Sequence

Field Value

GuidanceSoftwareChainSequence

Properties

ControllerMode

Returns the current controller mode that is being used by the guidance computer.

[Metadata(ContainedIn = "Out_GuidanceChainMsg")]
public GuidanceControllerType ControllerMode { get; set; }

Property Value

GuidanceControllerType

MappingMode

Returns the current mapping mode that is being used by the guidance computer.

[Metadata(ContainedIn = "Out_GuidanceChainMsg")]
public GuidanceMappingType MappingMode { get; set; }

Property Value

GuidanceMappingType

NavigationMode

Returns the current navigation mode that is being used by the guidance computer.

[Metadata(ContainedIn = "Out_GuidanceChainMsg")]
public GuidanceNavigationType NavigationMode { get; set; }

Property Value

GuidanceNavigationType

PointingMode

Returns the current pointing mode that is being used by the guidance computer.

[Metadata(ContainedIn = "Out_GuidanceChainMsg")]
public virtual GuidancePointingType PointingMode { get; set; }

Property Value

GuidancePointingType

Methods

GetGroundPointingMessage()

The configuration for the ground pointing software chain.

public GuidanceGroundPointingMessage GetGroundPointingMessage()

Returns

GuidanceGroundPointingMessage

GetIdleControllerMessage()

Defines the configuration for this software chain.

public GuidanceIdleControllerMessage GetIdleControllerMessage()

Returns

GuidanceIdleControllerMessage

GetInertialPointingMessage()

A reference to the configuration message for the inertial pointing chain.

public GuidanceInertialPointingMessage GetInertialPointingMessage()

Returns

GuidanceInertialPointingMessage

GetMRPControllerMessage()

Defines the configuration for this software chain.

public GuidanceMRPControllerMessage GetMRPControllerMessage()

Returns

GuidanceMRPControllerMessage

GetMagneticTorqueBarMappingMessage()

Defines the configuration for this software chain.

public GuidanceMagneticTorqueBarMappingMessage GetMagneticTorqueBarMappingMessage()

Returns

GuidanceMagneticTorqueBarMappingMessage

GetNadirPointingMessage()

The output configuration message for this particular pointing chain.

public GuidanceNadirPointingMessage GetNadirPointingMessage()

Returns

GuidanceNadirPointingMessage

GetReactionWheelMappingMessage()

Defines the configuration for this software chain.

public GuidanceReactionWheelMappingMessage GetReactionWheelMappingMessage()

Returns

GuidanceReactionWheelMappingMessage

GetRelativePointingMessage()

The relative pointing software chain configuration with all configurations for this particular chain.

public GuidanceRelativePointingMessage GetRelativePointingMessage()

Returns

GuidanceRelativePointingMessage

GetSimpleNavigationMessage()

Defines the configuration for this software chain.

public GuidanceSimpleNavigationMessage GetSimpleNavigationMessage()

Returns

GuidanceSimpleNavigationMessage

GetSunEstimationNavigationMessage()

Defines the configuration for this software chain.

public GuidanceSunEstimationNavigationMessage GetSunEstimationNavigationMessage()

Returns

GuidanceSunEstimationNavigationMessage

GetSunPointingMessage()

The configuration message for the sun pointing software chain

public GuidanceSunPointingMessage GetSunPointingMessage()

Returns

GuidanceSunPointingMessage

GetVelocityPointingMessage()

Defines the configuration for this software chain.

public GuidanceVelocityPointingMessage GetVelocityPointingMessage()

Returns

GuidanceVelocityPointingMessage

LoadSoftware()

Force loads all the software to ensure it is ready to go based on the current modes that have been set.

public void LoadSoftware()

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

SetControllerChain(GuidanceControllerType)

Sets the software controller chain

protected void SetControllerChain(GuidanceControllerType mode)

Parameters

mode GuidanceControllerType

The controller chain mode to set

SetMappingChain(GuidanceMappingType)

Sets the software mapping chain

protected void SetMappingChain(GuidanceMappingType mode)

Parameters

mode GuidanceMappingType

The mapping chain mode to set

SetNavigationChain(GuidanceNavigationType)

Sets the software navigation chain

protected void SetNavigationChain(GuidanceNavigationType mode)

Parameters

mode GuidanceNavigationType

The navigation chain mode to set

SetPointingChain(GuidancePointingType)

Sets the software pointing chain

protected void SetPointingChain(GuidancePointingType mode)

Parameters

mode GuidancePointingType

The pointing chain mode to set

Shutdown()

Shut the computer down safely. Disable all software and set the status to SHUTDOWN.

public override void Shutdown()

Startup()

Start the computer safely. Enable all software and set the status to RUNNING.

public override void Startup()