iufPatternListDict.h File Reference

#include <iufHDF5.h>
#include <iufPatternList.h>

Go to the source code of this file.

Macros
#define	IUPALD_INVALID   (iupald_t) NULL

Typedefs
typedef IufPatternListDict *	iupald_t

Functions
iupald_t	iufPatternListDictCreate (void)
	Create an empty dictionary for IufPatternList objects. More...
int	iufPatternListDictDelete (iupald_t dict)
	Delete the dictionary without deleting its IufPatternList objects. More...
int	iufPatternListDictDeepDelete (iupald_t dict)
	Delete the dictionary and its IufPatternList objects. More...
int	iufPatternListDictCompare (iupald_t reference, iupald_t actual)
	Compare two dictionaries of IufPatternList objects. More...
size_t	iufPatternListDictGetSize (iupald_t dict)
	Get the number of IufPatternList objects in the dictionary. More...
iupal_t	iufPatternListDictGet (iupald_t dict, char *key)
	Get the IufPatternList object with label key from the dictionary. More...
char **	iufPatternListDictGetKeys (iupald_t dict)
	Get the IufPatternList object with label key from the dictionary. More...
int	iufPatternListDictSet (iupald_t dict, char *key, iupal_t member)
	Add the IufPatternList object with label key to the dictionary. More...

Macro Definition Documentation

IUPALD_INVALID

#define IUPALD_INVALID   (iupald_t) NULL

Typedef Documentation

iupald_t

typedef IufPatternListDict* iupald_t

A dictionary of IufPatternList 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

iufPatternListDictCompare()

int iufPatternListDictCompare	(	iupald_t	reference,
		iupald_t	actual
	)

Compare two dictionaries of IufPatternList 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

iufPatternListDictCreate()

iupald_t iufPatternListDictCreate

(

void

)

Create an empty dictionary for IufPatternList objects.

Returns

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

iufPatternListDictDeepDelete()

int iufPatternListDictDeepDelete

(

iupald_t

dict

)

Delete the dictionary and its IufPatternList 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

iufPatternListDictDelete()

int iufPatternListDictDelete

(

iupald_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

iufPatternListDictGet()

iupal_t iufPatternListDictGet	(	iupald_t	dict,
		char *	key
	)

Get the IufPatternList object with label key from the dictionary.

Returns

Returns IufPatternList key or IUPALD_INVALID if it is not found.

Parameters

dict	The dictionary of interest
key	The label of the IufPatternList

iufPatternListDictGetKeys()

char** iufPatternListDictGetKeys

(

iupald_t

dict

)

Get the IufPatternList object with label key from the dictionary.

Returns

Returns IufPatternList key or IUPALD_INVALID if it is not found.

Parameters

dict	The dictionary of interest

iufPatternListDictGetSize()

size_t iufPatternListDictGetSize

(

iupald_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

iufPatternListDictSet()

int iufPatternListDictSet	(	iupald_t	dict,
		char *	key,
		iupal_t	member
	)

Add the IufPatternList 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