Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
ad_common_utils.h
Go to the documentation of this file.
1/****** NAI AD Common Sample Program Utility Functions ******/
2#ifndef NAI_AD_UTILS_H
3#define NAI_AD_UTILS_H
4
5/* Common Sample Program include files */
6#include "nai_sample_apps/naiapp_common/include/naiapp_boardaccess_menu.h"
7#include "nai_sample_apps/naiapp_common/include/naiapp_boardaccess_query.h"
8#include "nai_sample_apps/naiapp_common/include/naiapp_boardaccess_access.h"
9#include "nai_sample_apps/naiapp_common/include/naiapp_boardaccess_display.h"
10#include "nai_sample_apps/naiapp_common/include/naiapp_boardaccess_utils.h"
11
12/* Buffer Control Options */
18
19/* AD Helper Functions */
20bool_t ADUtils_getInput(uint32_t *inputValue);
21void ADUtils_getModuleIDName(uint32_t modid, char *moduleIDName);
22bool_t ADUtils_validRangeCode(uint32_t modid, uint32_t Range);
23bool_t ADUtils_isGeneration5(uint32_t modid);
24bool_t ADUtils_isGeneration3(uint32_t modid);
25
26/* Handle User Input for Reading FIFO Buffer */
27void ADUtils_getSamplesInFifo(int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t *samplesInFifo);
28void ADUtils_getBufferControls(int32_t cardIndex, int32_t module, int32_t channel, bool_t Buffer_Controls[]);
29void ADUtils_printSamplesInFifo(int32_t cardIndex, int32_t module, int32_t channel, uint32_t samplesToRead, bool_t Buffer_Controls[],
30 const int8_t *fileName);
31
32/* Handle User Input for Range Selection Functions */
33void ADUtils_GetRangePolarityHex(uint32_t cardIndex, int32_t module, naibrd_ad_mode_t mode, naibrd_ad_range_polarity_t* p_rawRangePolarity);
34void ADUtils_GetRangePolarity(uint32_t cardIndex, int32_t module, naibrd_ad_mode_t mode, naibrd_ad_polarity_t* polarity, float64_t *range);
35void ADUtils_printRangeOptions(uint32_t modid, naibrd_ad_mode_t mode);
36void ADUtils_getRangeOptions(uint32_t modid, naibrd_ad_mode_t mode, float64_t** p_ranges, int32_t* p_numRanges);
39
40#endif
ad_buffer_options
Definition ad_common_utils.h:14
@ BUFFER_OPTIONS
Definition ad_common_utils.h:16
@ TIME_STAMP
Definition ad_common_utils.h:15
void ADUtils_getBufferControls(int32_t cardIndex, int32_t module, int32_t channel, bool_t Buffer_Controls[])
bool_t ADUtils_isGeneration5(uint32_t modid)
ADUtils_isGeneration5 checks if the passed modid is a generation 5 AD module.
Definition ad_common_utils.c:200
bool_t ADUtils_getInput(uint32_t *inputValue)
ADUtils_getInput assigns "value" the decimal value the user input.
Definition ad_common_utils.c:82
void ADUtils_printKARangeOptions()
ADUtils_printKARangeOptions() prints to stdout the various range options available for the KA module.
Definition ad_common_utils.c:514
void ADUtils_printSamplesInFifo(int32_t cardIndex, int32_t module, int32_t channel, uint32_t samplesToRead, bool_t Buffer_Controls[], const int8_t *fileName)
void ADUtils_GetRangePolarity(uint32_t cardIndex, int32_t module, naibrd_ad_mode_t mode, naibrd_ad_polarity_t *polarity, float64_t *range)
Definition ad_common_utils.c:297
void ADUtils_printRangeOptions(uint32_t modid, naibrd_ad_mode_t mode)
ADUtils_printRangeOptions prints the range options for the current module.
Definition ad_common_utils.c:374
bool_t ADUtils_isGeneration3(uint32_t modid)
ADUtils_isGeneration3 checks if the passed modid is a generation 3 AD module.
Definition ad_common_utils.c:227
bool_t ADUtils_validRangeCode(uint32_t modid, uint32_t Range)
ADUtils_validRangeCode checks if the user input is equal to one of the AD Module's raw range data cod...
Definition ad_common_utils.c:147
void ADUtils_GetRangePolarityHex(uint32_t cardIndex, int32_t module, naibrd_ad_mode_t mode, naibrd_ad_range_polarity_t *p_rawRangePolarity)
ADUtils_GetRangePolarityHex displays the polarity and range settings available for the ADUtils_GetPol...
Definition ad_common_utils.c:257
void ADUtils_getModuleIDName(uint32_t modid, char *moduleIDName)
ADUtils_getModuleIDName assigns char* moduleIDName the corresponding string value of the current modu...
Definition ad_common_utils.c:114
void ADUtils_getSamplesInFifo(int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t *samplesInFifo)
void ADUtils_getRangeOptions(uint32_t modid, naibrd_ad_mode_t mode, float64_t **p_ranges, int32_t *p_numRanges)
ADUtils_getRangeOptions returns a pointer to an array of [4] containing the current module's range op...
Definition ad_common_utils.c:416
void ADUtils_printC3RangeOptions()
ADUtils_printC3RangeOptions() prints to stdout the various range options available for the C3 module....
Definition ad_common_utils.c:494