iufReceiveSettings.c File Reference

#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <iuf.h>
#include <iufReceiveSettingsPrivate.h>
#include <iufTGCPrivate.h>

Data Structures
struct	IufReceiveSettings

Functions
iurs_t	iufReceiveSettingsCreateWithoutTGC (float sampleFrequency, int numSamplesPerLine)
iurs_t	iufReceiveSettingsCreate (float sampleFrequency, int numSamplesPerLine, int numTGCentries)
int	iufReceiveSettingsDelete (iurs_t receiveSettings)
	Deletes the IufReceiveSettings and also the TGC function that it might contain. More...
int	iufReceiveSettingsCompare (iurs_t reference, iurs_t actual)
	Compare two receive settings with each other, including their TGC function. More...
iutgc_t	iufReceiveSettingsGetTGC (iurs_t receiveSettings)
	Gets the TGC object of the receive settings. More...
float	iufReceiveSettingsGetSampleFrequency (iurs_t receiveSettings)
	Returns the sampleFrequency setting. More...
int	iufReceiveSettingsGetNumSamplesPerLine (iurs_t receiveSettings)
	Returns the number of samples per line. More...
int	iufReceiveSettingsGetNumTGCentries (iurs_t receiveSettings)
	Gets the number of [time,gain] paira that the TGC has. More...
int	iufReceiveSettingsSave (iurs_t receiveSettings, hid_t handle)
iurs_t	iufReceiveSettingsLoad (hid_t handle)

---

Data Structure Documentation

IufReceiveSettings

struct IufReceiveSettings

Data Fields
int	numSamplesPerLine	length of an acquisition line
float	sampleFrequency	The sampling frequency that was used
iutgc_t	TGC	TimeGainControl points (time,gain)

Function Documentation

iufReceiveSettingsCompare()

int iufReceiveSettingsCompare	(	iurs_t	reference,
		iurs_t	actual
	)

Compare two receive settings with each other, including their TGC function.

Returns

Returns IUF_TRUE when the settings are equal and IUF_FALSE otherwise

Parameters

reference	the receive settings to compare to
actual	the receive settings to compare with

iufReceiveSettingsCreate()

iurs_t iufReceiveSettingsCreate	(	float	sampleFrequency,
		int	numSamplesPerLine,
		int	numTGCentries
	)

Parameters

sampleFrequency	The sampling frequency in Hz
numSamplesPerLine	The number of samples per acquired line
numTGCentries	The size of the TGC function

iufReceiveSettingsCreateWithoutTGC()

iurs_t iufReceiveSettingsCreateWithoutTGC	(	float	sampleFrequency,
		int	numSamplesPerLine
	)

iufReceiveSettingsDelete()

int iufReceiveSettingsDelete

(

iurs_t

receiveSettings

)

Deletes the IufReceiveSettings and also the TGC function that it might contain.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE otherwise

Parameters

receiveSettings

The receive settings of interest.

iufReceiveSettingsGetNumSamplesPerLine()

int iufReceiveSettingsGetNumSamplesPerLine

(

iurs_t

receiveSettings

)

Returns the number of samples per line.

Returns

The number of samples each line has

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetNumTGCentries()

int iufReceiveSettingsGetNumTGCentries

(

iurs_t

receiveSettings

)

Gets the number of [time,gain] paira that the TGC has.

Returns

The number of TGC entries

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetSampleFrequency()

float iufReceiveSettingsGetSampleFrequency

(

iurs_t

receiveSettings

)

Returns the sampleFrequency setting.

Returns

The sample frequency in Hz

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsGetTGC()

iutgc_t iufReceiveSettingsGetTGC

(

iurs_t

receiveSettings

)

Gets the TGC object of the receive settings.

Returns

the IufTGC object

Parameters

receiveSettings

the receive settings of interest

iufReceiveSettingsLoad()

iurs_t iufReceiveSettingsLoad

(

hid_t

handle

)

iufReceiveSettingsSave()

int iufReceiveSettingsSave	(	iurs_t	receiveSettings,
		hid_t	handle
	)