iufIqPatternListDict.h File Reference

#include <iufHDF5.h>
#include <iufIqPatternList.h>

Go to the source code of this file.

Macros
#define	IUIQPALD_INVALID   (iuiqpald_t) NULL

Typedefs
typedef IufIqPatternListDict *	iuiqpald_t

Functions
iuiqpald_t	iufIqPatternListDictCreate (void)
	Create an empty dictionary for IufPatternList objects. More...
int	iufIqPatternListDictDelete (iuiqpald_t dict)
	Delete the dictionary without deleting its IufPatternList objects. More...
int	iufIqPatternListDictDeepDelete (iuiqpald_t dict)
	Delete the dictionary and its IufIqPatternList objects. More...
char **	iufIqPatternListDictGetKeys (iuiqpald_t dict)
	Return an array of char * containing the keys in the dictionary. More...
int	iufIqPatternListDictCompare (iuiqpald_t reference, iuiqpald_t actual)
	Compare two dictionaries of IufIqPatternList objects. More...
size_t	iufIqPatternListDictGetSize (iuiqpald_t dict)
	Get the number of IufPatternList objects in the dictionary. More...
iuiqpal_t	iufIqPatternListDictGet (iuiqpald_t dict, char *key)
	Get the IufIqPatternList object with label key from the dictionary. More...
int	iufIqPatternListDictSet (iuiqpald_t dict, char *key, iuiqpal_t member)
	Add the IufIqPatternList object with label key to the dictionary. More...

Macro Definition Documentation

IUIQPALD_INVALID

#define IUIQPALD_INVALID   (iuiqpald_t) NULL

Typedef Documentation

iuiqpald_t

typedef IufIqPatternListDict* iuiqpald_t

A dictionary of IufIqPatternList objects. A patternlist typically describes a bmode or doppler driving scheme and since these can be multiplexed in a single acquisition, suchs lists are put in a dictionary.

Function Documentation

iufIqPatternListDictCompare()

int iufIqPatternListDictCompare	(	iuiqpald_t	reference,
		iuiqpald_t	actual
	)

Compare two dictionaries of IufIqPatternList objects.

Returns

Returns IUF_TRUE in case the dictionaries are equal and IUF_FALSE otherwise.

Parameters

reference	The dictionary to compare to
actual	The dictionary to compare with

iufIqPatternListDictCreate()

iuiqpald_t iufIqPatternListDictCreate

(

void

)

Create an empty dictionary for IufPatternList objects.

Returns

Returns the created dictionary or IUIQPALD_INVALID in case of an error.

iufIqPatternListDictDeepDelete()

int iufIqPatternListDictDeepDelete

(

iuiqpald_t

dict

)

Delete the dictionary and its IufIqPatternList objects.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE in case of an error.

Parameters

dict	The dictionary to be deleted

iufIqPatternListDictDelete()

int iufIqPatternListDictDelete

(

iuiqpald_t

dict

)

Delete the dictionary without deleting its IufPatternList objects.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE in case of an invalid argument.

Parameters

dict	The dictionary to be deleted

iufIqPatternListDictGet()

iuiqpal_t iufIqPatternListDictGet	(	iuiqpald_t	dict,
		char *	key
	)

Get the IufIqPatternList object with label key from the dictionary.

Returns

Returns IufIqPatternList key or IUIQPALD_INVALID if it is not found.

Parameters

dict	The dictionary of interest
key	The label of the IufIqPatternList

iufIqPatternListDictGetKeys()

char** iufIqPatternListDictGetKeys

(

iuiqpald_t

dict

)

Return an array of char * containing the keys in the dictionary.

Returns

Returns the keys as char * array

iufIqPatternListDictGetSize()

size_t iufIqPatternListDictGetSize

(

iuiqpald_t

dict

)

Get the number of IufPatternList objects in the dictionary.

Returns

Returns the number of IufPatternList objects or -1 in case of an invalid dictionary.

Parameters

dict	The dictionary of interest

iufIqPatternListDictSet()

int iufIqPatternListDictSet	(	iuiqpald_t	dict,
		char *	key,
		iuiqpal_t	member
	)

Add the IufIqPatternList object with label key to the dictionary.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE in case of an error.

Parameters

dict	The dictionary of interest
key	The label of the IufPatternList
member	The IufPatternList