Flute acoustics: measurement, modelling and design - School of ...

284 APPENDIX B. PROGRAM LISTINGS
int parseUpstream(xmlDocPtr doc, xmlNodePtr node, Vector* bore,
double* flange);
/*
Creates a TerminalSection of BoreSegments from data in the xml
document.
Parameters:
doc: the parsed xmlDocPtr of the XML document.
node: the current node.
bore: to be initialised with data in doc.
flange: the impedance condition at the end of the pipe.
Returns:
1 if all parameters are valid.
0 otherwise.
*/
int parseDownstream(xmlDocPtr doc, xmlNodePtr node, Vector* bore,
Vector* cells, double* flange);
/*
Creates a Vector of BoreSegments and a Vector of UnitCells
from data in the xml document.
Parameters:
doc: the parsed xmlDocPtr of the XML document.
node: the current node.
bore: to be initialised with data in doc.
cells: to be initialised with data in doc.
flange: the impedance condition at the end of the pipe.
Returns:
1 if all parameters are valid.
0 otherwise.
*/
int parseBore(xmlDocPtr doc, xmlNodePtr node, BoreSegment* s);
/*
Creates a BoreSegment struct from data in the xml document.
Parameters:
doc: the parsed xmlDocPtr of the XML document.
node: the current node.
s: to be initialised with data in doc.
Returns:
1 if all parameters are valid.
0 otherwise.
*/
xmlNodePtr getAndAssertDocRoot(xmlDocPtr doc);
/*
Retrieves the root node of the XML document,
asserting that it is a element.
Parameters:
doc: the parsed xmlDocPtr of the XML document.
Returns:
An xmlNodePtr, pointing at the root node.
NULL if root element is not found.
*/
int isXMLElement(xmlNodePtr node, const char* expectedname);
/*
Determines whether the supplied element node is the same type
as the expected element name.