iuf2DTransducer.h File Reference

#include <iuf2DTransducerElement.h>

Go to the source code of this file.

Macros
#define	IU2DT_INVALID   (iu2dt_t) NULL

Typedefs
typedef Iuf2DTransducer *	iu2dt_t
	A 2D transducer is described by a name, 2D shape, centerfrequency and a list of elements. A transducer is created first by specifying these parameters with a call to iuf2DTransducerCreate(), followed by setting each of the elements using calls to iuf2DTransducerSetElement() More...

Functions
iu2dt_t	iuf2DTransducerCreate (char *name, IufTransducerShape shape, float centerFrequency, int numElements)
	Constructs the 2D transducer. More...
int	iuf2DTransducerDelete (iu2dt_t transducer)
int	iuf2DTransducerDeepDelete (iu2dt_t transducer)
int	iuf2DTransducerCompare (iu2dt_t reference, iu2dt_t actual)
	Comparing two transducers, return IUF_TRUE if they are equal and IUF_FALSE if they differ or in case of an error. The order of the arguments does no matter. More...
iu2dte_t	iuf2DTransducerGetElement (iu2dt_t transducer, int index)
	Return the elemntIndex -th transducer element from the transducer's element list. /return the requested 2D element from the transducer's element list. More...
int	iuf2DTransducerGetNumElements (iu2dt_t transducer)
	Gets the length of the transducer's element list. /return the size of the element list. More...
int	iuf2DTransducerSetElement (iu2dt_t transducer, int index, iu2dte_t element)
	Set a element in the transducer's element list at position elementIndex /return IUF_ERR_VALUE is case the element can not be set or IUF_E_OK in case of success. More...

Macro Definition Documentation

IU2DT_INVALID

#define IU2DT_INVALID   (iu2dt_t) NULL

Typedef Documentation

iu2dt_t

typedef Iuf2DTransducer* iu2dt_t

A 2D transducer is described by a name, 2D shape, centerfrequency and a list of elements. A transducer is created first by specifying these parameters with a call to iuf2DTransducerCreate(), followed by setting each of the elements using calls to iuf2DTransducerSetElement()

Function Documentation

iuf2DTransducerCompare()

int iuf2DTransducerCompare	(	iu2dt_t	reference,
		iu2dt_t	actual
	)

Comparing two transducers, return IUF_TRUE if they are equal and IUF_FALSE if they differ or in case of an error. The order of the arguments does no matter.

Parameters

reference	one of the 2D transducers
actual	the other 2D transducer

iuf2DTransducerCreate()

iu2dt_t iuf2DTransducerCreate	(	char *	name,
		IufTransducerShape	shape,
		float	centerFrequency,
		int	numElements
	)

Constructs the 2D transducer.

Returns

Returns an allocated 2D tansducer, with uninitialized elements

Parameters

name	The name of the transducer
shape	The 2D shape of the transducer: should be a IUF_LINE or an IUF_CIRCLE
centerFrequency	The operating frequency the transducer
numElements	The number of elements that a transducer contains

iuf2DTransducerDeepDelete()

int iuf2DTransducerDeepDelete

(

iu2dt_t

transducer

)

iuf2DTransducerDelete()

int iuf2DTransducerDelete

(

iu2dt_t

transducer

)

Parameters

transducer

The 2D transducer object that will be deleted

iuf2DTransducerGetElement()

iu2dte_t iuf2DTransducerGetElement	(	iu2dt_t	transducer,
		int	index
	)

Return the elemntIndex -th transducer element from the transducer's element list. /return the requested 2D element from the transducer's element list.

Parameters

transducer	the transducer to compare
index	the element index from the element list

iuf2DTransducerGetNumElements()

int iuf2DTransducerGetNumElements

(

iu2dt_t

transducer

)

Gets the length of the transducer's element list. /return the size of the element list.

Parameters

transducer

the referenced transducer

iuf2DTransducerSetElement()

int iuf2DTransducerSetElement	(	iu2dt_t	transducer,
		int	index,
		iu2dte_t	element
	)

Set a element in the transducer's element list at position elementIndex /return IUF_ERR_VALUE is case the element can not be set or IUF_E_OK in case of success.

Parameters

transducer	the transducer element
index	the position in the element list
element	the transducer element to be set