iuf2DTransducerElementList.h File Reference

#include <iuf2DTransducerElement.h>

Go to the source code of this file.

Macros
#define	IU2DTEL_INVALID   (iu2dtel_t) NULL

Typedefs
typedef Iuf2DTransducerElementList *	iu2dtel_t
	A 2D transducer element list is a list object of 2D transducer elements. Elements are created first with iuf2DTransducerElementCreate(), and then added to a list using iuf2DTransducerSetElement(), after an empty list is created with iuf2DTransducerElementListCreate(). More...

Functions
iu2dtel_t	iuf2DTransducerElementListCreate (int numElements)
	Create an empty list of 2D elements with length num2DTransducerElement. More...
int	iuf2DTransducerElementListDeepDelete (iu2dtel_t list)
int	iuf2DTransducerElementListDelete (iu2dtel_t list)
	Delete an existing list of elements. More...
int	iuf2DTransducerElementListCompare (iu2dtel_t reference, iu2dtel_t actual)
	Check if two lists are identical. the order of the paramters doesn't matter. More...
int	iuf2DTransducerElementListGetSize (iu2dtel_t list)
	Returns the length of the element list. More...
iu2dte_t	iuf2DTransducerElementListGet (iu2dtel_t list, int index)
	Gets the transducer element with the given index. More...
int	iuf2DTransducerElementListSet (iu2dtel_t list, iu2dte_t member, int index)
	Sets the transducer element at the given index in the list. More...

Macro Definition Documentation

IU2DTEL_INVALID

#define IU2DTEL_INVALID   (iu2dtel_t) NULL

Typedef Documentation

iu2dtel_t

typedef Iuf2DTransducerElementList* iu2dtel_t

A 2D transducer element list is a list object of 2D transducer elements. Elements are created first with iuf2DTransducerElementCreate(), and then added to a list using iuf2DTransducerSetElement(), after an empty list is created with iuf2DTransducerElementListCreate().

Function Documentation

iuf2DTransducerElementListCompare()

int iuf2DTransducerElementListCompare	(	iu2dtel_t	reference,
		iu2dtel_t	actual
	)

Check if two lists are identical. the order of the paramters doesn't matter.

Returns

IUF_TRUE in case the list content of the list is th same or IUF_FALSE when they differ.

Parameters

reference	the reference list
actual	the list to be compared

iuf2DTransducerElementListCreate()

iu2dtel_t iuf2DTransducerElementListCreate

(

int

numElements

)

Create an empty list of 2D elements with length num2DTransducerElement.

Returns

Returns the created list or IU2DTEL_INVALID in case this failed.

Parameters

numElements

the number of elements that will go in the element list

iuf2DTransducerElementListDeepDelete()

int iuf2DTransducerElementListDeepDelete

(

iu2dtel_t

list

)

iuf2DTransducerElementListDelete()

int iuf2DTransducerElementListDelete

(

iu2dtel_t

list

)

Delete an existing list of elements.

Returns

IUF_TRUE in case the list is deleted successfully or IUF_ERR_VALUE when something went wrong.

Parameters

list	the list to be deleted

iuf2DTransducerElementListGet()

iu2dte_t iuf2DTransducerElementListGet	(	iu2dtel_t	list,
		int	index
	)

Gets the transducer element with the given index.

Returns

the requested element or NULL in case the parameters are incorrect.

Parameters

list	the transducer's element list
index	the referenced index

iuf2DTransducerElementListGetSize()

int iuf2DTransducerElementListGetSize

(

iu2dtel_t

list

)

Returns the length of the element list.

Returns

the length of the element list or -1 in case of an error.

Parameters

list	the element list of interest

iuf2DTransducerElementListSet()

int iuf2DTransducerElementListSet	(	iu2dtel_t	list,
		iu2dte_t	member,
		int	index
	)

Sets the transducer element at the given index in the list.

Returns

IUF_E_OK when successful or IUF_ERR_VALUE when the function fails.

Parameters

list	The 2D transducer element list
member	The 2D element to set in the list
index	the index in the list to set the element