iufReceiveSettingsDict.h File Reference

#include <iufHDF5.h>
#include <iufReceiveSettings.h>

Go to the source code of this file.

Macros
#define	IURSD_INVALID   (iursd_t) NULL

Typedefs
typedef IufReceiveSettingsDict *	iursd_t

Functions
iursd_t	iufReceiveSettingsDictCreate (void)
	create an empty dictionary More...
int	iufReceiveSettingsDictDelete (iursd_t dict)
	Delete the dictionary without deleting its IufReceiveSettings. More...
int	iufReceiveSettingsDictDeepDelete (iursd_t dict)
	Delete the dictionary and its IufReceiveSettings. More...
int	iufReceiveSettingsDictCompare (iursd_t reference, iursd_t actual)
	Compare two dictionaries with each other. More...
size_t	iufReceiveSettingsDictGetSize (iursd_t dict)
	Get the number of entries in the dictionary. More...
iurs_t	iufReceiveSettingsDictGet (iursd_t dict, char *key)
	Get the IufReceiveSettings from the dictionary that has the label key. More...
char **	iufReceiveSettingsDictGetKeys (iursd_t dict)
	Get the keys currently available in the dict. More...
int	iufReceiveSettingsDictSet (iursd_t dict, char *key, iurs_t member)
	Get the IufReceiveSettings from the dictionary that has the label key. More...

Macro Definition Documentation

IURSD_INVALID

#define IURSD_INVALID   (iursd_t) NULL

Typedef Documentation

iursd_t

typedef IufReceiveSettingsDict* iursd_t

A dictionary of IufReceiveSettings. Typically, first an empty dictionary is created with iufReceiveSettingsDictCreate() and then IufReceiveSettings are added with iufReceiveSettingsDictSet() or retreived with iufReceiveSettingsDictGet()

Function Documentation

iufReceiveSettingsDictCompare()

int iufReceiveSettingsDictCompare	(	iursd_t	reference,
		iursd_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

iufReceiveSettingsDictCreate()

iursd_t iufReceiveSettingsDictCreate

(

void

)

create an empty dictionary

Returns

Returns the created dictionary or NULL in case of an error

iufReceiveSettingsDictDeepDelete()

int iufReceiveSettingsDictDeepDelete

(

iursd_t

dict

)

Delete the dictionary and its IufReceiveSettings.

Returns

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

Parameters

dict	The dictionary of interest

iufReceiveSettingsDictDelete()

int iufReceiveSettingsDictDelete

(

iursd_t

dict

)

Delete the dictionary without deleting its IufReceiveSettings.

Returns

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

Parameters

dict	The dictionary of interest

iufReceiveSettingsDictGet()

iurs_t iufReceiveSettingsDictGet	(	iursd_t	dict,
		char *	key
	)

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

Returns

Returns the requested IufReceiveSettings or IURS_INVALID in case of an error

Parameters

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

iufReceiveSettingsDictGetKeys()

char** iufReceiveSettingsDictGetKeys

(

iursd_t

dict

)

Get the keys currently available in the dict.

Returns

array (with size iufTransmitApodizationDictGetSize) of keys.

Parameters

dict	The dictionary of interest

iufReceiveSettingsDictGetSize()

size_t iufReceiveSettingsDictGetSize

(

iursd_t

dict

)

Get the number of entries in the dictionary.

Returns

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

Parameters

dict	The dictionary of interest

iufReceiveSettingsDictSet()

int iufReceiveSettingsDictSet	(	iursd_t	dict,
		char *	key,
		iurs_t	member
	)

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

Returns

Returns the requested IufReceiveSettings or IURS_INVALID in case of an error

Parameters

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