<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>The Gnome Chemistry Utils: xml-utils.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3f1a4fbcec42af7c381c8030b930461d.html">libs</a> » <a class="el" href="dir_4dc46c636cfd3997b28f6cceab9d70bd.html">gcu</a>
</div>
</div>
<div class="contents">
<h1>xml-utils.h File Reference</h1><code>#include <libxml/parser.h></code><br/>
<code>#include "<a class="el" href="chemistry_8h_source.html">chemistry.h</a>"</code><br/>
<p><a href="xml-utils_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#a78bcff32bb8d0d12f3fe590cbc6ead6d">FindNodeByNameAndId</a> (xmlNodePtr node, const char *name, const char *id=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#a4fed4ea5c1bc53eaee79b3fa188b1fd0">ReadPosition</a> (xmlNodePtr node, const char *id, double *x, double *y, double *z=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#acf2845f49b5c474b70c2a09bf14f5f93">WritePosition</a> (xmlDocPtr xml, xmlNodePtr node, const char *id, double x, double y, double z=0.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#ad0b9c2d47af7dd1a2b28f762428b5687">ReadColor</a> (xmlNodePtr node, const char *id, float *red, float *green, float *blue, float *alpha=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#a68f3218601487d70a8007287b157c8eb">WriteColor</a> (xmlDocPtr xml, xmlNodePtr node, const char *id, double red, double green, double blue, double alpha=1.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#abd4f745a56d3055f962c81003e2616ac">ReadRadius</a> (xmlNodePtr node, <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> &radius)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#a73568fa0a9b8f35914f7f1555538f4b8">WriteRadius</a> (xmlDocPtr xml, xmlNodePtr node, const <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> &radius)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="xml-utils_8h.html#a7cf3c6a9f9e60023dbbc9b8c88008b80">GetStaticScale</a> (char *buf)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Some helper functions to load / save Object instances. </p>
<p>Definition in file <a class="el" href="xml-utils_8h_source.html">xml-utils.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a78bcff32bb8d0d12f3fe590cbc6ead6d"></a><!-- doxytag: member="xml-utils.h::FindNodeByNameAndId" ref="a78bcff32bb8d0d12f3fe590cbc6ead6d" args="(xmlNodePtr node, const char *name, const char *id=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlNodePtr FindNodeByNameAndId </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ReadPosition </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the current parsed XML Node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name,:</em> </td><td>the name of the searched node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id,:</em> </td><td>the id property of the node or NULL if not significant. This parameter might be omitted in the last case.</td></tr>
</table>
</dd>
</dl>
<p>Helper method used to search the xmlNode instance of name Name and with id property equal to id in the children of node. When id is NULL, the searched node does not have an id property. When id is not NULL, the searched node should be unique.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the matching node or NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a7cf3c6a9f9e60023dbbc9b8c88008b80"></a><!-- doxytag: member="xml-utils.h::GetStaticScale" ref="a7cf3c6a9f9e60023dbbc9b8c88008b80" args="(char *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char const* GetStaticScale </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf,:</em> </td><td>a string to convert to a static instance.</td></tr>
</table>
</dd>
</dl>
<p>This function is used to replace a dynamically allocated string by a static instance. It works managing a set of string instances. It is used for scale names (as for radii and electronegativity), hence its name.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a static version of buf or NULL if a new static string could not be created. </dd></dl>
</div>
</div>
<a class="anchor" id="ad0b9c2d47af7dd1a2b28f762428b5687"></a><!-- doxytag: member="xml-utils.h::ReadColor" ref="ad0b9c2d47af7dd1a2b28f762428b5687" args="(xmlNodePtr node, const char *id, float *red, float *green, float *blue, float *alpha=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadColor </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>alpha</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id,:</em> </td><td>the value of the id property of the color. This is used for Object instances having at least two colors. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>red,:</em> </td><td>a pointer to the red component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>green,:</em> </td><td>a pointer to the green component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>blue,:</em> </td><td>a pointer to the blue component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>alpha,:</em> </td><td>a pointer to the alpha component of the color or NULL if tranparency is not managed.</td></tr>
</table>
</dd>
</dl>
<p>This method can be used to load a color in an Object instance. It should be used in cunjunction with <a class="el" href="xml-utils_8h.html#a68f3218601487d70a8007287b157c8eb">WriteColor()</a> which executes the inverse operation. If id is NULL, a color with no id property will be search and parsed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a4fed4ea5c1bc53eaee79b3fa188b1fd0"></a><!-- doxytag: member="xml-utils.h::ReadPosition" ref="a4fed4ea5c1bc53eaee79b3fa188b1fd0" args="(xmlNodePtr node, const char *id, double *x, double *y, double *z=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadPosition </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>z</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id,:</em> </td><td>the value of the id property of the position. This is used for example for arrows because both the head and the tail of the arrow are positions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x,:</em> </td><td>a pointer to the x coordinate of the position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y,:</em> </td><td>a pointer to the y coordinate of the position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>z,:</em> </td><td>a pointer to the z coordinate of the position or NULL for 2D objects.</td></tr>
</table>
</dd>
</dl>
<p>This method can be used to load the coordinates of a point in an Object instance. It should be used in cunjunction with <a class="el" href="xml-utils_8h.html#acf2845f49b5c474b70c2a09bf14f5f93">WritePosition()</a> which executes the inverse operation. If id is NULL, a position with no id property will be search and parsed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abd4f745a56d3055f962c81003e2616ac"></a><!-- doxytag: member="xml-utils.h::ReadRadius" ref="abd4f745a56d3055f962c81003e2616ac" args="(xmlNodePtr node, GcuAtomicRadius &radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadRadius </td>
<td>(</td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> & </td>
<td class="paramname"> <em>radius</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>radius,:</em> </td><td>a <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> structure.</td></tr>
</table>
</dd>
</dl>
<p>This function parses the XML node representing a radius (written using <a class="el" href="xml-utils_8h.html#a73568fa0a9b8f35914f7f1555538f4b8">WriteRadius()</a>) and fills the fields in the <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> structure with the data parsed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a68f3218601487d70a8007287b157c8eb"></a><!-- doxytag: member="xml-utils.h::WriteColor" ref="a68f3218601487d70a8007287b157c8eb" args="(xmlDocPtr xml, xmlNodePtr node, const char *id, double red, double green, double blue, double alpha=1.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool WriteColor </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"> <em>xml</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>red</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>green</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>blue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>alpha</em> = <code>1.0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xml,:</em> </td><td>a pointer to the xmlDoc used to serialize the document. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id,:</em> </td><td>the value of the id property of the color. This is used for Object instances having at least two colors. of the arrow are positions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>red,:</em> </td><td>the red component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>green,:</em> </td><td>the green component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>blue,:</em> </td><td>the blue component of the color. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>alpha,:</em> </td><td>the alpha component of the color.</td></tr>
</table>
</dd>
</dl>
<p>Save a color as an XML node added to the children of node. This color can then be parsed using <a class="el" href="xml-utils_8h.html#ad0b9c2d47af7dd1a2b28f762428b5687">ReadColor()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="acf2845f49b5c474b70c2a09bf14f5f93"></a><!-- doxytag: member="xml-utils.h::WritePosition" ref="acf2845f49b5c474b70c2a09bf14f5f93" args="(xmlDocPtr xml, xmlNodePtr node, const char *id, double x, double y, double z=0.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool WritePosition </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"> <em>xml</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>z</em> = <code>0.0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>WritePosition </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xml,:</em> </td><td>a pointer to the xmlDoc used to serialize the document. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id,:</em> </td><td>the value of the id property of the position. This is used for example for arrows because both the head and the tail of the arrow are positions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x,:</em> </td><td>the x coordinate of the position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y,:</em> </td><td>the y coordinate of the position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>z,:</em> </td><td>the z coordinate of the position.</td></tr>
</table>
</dd>
</dl>
<p>Save a position as an XML node added to the children of node. This position can then be parsed using <a class="el" href="xml-utils_8h.html#a4fed4ea5c1bc53eaee79b3fa188b1fd0">ReadPosition()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a73568fa0a9b8f35914f7f1555538f4b8"></a><!-- doxytag: member="xml-utils.h::WriteRadius" ref="a73568fa0a9b8f35914f7f1555538f4b8" args="(xmlDocPtr xml, xmlNodePtr node, const GcuAtomicRadius &radius)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool WriteRadius </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"> <em>xml</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> & </td>
<td class="paramname"> <em>radius</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xml,:</em> </td><td>a pointer to the xmlDoc used to serialize the document. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node,:</em> </td><td>a pointer to the xmlNode representing an Object instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>radius,:</em> </td><td>a <a class="el" href="structGcuAtomicRadius.html">GcuAtomicRadius</a> structure.</td></tr>
</table>
</dd>
</dl>
<p>Save a radius as an XML node added to the children of node. This radius can then be parsed using <a class="el" href="xml-utils_8h.html#abd4f745a56d3055f962c81003e2616ac">ReadRadius()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success and false on failure. </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:53 2009 for The Gnome Chemistry Utils by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
f37f2c0b149d5391818dc5157943cda0
>
files
>
546
