#include <iufParameterDict.h>

Macros
#define	IUHNL_INVALID (iuhnl_t) NULL

#define	IUHN_INVALID (iuhn_t) NULL

Typedefs
typedef IufHistoryNodeList *	iuhnl_t

typedef IufHistoryNode *	iuhn_t

Functions
iuhn_t	iufHistoryNodeCreate (char *pNodeType)
	Creates a history node of the type described by the string `pNodeType`. More...

int	iufHistoryNodeDelete (iuhn_t historyNode)
	Delete a history node. More...

int	iufHistoryNodeCompareWithId (iuhn_t reference, iuhn_t actual)
	Compares two history nodes with each other, including their Id (so a rerun would be different) More...

int	iufHistoryNodeCompare (iuhn_t reference, iuhn_t actual)
	Compares two history nodes with each other, except their Ids (so could be a rerun) More...

int	iufHistoryNodeGetNumParents (iuhn_t historyNode)
	Gets the number of parents that a node has. More...

int	iufHistoryNodeGetNumParams (iuhn_t historyNode)
	Gets the number of parameters that a node has. More...

char *	iufHistoryNodeGetType (iuhn_t historyNode)
	Gets the label of the node. More...

iuhnl_t	iufHistoryNodeGetParents (iuhn_t historyNode)
	Gets the list of the parent nodes. More...

iupad_t	iufHistoryNodeGetParameters (iuhn_t historyNode)
	Gets the parameter dictionary. More...

int	iufHistoryNodeSetParents (iuhn_t historyNode, iuhnl_t parents)
	Sets the IufHistoryNodeList of a parent nodes. More...

int	iufHistoryNodeSetParameters (iuhn_t historyNode, iupad_t parameterDict)
	Sets the IufParameterDict of a node. More...

Macro Definition Documentation

◆ IUHN_INVALID

#define IUHN_INVALID (iuhn_t) NULL

◆ IUHNL_INVALID

#define IUHNL_INVALID (iuhnl_t) NULL

Typedef Documentation

◆ iuhn_t

typedef IufHistoryNode* iuhn_t

◆ iuhnl_t

typedef IufHistoryNodeList* iuhnl_t

The parents of data objects are recorded in IufHistoryNode objects. Since there can be more than 1, we store them in a list. Typically one knows the number of nodes a file depends on, so the list is created with a predefined fixed size and nodes are set at a specific index.

Function Documentation

◆ iufHistoryNodeCompare()

int iufHistoryNodeCompare	(	iuhn_t	reference,
		iuhn_t	actual
	)

Compares two history nodes with each other, except their Ids (so could be a rerun)

Returns: Returns IUF_TRUE if the nodes are equal and IUF_FALSE otherwise.

Parameters

reference	The node to compare to
actual	The node to compare with

◆ iufHistoryNodeCompareWithId()

int iufHistoryNodeCompareWithId	(	iuhn_t	reference,
		iuhn_t	actual
	)

Compares two history nodes with each other, including their Id (so a rerun would be different)

Returns: Returns IUF_TRUE if the nodes are equal and IUF_FALSE otherwise.

Parameters

reference	The node to compare to
actual	The node to compare with

◆ iufHistoryNodeCreate()

iuhn_t iufHistoryNodeCreate ( char * pNodeType )

Creates a history node of the type described by the string pNodeType.

Returns: It returns the history node when successful or IUHN_INVALID in case the node type was invalid

Parameters

pNodeType The node type description

◆ iufHistoryNodeDelete()

int iufHistoryNodeDelete ( iuhn_t historyNode )

Delete a history node.

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

Parameters

historyNode The node to be deleted

◆ iufHistoryNodeGetNumParams()

int iufHistoryNodeGetNumParams ( iuhn_t historyNode )

Gets the number of parameters that a node has.

Returns: Returns the number of parameters or -1 in case of in error

Parameters