iufFrame.h File Reference

Go to the source code of this file.

Macros
#define	IUF_INVALID   (iufr_t) NULL

Typedefs
typedef IufFrame *	iufr_t

Functions
iufr_t	iufFrameCreate (char *label, int dataIndex, float time)
	Creates an IufFrame. More...
int	iufFrameDelete (iufr_t frame)
	Delete an IufFrame. More...
int	iufFrameCompare (iufr_t reference, iufr_t actual)
	Compare two IufFrame object with each other. More...
float	iufFrameGetTime (iufr_t frame)
	Gets the timestamp in seconds of a frame. More...
char *	iufFrameGetPatternListLabel (iufr_t frame)
	Gets the patternListLabel of a frame. More...
int	iufFrameGetDataIndex (iufr_t frame)
	Gets the dataIndex of a frame. More...

Macro Definition Documentation

IUF_INVALID

#define IUF_INVALID   (iufr_t) NULL

Typedef Documentation

iufr_t

typedef IufFrame* iufr_t

A frame is reference to a patternList, a reference to data, and a timestamp.

Function Documentation

iufFrameCompare()

int iufFrameCompare	(	iufr_t	reference,
		iufr_t	actual
	)

Compare two IufFrame object with each other.

Returns

Returns IUF_TRUE when the frames are equal and IUF_FALSE otherwise.

Parameters

reference	The IufFrame to compare to
actual	The IufFrame to compare with

iufFrameCreate()

iufr_t iufFrameCreate	(	char *	label,
		int	dataIndex,
		float	time
	)

Creates an IufFrame.

Returns

Returns an IufFrame or IUF_INVALID in case of an error.

Parameters

label	The patternList label this frame refers to, e.g. "bmode"
dataIndex	The offset in the data (frame number?)
time	The timestamp in seconds since the start of the acquisition

iufFrameDelete()

int iufFrameDelete

(

iufr_t

frame

)

Delete an IufFrame.

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE in case of an error.

Parameters

frame

The IufFrame to be deleted

iufFrameGetDataIndex()

int iufFrameGetDataIndex

(

iufr_t

frame

)

Gets the dataIndex of a frame.

Returns

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

Parameters

frame

The IufFrame of interest

iufFrameGetPatternListLabel()

char* iufFrameGetPatternListLabel

(

iufr_t

frame

)

Gets the patternListLabel of a frame.

Returns

Returns the label or NULL in case of an error.

Parameters

frame

The IufFrame of interest

iufFrameGetTime()

float iufFrameGetTime

(

iufr_t

frame

)

Gets the timestamp in seconds of a frame.

Returns

Returns the timestamp in seconds or -1 in case of an error.