iufReceiveChannelMapDict.h File Reference

#include <stdio.h>
#include <iufReceiveChannelMap.h>

Go to the source code of this file.

Macros
#define	IURCMD_INVALID   (iurcmd_t) NULL

Typedefs
typedef IufReceiveChannelMapDict *	iurcmd_t

Functions
iurcmd_t	iufReceiveChannelMapDictCreate (void)
	Create an empty dictionary. More...
int	iufReceiveChannelMapDictDelete (iurcmd_t dict)
	Delete a dictionary without deleting the IufReceiveChannelMap objects. More...
int	iufReceiveChannelMapDictDeepDelete (iurcmd_t dict)
	Delete a dictionary and its IufReceiveChannelMap objects. More...
int	iufReceiveChannelMapDictCompare (iurcmd_t reference, iurcmd_t actual)
	Compare two IufReceiveChannelMapDict ojects with each other. More...
size_t	iufReceiveChannelMapDictGetSize (iurcmd_t dict)
	Gets the number of IufReceiveChannelMap objects in the dictionary. More...
iurcm_t	iufReceiveChannelMapDictGet (iurcmd_t dict, char *key)
	Gets the IufReceiveChannelMap with label key from the dictionary. More...
char **	iufReceiveChannelMapDictGetKeys (iurcmd_t dict)
	Get the keys currently available in the dict. More...
int	iufReceiveChannelMapDictSet (iurcmd_t dict, char *key, iurcm_t member)
	Add a IufReceiveChannelMap with label key to the dictionary. More...

Macro Definition Documentation

IURCMD_INVALID

#define IURCMD_INVALID   (iurcmd_t) NULL

Typedef Documentation

iurcmd_t

typedef IufReceiveChannelMapDict* iurcmd_t

A dictionary of IufReceiveChannelMap objects. Typically, create an empty dictionary with iufReceiveChannelMapDictCreate() and add IufReceiveChannelMap objects with iufReceiveChannelMapDictSet().

Function Documentation

iufReceiveChannelMapDictCompare()

int iufReceiveChannelMapDictCompare	(	iurcmd_t	reference,
		iurcmd_t	actual
	)

Compare two IufReceiveChannelMapDict ojects with each other.

Returns

Return 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

iufReceiveChannelMapDictCreate()

iurcmd_t iufReceiveChannelMapDictCreate

(

void

)

Create an empty dictionary.

Returns

returns the created dictionary or IURCMD_INVALID in case of an error.

iufReceiveChannelMapDictDeepDelete()

int iufReceiveChannelMapDictDeepDelete

(

iurcmd_t

dict

)

Delete a dictionary and its IufReceiveChannelMap objects.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE otherwise.

Parameters

dict	the dictionary of interest

iufReceiveChannelMapDictDelete()

int iufReceiveChannelMapDictDelete

(

iurcmd_t

dict

)

Delete a dictionary without deleting the IufReceiveChannelMap objects.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE in case of an invalid argument.

Parameters

dict	the dictionary of interest

iufReceiveChannelMapDictGet()

iurcm_t iufReceiveChannelMapDictGet	(	iurcmd_t	dict,
		char *	key
	)

Gets the IufReceiveChannelMap with label key from the dictionary.

Returns

Returns the requested IufReceiveChannelMap or IURCMD_INVALID in case it could not be found

Parameters

dict	The dictionary of interest
key	The label of the IufReceiveChannelMap

iufReceiveChannelMapDictGetKeys()

char** iufReceiveChannelMapDictGetKeys

(

iurcmd_t

dict

)

Get the keys currently available in the dict.

Returns

array (with size iufTransmitApodizationDictGetSize) of keys.

Parameters

dict	The dictionary of interest

iufReceiveChannelMapDictGetSize()

size_t iufReceiveChannelMapDictGetSize

(

iurcmd_t

dict

)

Gets the number of IufReceiveChannelMap objects in the dictionary.

Returns

Returns the number of IufReceiveChannelMap objects

Parameters

dict	the dictionary of interest

iufReceiveChannelMapDictSet()

int iufReceiveChannelMapDictSet	(	iurcmd_t	dict,
		char *	key,
		iurcm_t	member
	)

Add a IufReceiveChannelMap with label key to the dictionary.

Returns

Returns IUF_E_OK in case of success or IUF_ERR_VALUE in case of an invalid argument.

Parameters

dict	The dictionary of interest
key	The label of the IufReceiveChannelMap that is added
member	The IufReceiveChannelMap