iufParameterDict.h File Reference

Go to the source code of this file.

Macros
#define	IUPAD_INVALID   (iupad_t) NULL

Typedefs
typedef IufParameterDict *	iupad_t

Functions
iupad_t	iufParameterDictCreate (void)
	Creates an empty paramter dictionary. More...
int	iufParameterDictDelete (iupad_t dict)
	Delete the paramter dictionary including all its content. More...
int	iufParameterDictCompare (iupad_t reference, iupad_t actual)
	Checks if two IufParameterDict objects are equal. More...
size_t	iufParameterDictGetSize (iupad_t dict)
	Gets the number of parameter entries in the dictionary. More...
char *	iufParameterDictGet (iupad_t dict, char *key)
	Gets the value of parameter key from the dictionary. More...
char **	iufParameterDictGetKeys (iupad_t dict)
	Get the keys currently available in the dict. More...
int	iufParameterDictSet (iupad_t dict, char *key, char *value)
	Add a {key,value} pair to the dictionary. /return Returns IUF_E_OK when successful and IUF_ERR_VALUE in case of invalid paramters. More...

Macro Definition Documentation

IUPAD_INVALID

#define IUPAD_INVALID   (iupad_t) NULL

Typedef Documentation

iupad_t

typedef IufParameterDict* iupad_t

Simple parameters {key, value} string pairs are contained in a dictionary to be used as algorithm arguments. Typically, first create an empty dictionary and then add {key,value} pairs with iufParameterDictSet()

Function Documentation

iufParameterDictCompare()

int iufParameterDictCompare	(	iupad_t	reference,
		iupad_t	actual
	)

Checks if two IufParameterDict objects are equal.

Returns

Returns IUF_TRUE if both IufParameterDict objects are equal and IUF_FALSE otherwise

Parameters

reference	The IufParameterDict to compare to
actual	The IufParameterDict to compare with

iufParameterDictCreate()

iupad_t iufParameterDictCreate

(

void

)

Creates an empty paramter dictionary.

Returns

Returns the created dictionary or IUPAD_INVALID in case of an error

iufParameterDictDelete()

int iufParameterDictDelete

(

iupad_t

dict

)

Delete the paramter dictionary including all its content.

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE in case the dictionary is invalid.

Parameters

dict	the IufParameterDict to be deleted

iufParameterDictGet()

char* iufParameterDictGet	(	iupad_t	dict,
		char *	key
	)

Gets the value of parameter key from the dictionary.

Returns

Returns value of parameters key or NULL in case it could not be found.

Parameters

dict	The IufParameterDict of interest
key	The parameter to search for

iufParameterDictGetKeys()

char** iufParameterDictGetKeys

(

iupad_t

dict

)

Get the keys currently available in the dict.

Returns

array (with size iufTransmitApodizationDictGetSize) of keys.

Parameters

dict	The IufParameterDict of interest

iufParameterDictGetSize()

size_t iufParameterDictGetSize

(

iupad_t

dict

)

Gets the number of parameter entries in the dictionary.

Returns

Returns the number of parameters or -1 in case of an error.

Parameters

dict	The IufParameterDict of interest

iufParameterDictSet()

int iufParameterDictSet	(	iupad_t	dict,
		char *	key,
		char *	value
	)

Add a {key,value} pair to the dictionary. /return Returns IUF_E_OK when successful and IUF_ERR_VALUE in case of invalid paramters.

Parameters

dict	The IufParameterDict of interest
key	The parameter name
value	The parameter value