ad_common_utils.h File Reference

Go to the source code of this file.

Enumerations
enum	ad_buffer_options { TIME_STAMP , BUFFER_OPTIONS }

Functions
bool_t	ADUtils_getInput (uint32_t *inputValue)
	ADUtils_getInput assigns "value" the decimal value the user input.
void	ADUtils_getModuleIDName (uint32_t modid, char *moduleIDName)
	ADUtils_getModuleIDName assigns char* moduleIDName the corresponding string value of the current module's name.
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 codes. Returns NAI_TRUE if a valid raw data code was entered.
bool_t	ADUtils_isGeneration5 (uint32_t modid)
	ADUtils_isGeneration5 checks if the passed modid is a generation 5 AD module.
bool_t	ADUtils_isGeneration3 (uint32_t modid)
	ADUtils_isGeneration3 checks if the passed modid is a generation 3 AD module.
void	ADUtils_getSamplesInFifo (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t *samplesInFifo)
void	ADUtils_getBufferControls (int32_t cardIndex, int32_t module, int32_t channel, bool_t Buffer_Controls[])
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_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_GetPolarityRange and handles the user input.
void	ADUtils_GetRangePolarity (uint32_t cardIndex, int32_t module, naibrd_ad_mode_t mode, naibrd_ad_polarity_t *polarity, float64_t *range)
void	ADUtils_printRangeOptions (uint32_t modid, naibrd_ad_mode_t mode)
	ADUtils_printRangeOptions prints the range options for the current module.
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 options.
void	ADUtils_printC3RangeOptions ()
	ADUtils_printC3RangeOptions() prints to stdout the various range options available for the C3 module. Can have its range set up to 2.5V for 25mA full scale, unipolar only.
void	ADUtils_printKARangeOptions ()
	ADUtils_printKARangeOptions() prints to stdout the various range options available for the KA module.

Enumeration Type Documentation

ad_buffer_options

enum ad_buffer_options

Enumerator
TIME_STAMP
BUFFER_OPTIONS

Function Documentation

ADUtils_getBufferControls()

void ADUtils_getBufferControls	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	Buffer_Controls[] )

ADUtils_getInput()

bool_t ADUtils_getInput

(

uint32_t *

inputValue

)

ADUtils_getInput assigns "value" the decimal value the user input.

ADUtils_getModuleIDName()

void ADUtils_getModuleIDName	(	uint32_t	modid,
		char *	moduleIDName )

ADUtils_getModuleIDName assigns char* moduleIDName the corresponding string value of the current module's name.

ADUtils_getRangeOptions()

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 options.

ADUtils_GetRangePolarity()

void ADUtils_GetRangePolarity	(	uint32_t	cardIndex,
		int32_t	module,
		naibrd_ad_mode_t	mode,
		naibrd_ad_polarity_t *	polarity,
		float64_t *	range )

ADUtils_GetRangePolarityHex()

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_GetPolarityRange and handles the user input.

ADUtils_getSamplesInFifo()

void ADUtils_getSamplesInFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	count,
		uint32_t *	samplesInFifo )

ADUtils_isGeneration3()

bool_t ADUtils_isGeneration3

(

uint32_t

modid

)

ADUtils_isGeneration3 checks if the passed modid is a generation 3 AD module.

ADUtils_isGeneration5()

bool_t ADUtils_isGeneration5

(

uint32_t

modid

)

ADUtils_isGeneration5 checks if the passed modid is a generation 5 AD module.

ADUtils_printC3RangeOptions()

void ADUtils_printC3RangeOptions

(

)

ADUtils_printC3RangeOptions() prints to stdout the various range options available for the C3 module. Can have its range set up to 2.5V for 25mA full scale, unipolar only.

ADUtils_printKARangeOptions()

void ADUtils_printKARangeOptions

(

)

ADUtils_printKARangeOptions() prints to stdout the various range options available for the KA module.

ADUtils_printRangeOptions()

void ADUtils_printRangeOptions	(	uint32_t	modid,
		naibrd_ad_mode_t	mode )

ADUtils_printRangeOptions prints the range options for the current module.

ADUtils_printSamplesInFifo()

void ADUtils_printSamplesInFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	samplesToRead,
		bool_t	Buffer_Controls[],
		const int8_t *	fileName )

ADUtils_validRangeCode()

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 codes. Returns NAI_TRUE if a valid raw data code was entered.