iufAcquisition.h File Reference

#include <iufTypes.h>

Go to the source code of this file.

Macros
#define	IUA_INVALID   (iua_t) NULL

Typedefs
typedef IufAcquisition *	iua_t

Functions
iua_t	iufAcquisitionCreate (float speedOfSound, int date, const char *pDescription)
	Create an acquisition object. More...
int	iufAcquisitionDelete (iua_t acquisition)
	Deletes an acquisition object. More...
float	iufAcquisitionGetSpeedOfSound (iua_t acquisition)
	Gets the speed of sound in m/s. More...
int	iufAcquisitionGetDate (iua_t acquisition)
	Gets the date of the acquisition. More...
char *	iufAcquisitionGetDescription (iua_t acquisition)
	Gets the description text of he acquisition. More...
IUF_BOOL	iufAcquisitionCompare (iua_t reference, iua_t actual)
	Compares two acquisitions with each other. More...

Macro Definition Documentation

IUA_INVALID

#define IUA_INVALID   (iua_t) NULL

Typedef Documentation

iua_t

typedef IufAcquisition* iua_t

Meta data to describe an acquisition. Important for Ultrasound processing is to know the speedOfSound in m/s. In addition is requested to report the date of the experiment as an int in jjjjmmdd format together with a pDescription a string describing further acquisition notes.

Function Documentation

iufAcquisitionCompare()

IUF_BOOL iufAcquisitionCompare	(	iua_t	reference,
		iua_t	actual
	)

Compares two acquisitions with each other.

Returns

Returns IUF_TRUE when the objects are equal and IUF_FALSE otherwise.

Parameters

reference	The IufAcquisition to compare to
actual	The IufAcquisition to compare with

iufAcquisitionCreate()

iua_t iufAcquisitionCreate	(	float	speedOfSound,
		int	date,
		const char *	pDescription
	)

Create an acquisition object.

Returns

Returns an acquisition object or IUA_INVALID in case of an error.

Parameters

speedOfSound	speed of sound in m/s */
date	interger concatenation of year-month-day */
pDescription	Acquisition notes */

iufAcquisitionDelete()

int iufAcquisitionDelete

(

iua_t

acquisition

)

Deletes an acquisition object.

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise.

Parameters

acquisition

The IufAcquisition to delete

iufAcquisitionGetDate()

int iufAcquisitionGetDate

(

iua_t

acquisition

)

Gets the date of the acquisition.

Returns

Returns the date or -1 in case of an error.

Parameters

acquisition

The IufAcquisition of interest

iufAcquisitionGetDescription()

char* iufAcquisitionGetDescription

(

iua_t

acquisition

)

Gets the description text of he acquisition.

Returns

Returns the notes or NULL in case of an error.

Parameters

acquisition

The IufAcquisition of interest

iufAcquisitionGetSpeedOfSound()

float iufAcquisitionGetSpeedOfSound

(

iua_t

acquisition

)

Gets the speed of sound in m/s.

Returns

Returns the speed of sound or -1 in case of an error.

Parameters

acquisition

The IufAcquisition of interest