iufDemodulationDict.h File Reference

#include <iufHDF5.h>
#include <iufDemodulation.h>

Go to the source code of this file.

Macros
#define	IUDMD_INVALID   (iudmd_t) NULL

Typedefs
typedef IufDemodulationDict *	iudmd_t

Functions
iudmd_t	iufDemodulationDictCreate (void)
	create an empty dictionary More...
int	iufDemodulationDictDelete (iudmd_t dict)
	Delete the dictionary without deleting its IufDemodulation. More...
int	iufDemodulationDictDeepDelete (iudmd_t dict)
	Delete the dictionary and its IufDemodulation. More...
int	iufDemodulationDictCompare (iudmd_t reference, iudmd_t actual)
	Compare two dictionaries with each other. More...
size_t	iufDemodulationDictGetSize (iudmd_t dict)
	Get the number of entries in the dictionary. More...
iudm_t	iufDemodulationDictGet (iudmd_t dict, char *key)
	Get the IufDemodulation from the dictionary that has the label key. More...
char **	iufDemodulationDictGetKeys (iudmd_t dict)
	Get the IufPatternList object with label key from the dictionary. More...
int	iufDemodulationDictSet (iudmd_t dict, char *key, iudm_t member)
	Get the IufDemodulation from the dictionary that has the label key. More...

Macro Definition Documentation

IUDMD_INVALID

#define IUDMD_INVALID   (iudmd_t) NULL

Typedef Documentation

iudmd_t

typedef IufDemodulationDict* iudmd_t

A dictionary of IufDemodulation. Typically, first an empty dictionary is created with iufDemodulationDictCreate() and then IufDemodulation are added with iufDemodulationDictSet() or retreived with iufDemodulationDictGet()

Function Documentation

iufDemodulationDictCompare()

int iufDemodulationDictCompare	(	iudmd_t	reference,
		iudmd_t	actual
	)

Compare two dictionaries with each other.

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

iufDemodulationDictCreate()

iudmd_t iufDemodulationDictCreate

(

void

)

create an empty dictionary

Returns

Returns the created dictionary or NULL in case of an error

iufDemodulationDictDeepDelete()

int iufDemodulationDictDeepDelete

(

iudmd_t

dict

)

Delete the dictionary and its IufDemodulation.

Returns

IUF_E_OK in case of success and IUF_ERR_VALUE in case of an error.

Parameters

dict	The dictionary of interest

iufDemodulationDictDelete()

int iufDemodulationDictDelete

(

iudmd_t

dict

)

Delete the dictionary without deleting its IufDemodulation.

Returns

IUF_E_OK in case of success and IUF_ERR_VALUE in case of an invalid argument.

Parameters

dict	The dictionary of interest

iufDemodulationDictGet()

iudm_t iufDemodulationDictGet	(	iudmd_t	dict,
		char *	key
	)

Get the IufDemodulation from the dictionary that has the label key.

Returns

Returns the requested IufDemodulation or IURS_INVALID in case of an error

Parameters

dict	The dictionary of interest
key	The label of the demodulation to return

iufDemodulationDictGetKeys()

char** iufDemodulationDictGetKeys

(

iudmd_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

iufDemodulationDictGetSize()

size_t iufDemodulationDictGetSize

(

iudmd_t

dict

)

Get the number of entries in the dictionary.

Returns

Returns the number of IufDemodulation of the dictionary, or -1 in case of an error.

Parameters

dict	The dictionary of interest

iufDemodulationDictSet()

int iufDemodulationDictSet	(	iudmd_t	dict,
		char *	key,
		iudm_t	member
	)

Get the IufDemodulation from the dictionary that has the label key.

Returns

Returns the requested IufDemodulation or IURS_INVALID in case of an error

Parameters

dict	The dictionary of interest
key	The label of the IufDemodulation that to be added
member	The IufDemodulation object