iuf3DTransducerElementList.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iuf3DTransducerElementPrivate.h>
#include <iuf3DTransducerElementListPrivate.h>

Data Structures
struct	Iuf3DTransducerElementList

Functions
iu3dtel_t	iuf3DTransducerElementListCreate (int numElements)
	Create an empty list of 3D elements with length num3DTransducerElements. More...
int	iuf3DTransducerElementListDeepDelete (iu3dtel_t list)
	Delete an existing list of elements including all its elements individually. More...
int	iuf3DTransducerElementListDelete (iu3dtel_t list)
	Delete an existing list of elements without deleting the individual elements. More...
int	iuf3DTransducerElementListCompare (iu3dtel_t reference, iu3dtel_t actual)
	Check if two lists are identical. the order of the parameters doesn't matter. More...
int	iuf3DTransducerElementListGetSize (iu3dtel_t list)
	Returns the length of the element list. More...
iu3dte_t	iuf3DTransducerElementListGet (iu3dtel_t list, int index)
	Returns the element from a transducer's element list. More...
int	iuf3DTransducerElementListSet (iu3dtel_t list, iu3dte_t member, int index)
	Sets the 3D element member in the transducer's list at index location index. More...
IUF_BOOL	iuf3DTransducerElementListFull (iu3dtel_t list)
iu3dtel_t	iuf3DTransducerElementListLoad (hid_t handle)
int	iuf3DTransducerElementListSave (iu3dtel_t list, hid_t handle)

---

Data Structure Documentation

Iuf3DTransducerElementList

struct Iuf3DTransducerElementList

Data Fields
IUF_BOOL	deepDelete
int	numElements
iu3dte_t *	p3DTransducerElements

Function Documentation

iuf3DTransducerElementListCompare()

int iuf3DTransducerElementListCompare	(	iu3dtel_t	reference,
		iu3dtel_t	actual
	)

Check if two lists are identical. the order of the parameters 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

iuf3DTransducerElementListCreate()

iu3dtel_t iuf3DTransducerElementListCreate

(

int

numElements

)

Create an empty list of 3D elements with length num3DTransducerElements.

Returns

Returns the created list or IU3DTEL_INVALID in case this failed.

Parameters

numElements

the number of elements that will go in the element list

iuf3DTransducerElementListDeepDelete()

int iuf3DTransducerElementListDeepDelete

(

iu3dtel_t

list

)

Delete an existing list of elements including all its elements individually.

Returns

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

Parameters

list	the list that is to be deleted

iuf3DTransducerElementListDelete()

int iuf3DTransducerElementListDelete

(

iu3dtel_t

list

)

Delete an existing list of elements without deleting the individual elements.

Returns

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

Parameters

list	the list that is to be deleted

iuf3DTransducerElementListFull()

IUF_BOOL iuf3DTransducerElementListFull

(

iu3dtel_t

list

)

iuf3DTransducerElementListGet()

iu3dte_t iuf3DTransducerElementListGet	(	iu3dtel_t	list,
		int	index
	)

Returns the element from a transducer's element list.

Returns

the 3D element index.

Parameters

list	The transducer's element list
index	The index of the element in the list

iuf3DTransducerElementListGetSize()

int iuf3DTransducerElementListGetSize

(

iu3dtel_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 list with elements

iuf3DTransducerElementListLoad()

iu3dtel_t iuf3DTransducerElementListLoad

(

hid_t

handle

)

iuf3DTransducerElementListSave()

int iuf3DTransducerElementListSave	(	iu3dtel_t	list,
		hid_t	handle
	)

iuf3DTransducerElementListSet()

int iuf3DTransducerElementListSet	(	iu3dtel_t	list,
		iu3dte_t	member,
		int	index
	)

Sets the 3D element member in the transducer's list at index location index.

Returns

IUF_E_OK in case of success or IUF_ERR_VALUE in case of invalid parameters.

Parameters

list	The list that will be updated
member	The IufTransducerElement to add
index	The location in he list