iufReceiveChannelMap.c File Reference

#include <stdlib.h>
#include <string.h>
#include <iuf.h>
#include <iufReceiveChannelMapADT.h>
#include <iufReceiveChannelMapPrivate.h>
#include <math.h>

Functions
iurcm_t	iufReceiveChannelMapCreate (int numChannels)
	Create an empty IufReceiveChannelMap with a size of numChannels. More...
int	iufReceiveChannelMapDelete (iurcm_t channelMap)
	Delete an IufReceiveChannelMap. More...
IUF_BOOL	iufReceiveChannelMapCompare (iurcm_t reference, iurcm_t actual)
	Compare two IufReceiveChannelMap object with each other. More...
int	iufReceiveChannelMapGetNumChannels (iurcm_t channelMap)
	Get the number of channels that the map has. More...
int	iufReceiveChannelMapGetChannel (iurcm_t channelMap, int index)
	Get the index value (the transducer element number) at channelMap mapIdx. More...
int	iufReceiveChannelMapGetNumDelays (iurcm_t channelMap)
	Same as iufReceiveChannelMapGetNumChannels. More...
float	iufReceiveChannelMapGetStartDelay (iurcm_t channelMap, int index)
	Gets the (digitization) delay of each channel. More...
int	iufReceiveChannelMapSetStartDelay (iurcm_t channelMap, int index, float delay)
	Sets the (digitization) delay of a channel [seconds]. If not set the value is 0.0f. More...
int	iufReceiveChannelMapSetChannel (iurcm_t channelMap, int index, int transducerIdx)
	Sets the transducer index for a channel. More...
int	iufReceiveChannelMapSetMap (iurcm_t channelMap, int *map)
	Sets a transducer index for all channels at once. More...
int	iufReceiveChannelMapSave (iurcm_t channelMap, hid_t group_id)
iurcm_t	iufReceiveChannelMapLoad (hid_t group_id)

Function Documentation

iufReceiveChannelMapCompare()

IUF_BOOL iufReceiveChannelMapCompare	(	iurcm_t	reference,
		iurcm_t	actual
	)

Compare two IufReceiveChannelMap object with each other.

Returns

Returns IUF_TRUE in case the two maps are equal and IUF_FALSE otherwise

Parameters

reference	The IufReceiveChannelMap to compare to
actual	The IufReceiveChannelMap to compare with

iufReceiveChannelMapCreate()

iurcm_t iufReceiveChannelMapCreate

(

int

numChannels

)

Create an empty IufReceiveChannelMap with a size of numChannels.

Returns

Returns the created map or IURCM_INVALID in case of an error.

iufReceiveChannelMapDelete()

int iufReceiveChannelMapDelete

(

iurcm_t

channelMap

)

Delete an IufReceiveChannelMap.

Returns

Returns IUF_E_OK if successful or IUF_ERR_VALUE otherwise

Parameters

channelMap

the map of interest

iufReceiveChannelMapGetChannel()

int iufReceiveChannelMapGetChannel	(	iurcm_t	channelMap,
		int	index
	)

Get the index value (the transducer element number) at channelMap mapIdx.

Returns

Returns the index or -1 in case it was not found

Parameters

channelMap	The IufReceiveChannelMap of interest
index	The channel number of the map.

iufReceiveChannelMapGetNumChannels()

int iufReceiveChannelMapGetNumChannels

(

iurcm_t

channelMap

)

Get the number of channels that the map has.

Returns

Returns the map size

Parameters

channelMap

The IufReceiveChannelMap of interest

iufReceiveChannelMapGetNumDelays()

int iufReceiveChannelMapGetNumDelays

(

iurcm_t

channelMap

)

Same as iufReceiveChannelMapGetNumChannels.

Returns

Returns the number of channels which is equal to the number of start delays.

Parameters

channelMap

the IufReceiveChannelMap of interest

iufReceiveChannelMapGetStartDelay()

float iufReceiveChannelMapGetStartDelay	(	iurcm_t	channelMap,
		int	index
	)

Gets the (digitization) delay of each channel.

Returns

Returns the delay value in seconds.

Parameters

channelMap	the IufReceiveChannelMap of interest
index	the channel index

iufReceiveChannelMapLoad()

iurcm_t iufReceiveChannelMapLoad

(

hid_t

group_id

)

iufReceiveChannelMapSave()

int iufReceiveChannelMapSave	(	iurcm_t	channelMap,
		hid_t	group_id
	)

iufReceiveChannelMapSetChannel()

int iufReceiveChannelMapSetChannel	(	iurcm_t	channelMap,
		int	index,
		int	transducerIdx
	)

Sets the transducer index for a channel.

Returns

Returns IUF_E_OK when succesful or -1 in case of an invalid argument.

Parameters

channelMap	the IufReceiveChannelMap of interest
index	the channel index
transducerIdx	the transducer index

iufReceiveChannelMapSetMap()

int iufReceiveChannelMapSetMap	(	iurcm_t	channelMap,
		int *	map
	)

Sets a transducer index for all channels at once.

Returns

Returns IUF_E_OK when succesful or -1 in case of an invalid argument.

Parameters

channelMap	the IufReceiveChannelMap of interest
map	the array of transducer indices.

iufReceiveChannelMapSetStartDelay()

int iufReceiveChannelMapSetStartDelay	(	iurcm_t	channelMap,
		int	index,
		float	delay
	)

Sets the (digitization) delay of a channel [seconds]. If not set the value is 0.0f.

Returns

Returns IUF_E_OK when succesful or -1 in case of an invalid argument.

Parameters

channelMap	the IufReceiveChannelMap of interest
index	the channel index
delay	the channel delay in seconds