iufHistoryNodeList.c File Reference

#include <stdlib.h>
#include <iuf.h>
#include <iufHistoryNodePrivate.h>
#include <iufHistoryNodeListPrivate.h>

Data Structures
struct	IufHistoryNodeList

Functions
iuhnl_t	iufHistoryNodeListCreate (int numHistoryNodes)
	Create an empty list of IufHistoryNode for numHistoryNode nodes. More...
int	iufHistoryNodeListDelete (iuhnl_t list)
	Delete a IufHistoryNodeList and all its entries. More...
int	iufHistoryNodeListCompare (iuhnl_t reference, iuhnl_t actual)
	Compare two IufHistoryNodeList objects with each other. More...
int	iufHistoryNodeListGetSize (iuhnl_t list)
	Get the number of nodes in the IufHistoryNodeList. More...
iuhn_t	iufHistoryNodeListGet (iuhnl_t list, int index)
	Gets the node from the list at index. More...
int	iufHistoryNodeListSet (iuhnl_t list, iuhn_t member, int index)
	Sets the node member in list at index. More...
iuhnl_t	iufHistoryNodeListLoad (hid_t handle, int numHistoryNodes)
IUF_BOOL	iufHistoryNodeListFull (iuhnl_t node)
int	iufHistoryNodeListSave (iuhnl_t node, hid_t handle)

---

Data Structure Documentation

IufHistoryNodeList

struct IufHistoryNodeList

Data Fields
IUF_BOOL	deepDelete
int	numHistoryNodes
iuhn_t *	pHistoryNodes

Function Documentation

iufHistoryNodeListCompare()

int iufHistoryNodeListCompare	(	iuhnl_t	reference,
		iuhnl_t	actual
	)

Compare two IufHistoryNodeList objects with each other.

Returns

Returns IUF_TRUE when the lists are equal and IUF_FALSE otherwise.

Parameters

reference	The IufHistoryNodeList to compare to
actual	The IufHistoryNodeList to compare with

iufHistoryNodeListCreate()

iuhnl_t iufHistoryNodeListCreate

(

int

numHistoryNodes

)

Create an empty list of IufHistoryNode for numHistoryNode nodes.

Returns

Returns the allocated list or IUHNL_INVALID in case of an invalid argument

Parameters

numHistoryNodes

The number of nodes in the list

iufHistoryNodeListDelete()

int iufHistoryNodeListDelete

(

iuhnl_t

list

)

Delete a IufHistoryNodeList and all its entries.

Returns

Returns IUF_E_OK when successful or IUF_ERR_VALUE in case of an error.

Parameters

list	the list to be deleted

iufHistoryNodeListFull()

IUF_BOOL iufHistoryNodeListFull

(

iuhnl_t

node

)

iufHistoryNodeListGet()

iuhn_t iufHistoryNodeListGet	(	iuhnl_t	list,
		int	index
	)

Gets the node from the list at index.

Returns

Returns the IufHistoryNode at index or NULL in case of invalid arguments.

Parameters

list	The IufHistoryNodeList of interest
index	The index of the node in the list

iufHistoryNodeListGetSize()

int iufHistoryNodeListGetSize

(

iuhnl_t

list

)

Get the number of nodes in the IufHistoryNodeList.

Returns

Returns the number of nodes of the list when the lists are equal and IUF_FALSE otherwise.

Parameters

list	The IufHistoryNodeList of interest

iufHistoryNodeListLoad()

iuhnl_t iufHistoryNodeListLoad	(	hid_t	handle,
		int	numHistoryNodes
	)

iufHistoryNodeListSave()

int iufHistoryNodeListSave	(	iuhnl_t	node,
		hid_t	handle
	)

iufHistoryNodeListSet()

int iufHistoryNodeListSet	(	iuhnl_t	list,
		iuhn_t	member,
		int	index
	)

Sets the node member in list at index.

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise.

Parameters

list	The IufHistoryNodeList of interest
member	The IufHistoryNode to set
index	The index in the list