C Module: autoCModule

Executive Summary

This is an auto-created sample C module. The description is included with the module class definition

Message Connection Descriptions

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

autoCModule module input and output messages

Module I/O Messages

Msg Variable Name

Msg Type

Description

someInMsg

AttRefMsgPayload

Input message description.

some2InMsg

AttRefMsgPayload

Input message description.

anotherInMsg

CSSConfigMsgPayload

Input message description.

some2OutMsg

AttRefMsgPayload

Output message description.

someOutMsg

SCStatesMsgPayload

Output message description.

Functions

void SelfInit_autoCModule(autoCModuleConfig *configData, int64_t moduleID)

This method initializes the output messages for this module.

Parameters:

  • configData – The configuration data associated with this module

  • moduleID – The module identifier

void Update_autoCModule(autoCModuleConfig *configData, uint64_t callTime, int64_t moduleID)

Add a description of what this main Update() routine does for this module

Parameters:

  • configData – The configuration data associated with the module

  • callTime – The clock time at which the function was called (nanoseconds)

  • moduleID – The module identifier

void Reset_autoCModule(autoCModuleConfig *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. Check if required input messages are connected.

Parameters:

  • configData – The configuration data associated with the module

  • callTime – [ns] time the method is called

  • moduleID – The module identifier

struct autoCModuleConfig
#include <autoCModule.h>

This is an auto-created sample C module. The description is included with the module class definition.

Public Members

AttRefMsg_C someInMsg

Input message description.

AttRefMsg_C some2InMsg

Input message description.

CSSConfigMsg_C anotherInMsg

Input message description.

AttRefMsg_C some2OutMsg

Output message description.

SCStatesMsg_C someOutMsg

Output message description.

double varDouble

[units] variable description

int varInt

[units] variable description

BSKLogger *bskLogger

BSK Logging.