iufIqPatternList.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iufIqPatternListADT.h>
#include <iufIqPatternPrivate.h>
#include <iufIqPatternListPrivate.h>

Functions
iuiqpal_t	iufIqPatternListCreate (int numPatterns, iudmd_t demodulationDict, iurcmd_t receiveChannelMapDict)
	Create a patternList of size numPattern. Using the IufReceiveSettingsDict and IufReceiveChannelMapDict to set the data dimensions. More...
int	iufIqPatternListDeepDelete (iuiqpal_t list)
	Delete the patternList and the individual patterns. More...
int	iufIqPatternListDelete (iuiqpal_t list)
	Delete the IQ patternList without deleting the individual patterns. More...
int	iufIqPatternListCompare (iuiqpal_t reference, iuiqpal_t actual)
	Compare two IQ patternLists with each other. More...
int	iufIqPatternListGetSize (iuiqpal_t list)
	Get the number of patterns in the list. More...
iuiqpa_t	iufIqPatternListGet (iuiqpal_t list, int index)
	Get the pattern at index from the IufPatternList. More...
IUF_BOOL	iufIqPatternListValidateDimensions (iuiqpal_t list, iuiqpa_t member)
int	iufIqPatternListSet (iuiqpal_t list, iuiqpa_t member, int index)
	Set a pattern at index in the IufPatternList. More...
iuiqpal_t	iufIqPatternListLoad (hid_t handle)
IUF_BOOL	iufIqPatternListFull (iuiqpal_t list)
int	iufIqPatternListSave (iuiqpal_t list, hid_t handle)

Function Documentation

iufIqPatternListCompare()

int iufIqPatternListCompare	(	iuiqpal_t	reference,
		iuiqpal_t	actual
	)

Compare two IQ 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

iufIqPatternListCreate()

iuiqpal_t iufIqPatternListCreate	(	int	numPatterns,
		iudmd_t	demodulationDict,
		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
demodulationDict	The demodulation dictionary
receiveChannelMapDict	The receiveChannelMap dictionary

iufIqPatternListDeepDelete()

int iufIqPatternListDeepDelete

(

iuiqpal_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.

iufIqPatternListDelete()

int iufIqPatternListDelete

(

iuiqpal_t

list

)

Delete the IQ 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.

iufIqPatternListFull()

IUF_BOOL iufIqPatternListFull

(

iuiqpal_t

list

)

iufIqPatternListGet()

iuiqpa_t iufIqPatternListGet	(	iuiqpal_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 IufIqPatternList of interest
index	the pattern index

iufIqPatternListGetSize()

int iufIqPatternListGetSize

(

iuiqpal_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

iufIqPatternListLoad()

iuiqpal_t iufIqPatternListLoad

(

hid_t

handle

)

iufIqPatternListSave()

int iufIqPatternListSave	(	iuiqpal_t	list,
		hid_t	handle
	)

iufIqPatternListSet()

int iufIqPatternListSet	(	iuiqpal_t	list,
		iuiqpa_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 IufIqPatternList of interest
member	the IufIqPattern
index	THe loction of the IufPattern

iufIqPatternListValidateDimensions()

IUF_BOOL iufIqPatternListValidateDimensions	(	iuiqpal_t	list,
		iuiqpa_t	member
	)