iufPulseDict.h File Reference

#include <iufHDF5.h>
#include <iufPulse.h>

Go to the source code of this file.

Macros
#define	IUPD_INVALID   (iupd_t) NULL

Typedefs
typedef IufPulseDict *	iupd_t

Functions
iupd_t	iufPulseDictCreate (void)
	Create an empty dictionary of IufPulse objects. More...
int	iufPulseDictDelete (iupd_t dict)
	Delete a dictionary without deleting its IufPulse objects. More...
int	iufPulseDictDeepDelete (iupd_t dict)
	Deletes the dictionary and all its IufPulse objects. More...
int	iufPulseDictCompare (iupd_t reference, iupd_t actual)
	Check if two pulse dictionaries are equal. More...
size_t	iufPulseDictGetSize (iupd_t dict)
	Get the number of IufPulse objects in the dictionary. More...
iup_t	iufPulseDictGet (iupd_t list, char *key)
	Get the IufPulse from the dictionary that has label key. More...
char **	iufPulseDictGetKeys (iupd_t dict)
	Get the keys currently available in the dict. More...
int	iufPulseDictSet (iupd_t dict, char *key, iup_t member)
	Add the IufPulse to the dictionary with label key. More...

Macro Definition Documentation

IUPD_INVALID

#define IUPD_INVALID   (iupd_t) NULL

Typedef Documentation

iupd_t

typedef IufPulseDict* iupd_t

A dictionary for pulses. Typically, you first create an empty dictionary with iufPulseDictCreate() and then add one or more IufPulse objects with iufPulseDictSet().

Function Documentation

iufPulseDictCompare()

int iufPulseDictCompare	(	iupd_t	reference,
		iupd_t	actual
	)

Check if two pulse dictionaries are equal.

Returns

Return IUF_TRUE when the two disctionaries are equal and IUF_FALSE otherwise.

Parameters

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

iufPulseDictCreate()

iupd_t iufPulseDictCreate

(

void

)

Create an empty dictionary of IufPulse objects.

Returns

Returns the created object or IUPD_INVALID in case of an error.

iufPulseDictDeepDelete()

int iufPulseDictDeepDelete

(

iupd_t

dict

)

Deletes the dictionary and all its IufPulse objects.

Returns

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

Parameters

dict	The pulse dictionary of interest

iufPulseDictDelete()

int iufPulseDictDelete

(

iupd_t

dict

)

Delete a dictionary without deleting its IufPulse objects.

Returns

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

Parameters

dict	The pulse dictionary of interest

iufPulseDictGet()

iup_t iufPulseDictGet	(	iupd_t	list,
		char *	key
	)

Get the IufPulse from the dictionary that has label key.

Returns

Returns the requested IufPulse or IUPD_INVALID if it was not found.

iufPulseDictGetKeys()

char** iufPulseDictGetKeys

(

iupd_t

dict

)

Get the keys currently available in the dict.

Returns

array (with size iufTransmitApodizationDictGetSize) of keys.

Parameters

dict	The pulse dictionary of interest

iufPulseDictGetSize()

size_t iufPulseDictGetSize

(

iupd_t

dict

)

Get the number of IufPulse objects in the dictionary.

Returns

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

Parameters

dict	The pulse dictionary of interest

iufPulseDictSet()

int iufPulseDictSet	(	iupd_t	dict,
		char *	key,
		iup_t	member
	)

Add the IufPulse to the dictionary with label key.

Returns

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

Parameters

dict	The pulse dictionary of interest
key	The label of the IufPulse
member	The IufPulse