iufPatternList.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iufPatternPrivate.h>
#include <iufPatternListPrivate.h>

Data Structures
struct	IufPatternList

Functions
iupal_t	iufPatternListCreate (int numPatterns, iursd_t receiveSettingsDict, iurcmd_t receiveChannelMapDict)
	Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions. More...
int	iufPatternListDeepDelete (iupal_t list)
	Delete the patternList and the individual patterns. More...
int	iufPatternListDelete (iupal_t list)
	Delete the patternList without deleting the individual patterns. More...
int	iufPatternListCompare (iupal_t reference, iupal_t actual)
	Compare two patternLists with each other. More...
int	iufPatternListGetSize (iupal_t list)
	Get the number of patterns in the list. More...
iupa_t	iufPatternListGet (iupal_t list, int index)
	Get the pattern at index from the IufPatternList. More...
IUF_BOOL	iufPatternListValidateDimensions (iupal_t list, iupa_t member)
int	iufPatternListSet (iupal_t list, iupa_t member, int index)
	Set a pattern at index in the IufPatternList. More...
iupal_t	iufPatternListLoad (hid_t handle)
IUF_BOOL	iufPatternListFull (iupal_t list)
int	iufPatternListSave (iupal_t list, hid_t handle)

---

Data Structure Documentation

IufPatternList

struct IufPatternList

Data Fields
IUF_BOOL	deepDelete
IUF_BOOL	loadedFromFile
int	numPatterns
iupa_t *	pPatterns
iurcmd_t	receiveChannelMapDict
iursd_t	receiveSettingsDict

Function Documentation

iufPatternListCompare()

int iufPatternListCompare	(	iupal_t	reference,
		iupal_t	actual
	)

Compare two patternLists with each other.

Returns

Returns IUF_TRUE when the patterns lists are equal and IUF_FALSE otherwise.

Parameters

reference	The IufPatternList to compare to
actual	The IufPatternList to compare with

iufPatternListCreate()

iupal_t iufPatternListCreate	(	int	numPatterns,
		iursd_t	receiveSettingsDict,
		iurcmd_t	receiveChannelMapDict
	)

Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions.

Returns

Returns an empty list for numPattern patterns, or IUPAL_INVALID in case of an error.

Parameters

numPatterns	The number of patterns that will be in the list
receiveSettingsDict	The receiveSettings dictionary
receiveChannelMapDict	The receiveChannelMap dictionary

iufPatternListDeepDelete()

int iufPatternListDeepDelete

(

iupal_t

list

)

Delete the patternList and the individual patterns.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE otherwise.

Parameters

list	The IufPatternList of interest.

iufPatternListDelete()

int iufPatternListDelete

(

iupal_t

list

)

Delete the patternList without deleting the individual patterns.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE in case of an invalid list.

Parameters

list	The IufPatternList of interest.

iufPatternListFull()

IUF_BOOL iufPatternListFull

(

iupal_t

list

)

iufPatternListGet()

iupa_t iufPatternListGet	(	iupal_t	list,
		int	index
	)

Get the pattern at index from the IufPatternList.

Returns

Returns the IufPattern in case of success or IUPAL_INVALID in case of an error.

Parameters

list	The IufPatternList of interest
index	the pattern index

iufPatternListGetSize()

int iufPatternListGetSize

(

iupal_t

list

)

Get the number of patterns in the list.

Returns

Returns the numPattern or -1 in case of an invalid argument.

Parameters

list	The IufPatternList

iufPatternListLoad()

iupal_t iufPatternListLoad

(

hid_t

handle

)

iufPatternListSave()

int iufPatternListSave	(	iupal_t	list,
		hid_t	handle
	)

iufPatternListSet()

int iufPatternListSet	(	iupal_t	list,
		iupa_t	member,
		int	index
	)

Set a pattern at index in the IufPatternList.

Returns

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

Parameters

list	The IufPatternList of interest
member	the IufPattern
index	THe loction of the IufPattern

iufPatternListValidateDimensions()

IUF_BOOL iufPatternListValidateDimensions	(	iupal_t	list,
		iupa_t	member
	)