iuf3DTransducerElement.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iuf3DSizePrivate.h>
#include <iufPositionPrivate.h>
#include <iuf3DAnglePrivate.h>
#include <iufTransducerElementPrivate.h>
#include <iuf3DTransducerElementPrivate.h>

Data Structures
struct	Iuf3DTransducerElement

Functions
iu3dte_t	iuf3DTransducerElementCreate (iu3dp_t pos, iu3da_t ang, iu3ds_t siz)
	Creates a 3D transducer element that is decribed by a 3D position, a 3D angle (theta and phi) and a 3D size. More...
int	iuf3DTransducerElementDeepDelete (iu3dte_t element)
	Removes the 3D element object and its sub-objects (position, angle and size) More...
int	iuf3DTransducerElementDelete (iu3dte_t element)
	Removes the 3D element object without deleting its sub-objects (position, angle and size) More...
int	iuf3DTransducerElementCompare (iu3dte_t reference, iu3dte_t actual)
	Compares the values of 2 transducer elements. the order of the arguments don't matter. More...
int	iuf3DTransducerElementSave (iu3dte_t element, hid_t handle)
iu3dte_t	iuf3DTransducerElementLoad (hid_t handle)
iu3dp_t	iuf3DTransducerElementGetPosition (iu3dte_t element)
	returns the 3D position of the iuf2DTransducerElement. More...
iu3da_t	iuf3DTransducerElementGetAngle (iu3dte_t element)
	returns the angles (theta,phi) of the iuf2DTransducerElement. More...
iu3ds_t	iuf3DTransducerElementGetSize (iu3dte_t element)
	returns the 3D size of the iuf2DTransducerElement. More...

---

Data Structure Documentation

Iuf3DTransducerElement

struct Iuf3DTransducerElement

Data Fields
iu3da_t	angle	orientation of the elements
IUF_BOOL	deepDelete
iu3dp_t	position	3D Location of the element
iu3ds_t	size	size of the element

Function Documentation

iuf3DTransducerElementCompare()

int iuf3DTransducerElementCompare	(	iu3dte_t	reference,
		iu3dte_t	actual
	)

Compares the values of 2 transducer elements. the order of the arguments don't matter.

Returns

IUF_FALSE in case the elements are different and IUF_TRUE when the element are identical.

Parameters

reference	The transducer to compare to
actual	The transducer to compare with

iuf3DTransducerElementCreate()

iu3dte_t iuf3DTransducerElementCreate	(	iu3dp_t	pos,
		iu3da_t	ang,
		iu3ds_t	siz
	)

Creates a 3D transducer element that is decribed by a 3D position, a 3D angle (theta and phi) and a 3D size.

Returns

returns the created element or IU2DTE_INVALID in case of invalid parameters.

Parameters

pos	the 3D position (x,y,z) in meters
ang	the angle over the y-axis and x ais in radians of the element
siz	the size (sx,sy, sz) in meters of the element

iuf3DTransducerElementDeepDelete()

int iuf3DTransducerElementDeepDelete

(

iu3dte_t

element

)

Removes the 3D element object and its sub-objects (position, angle and size)

Returns

IUF_ERR_VALUE in case something went wrong or IUF_TRUE when the element has been successfully deleted.

Parameters

element

the 3D transducer object to be deleted

iuf3DTransducerElementDelete()

int iuf3DTransducerElementDelete

(

iu3dte_t

element

)

Removes the 3D element object without deleting its sub-objects (position, angle and size)

Returns

IUF_ERR_VALUE in case something went wrong or IUF_TRUE when the element has been successfully deleted.

Parameters

element

the 3D transducer object to be deleted

iuf3DTransducerElementGetAngle()

iu3da_t iuf3DTransducerElementGetAngle

(

iu3dte_t

element

)

returns the angles (theta,phi) of the iuf2DTransducerElement.

Returns

the angles of the iuf3DTransducerElement (theta, phi) in radians.

Parameters

element

The transducer element that has the requested angles.

iuf3DTransducerElementGetPosition()

iu3dp_t iuf3DTransducerElementGetPosition

(

iu3dte_t

element

)

returns the 3D position of the iuf2DTransducerElement.

Returns

the 3D position of the iuf3DTransducerElement (x,y,z) in meters.

Parameters

element

The transducer element that has the requested position.

iuf3DTransducerElementGetSize()

iu3ds_t iuf3DTransducerElementGetSize

(

iu3dte_t

element

)

returns the 3D size of the iuf2DTransducerElement.

Returns

the 3D size of the iuf3DTransducerElement (sx,sy,sz) in meters.

Parameters

element

The transducer element that has the requested size.

iuf3DTransducerElementLoad()

iu3dte_t iuf3DTransducerElementLoad

(

hid_t

handle

)

iuf3DTransducerElementSave()

int iuf3DTransducerElementSave	(	iu3dte_t	element,
		hid_t	handle
	)