Functions for working with HL_NodeList's. More...

#include "hlhdf_types.h"

Functions
HL_NodeList *	HLNodeList_new (void)
	Creates a new HL_NodeList instance.

void	HLNodeList_free (HL_NodeList *nodelist)
	Releasing all resources associated with this node list including the node list itself.

int	HLNodeList_setFileName (HL_NodeList nodelist, const char filename)
	Sets the filename in the HL_NodeList instance.

char *	HLNodeList_getFileName (HL_NodeList *nodelist)
	Returns the filename of this nodelist.

int	HLNodeList_getNumberOfNodes (HL_NodeList *nodelist)
	Returns the number of nodes that exists in the provided nodelist.

HL_Node *	HLNodeList_getNodeByIndex (HL_NodeList *nodelist, int index)
	Returns the node at the specified index.

void	HLNodeList_markNodes (HL_NodeList *nodelist, const HL_NodeMark mark)
	Marks all nodes in the nodelist with the provided mark.

int	HLNodeList_addNode (HL_NodeList nodelist, HL_Node node)
	Adds a node to the nodelist.

HL_Node *	HLNodeList_getNodeByName (HL_NodeList nodelist, const char nodeName)
	Locates a node called nodeName in the nodelist and returns a pointer to this node.

int	HLNodeList_hasNodeByName (HL_NodeList nodelist, const char nodeName)
	Returns if the nodelist contains a node with the specified name or not.

HL_CompoundTypeDescription *	HLNodeList_findCompoundDescription (HL_NodeList *nodelist, unsigned long objno0, unsigned long objno1)
	Searches the nodelist for any type node, that has got the same object id as objno0 and objno1.

Detailed Description

Functions for working with HL_NodeList's.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Function Documentation

char * HLNodeList_getFileName ( HL_NodeList * nodelist )

Returns the filename of this nodelist.

Parameters

[in] nodelist - the nodelist

Returns: the filename for this nodelist or NULL if no filename is set or failed to allocate memory.

HL_Node * HLNodeList_getNodeByIndex	(	HL_NodeList *	nodelist,
		int	index )

Returns the node at the specified index.

Parameters

[in]	nodelist	- the node list
[in]	index	- the index of the node

Returns: the node if it exists, otherwise NULL. Do not free since it is an internal pointer

int HLNodeList_getNumberOfNodes ( HL_NodeList * nodelist )

Returns the number of nodes that exists in the provided nodelist.

Parameters

[in] nodelist - the node list

int HLNodeList_hasNodeByName	(	HL_NodeList *	nodelist,
		const char *	nodeName )

Returns if the nodelist contains a node with the specified name or not.

Parameters

[in]	nodelist	- the nodelist
[in]	nodeName	- the name of the node that is searched for

void HLNodeList_markNodes	(	HL_NodeList *	nodelist,
		const HL_NodeMark	mark )

Marks all nodes in the nodelist with the provided mark.

Parameters

[in]	nodelist	- the nodelist to be updated.
[in]	mark	- the mark each node should have.

int HLNodeList_setFileName	(	HL_NodeList *	nodelist,
		const char *	filename )

Sets the filename in the HL_NodeList instance.

Parameters

[in]	nodelist	- the nodelist
[in]	filename	- the filename that should be used