Module: sunlineEphem¶

Executive Summary¶

This module computes an ephemeris-based sunline heading.

More information can be found in the PDF Description

Message Connection Descriptions¶

The following table lists all the module input and output messages. The module msg connection is set by the user from python. The msg type contains a link to the message structure definition, while the description provides information on what this message is used for.

Module I/O Messages¶
Msg Variable Name	Msg Type	Description
navStateOutMsg	NavAttMsgPayload	name of the navigation output message containing the estimated states
sunPositionInMsg	EphemerisMsgPayload	name of the sun ephemeris input message
scPositionInMsg	NavTransMsgPayload	name of the spacecraft ephemeris input message
scAttitudeInMsg	NavAttMsgPayload	name of the spacecraft attitude input message

Functions

void SelfInit_sunlineEphem(sunlineEphemConfig *configData, int64_t moduleID)¶

This method sets up the module output message of type NavAttMsgPayload

Parameters

configData – The configuration data associated with this module
moduleID – The module identifier

Returns

void

void Update_sunlineEphem(sunlineEphemConfig *configData, uint64_t callTime, int64_t moduleID)¶

Updates the sun heading based on ephemeris data. Returns the heading as a unit vector in the body frame.

Parameters

configData – The configuration data associated with the module
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The module identifier

Returns

void

void Reset_sunlineEphem(sunlineEphemConfig *configData, uint64_t callTime, int64_t moduleID)¶

This method performs a complete reset of the module. Local module variables that retain time varying states between function calls are reset to their default values.

Parameters

configData – The configuration data associated with the module
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The module identifier

Returns

void

struct sunlineEphemConfig¶

#include <sunlineEphem.h>

Top level structure for the sub-module routines.

Public Members

NavAttMsg_C navStateOutMsg¶: The name of the output message

EphemerisMsg_C sunPositionInMsg¶: The name of the sun ephemeris input message.

NavTransMsg_C scPositionInMsg¶: The name of the spacecraft ephemeris input message.

NavAttMsg_C scAttitudeInMsg¶: The name of the spacecraft attitude input message.

BSKLogger *bskLogger¶: BSK Logging.