HL-HDF
hlhdf_nodelist.h
Go to the documentation of this file.
1/* --------------------------------------------------------------------
2Copyright (C) 2009 Swedish Meteorological and Hydrological Institute, SMHI,
3
4This file is part of HLHDF.
5
6HLHDF is free software: you can redistribute it and/or modify
7it under the terms of the GNU Lesser General Public License as published by
8the Free Software Foundation, either version 3 of the License, or
9(at your option) any later version.
10
11HLHDF is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU Lesser General Public License for more details.
15
16You should have received a copy of the GNU Lesser General Public License
17along with HLHDF. If not, see <http://www.gnu.org/licenses/>.
18------------------------------------------------------------------------*/
19
26#ifndef HLHDF_NODELIST_H
27#define HLHDF_NODELIST_H
28#include "hlhdf_types.h"
29
36
42void HLNodeList_free(HL_NodeList* nodelist);
43
50int HLNodeList_setFileName(HL_NodeList* nodelist, const char* filename);
51
57char* HLNodeList_getFileName(HL_NodeList* nodelist);
58
65
72HL_Node* HLNodeList_getNodeByIndex(HL_NodeList* nodelist, int index);
73
79void HLNodeList_markNodes(HL_NodeList* nodelist, const HL_NodeMark mark);
80
88int HLNodeList_addNode(HL_NodeList* nodelist, HL_Node* node);
89
98HL_Node* HLNodeList_getNodeByName(HL_NodeList* nodelist,const char* nodeName);
99
106int HLNodeList_hasNodeByName(HL_NodeList* nodelist, const char* nodeName);
107
117 unsigned long objno0,
118 unsigned long objno1);
119
120#endif /* HLHDF_NODELIST_H */
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.
Definition hlhdf_nodelist.c:280
HL_NodeMark
This is an enumeration variable designed to keep track of the status of a given node.
Definition hlhdf_types.h:246
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.
Definition hlhdf_nodelist.c:243
HL_NodeList * HLNodeList_new(void)
Creates a new HL_NodeList instance.
Definition hlhdf_nodelist.c:49
int HLNodeList_addNode(HL_NodeList *nodelist, HL_Node *node)
Adds a node to the nodelist.
Definition hlhdf_nodelist.c:167
void HLNodeList_free(HL_NodeList *nodelist)
Releasing all resources associated with this node list including the node list itself.
Definition hlhdf_nodelist.c:73
HL_Node * HLNodeList_getNodeByIndex(HL_NodeList *nodelist, int index)
Returns the node at the specified index.
Definition hlhdf_nodelist.c:141
int HLNodeList_setFileName(HL_NodeList *nodelist, const char *filename)
Sets the filename in the HL_NodeList instance.
Definition hlhdf_nodelist.c:91
int HLNodeList_getNumberOfNodes(HL_NodeList *nodelist)
Returns the number of nodes that exists in the provided nodelist.
Definition hlhdf_nodelist.c:132
int HLNodeList_hasNodeByName(HL_NodeList *nodelist, const char *nodeName)
Returns if the nodelist contains a node with the specified name or not.
Definition hlhdf_nodelist.c:262
char * HLNodeList_getFileName(HL_NodeList *nodelist)
Returns the filename of this nodelist.
Definition hlhdf_nodelist.c:114
void HLNodeList_markNodes(HL_NodeList *nodelist, const HL_NodeMark mark)
Marks all nodes in the nodelist with the provided mark.
Definition hlhdf_nodelist.c:153
Type definitions that are used in HLHDF.
This type is a list of HL_CompoundTypeAttributes.
Definition hlhdf_types.h:276
Represents a HDF5 file.
Definition hlhdf_nodelist.c:39
Represents a HDF5 object/attribute/reference/...
Definition hlhdf_node.c:40