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 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.
Msg Variable Name |
Msg Type |
Description |
|---|---|---|
someInMsg |
input msg description |
|
some2InMsg |
input msg description |
|
anotherInMsg |
input msg description |
|
some2OutMsg |
output msg description |
|
someOutMsg |
output msg 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
- Returns
void
-
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
- Returns
void
-
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
- Returns
void
-
struct autoCModuleConfig¶
- #include <autoCModule.h>
This is an auto-created sample C module. The description is included with the module class definition.