diff options
Diffstat (limited to 'Documentation/api/html/hkl-hkl-source-private.html')
-rw-r--r-- | Documentation/api/html/hkl-hkl-source-private.html | 320 |
1 files changed, 0 insertions, 320 deletions
diff --git a/Documentation/api/html/hkl-hkl-source-private.html b/Documentation/api/html/hkl-hkl-source-private.html deleted file mode 100644 index 4c3ec75..0000000 --- a/Documentation/api/html/hkl-hkl-source-private.html +++ /dev/null @@ -1,320 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>hkl-source-private: hkl Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> -<link rel="home" href="index.html" title="hkl Reference Manual"> -<link rel="up" href="ch01.html" title="[Insert title here]"> -<link rel="prev" href="hkl-hkl-sample-private.html" title="hkl-sample-private"> -<link rel="next" href="hkl-hkl-type-builtins.html" title="hkl-type-builtins"> -<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"> -<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#hkl-hkl-source-private.description" class="shortcut">Description</a></span> -</td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="hkl-hkl-sample-private.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="hkl-hkl-type-builtins.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="hkl-hkl-source-private"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="hkl-hkl-source-private.top_of_page"></a>hkl-source-private</span></h2> -<p>hkl-source-private</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="hkl-hkl-source-private.functions"></a><h2>Functions</h2> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> -</colgroup> -<tbody> -<tr> -<td class="function_type"> -<a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="returnvalue">HklSource</span></a> * -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-dup" title="hkl_source_dup ()">hkl_source_dup</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-free" title="hkl_source_free ()">hkl_source_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-init" title="hkl_source_init ()">hkl_source_init</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-cmp" title="hkl_source_cmp ()">hkl_source_cmp</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-compute-ki" title="hkl_source_compute_ki ()">hkl_source_compute_ki</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">double</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-get-wavelength" title="hkl_source_get_wavelength ()">hkl_source_get_wavelength</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-source-private.html#hkl-source-fprintf" title="hkl_source_fprintf ()">hkl_source_fprintf</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-source-private.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="name"> -<col class="description"> -</colgroup> -<tbody> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="hkl-hkl-source-private.html#HKL-SOURCE-DEFAULT-WAVE-LENGTH:CAPS" title="HKL_SOURCE_DEFAULT_WAVE_LENGTH">HKL_SOURCE_DEFAULT_WAVE_LENGTH</a></td> -</tr> -<tr> -<td class="datatype_keyword">struct</td> -<td class="function_name"><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource">HklSource</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-source-private.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="hkl-hkl-source-private.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="hkl-source-dup"></a><h3>hkl_source_dup ()</h3> -<pre class="programlisting"><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="returnvalue">HklSource</span></a> * -hkl_source_dup (<em class="parameter"><code>const <a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> *self</code></em>);</pre> -<p>copy constructor -TODO test</p> -<div class="refsect3"> -<a name="hkl-source-dup.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>the <span class="type">Hklsource</span> to copy</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-free"></a><h3>hkl_source_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -hkl_source_free (<em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> *self</code></em>);</pre> -<p>destructor -TODO: test</p> -<div class="refsect3"> -<a name="hkl-source-free.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>the <span class="type">Hklsource</span> to delete</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-init"></a><h3>hkl_source_init ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -hkl_source_init (<em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">double</span> wave_length</code></em>, - <em class="parameter"><code><span class="type">double</span> x</code></em>, - <em class="parameter"><code><span class="type">double</span> y</code></em>, - <em class="parameter"><code><span class="type">double</span> z</code></em>);</pre> -<p>initialize the <a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a></p> -<div class="refsect3"> -<a name="hkl-source-init.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>the <span class="type">Hklsource</span> to initialize</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>wave_length</p></td> -<td class="parameter_description"><p>the wave length to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>x</p></td> -<td class="parameter_description"><p>x coordinates of the ki vector</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>y</p></td> -<td class="parameter_description"><p>y coordinates of the ki vector</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>z</p></td> -<td class="parameter_description"><p>z coordinates of the ki vector</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="hkl-source-init.returns"></a><h4>Returns</h4> -<p> HKL_SUCCESS if everythongs goes fine, HKL_FAIL otherwise</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-cmp"></a><h3>hkl_source_cmp ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -hkl_source_cmp (<em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> const *self</code></em>, - <em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> const *s</code></em>);</pre> -<p>compare two sources</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="hkl-source-cmp.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>1st <span class="type">Hklsource</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>s</p></td> -<td class="parameter_description"><p>2nd <span class="type">Hklsource</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-compute-ki"></a><h3>hkl_source_compute_ki ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -hkl_source_compute_ki (<em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> const *self</code></em>, - <em class="parameter"><code><a class="link" href="hkl-hkl.html#HklVector" title="struct HklVector"><span class="type">HklVector</span></a> *ki</code></em>);</pre> -<p>compute the ki hkl_vector</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="hkl-source-compute-ki.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody><tr> -<td class="parameter_name"><p>ki</p></td> -<td class="parameter_description"><p>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-get-wavelength"></a><h3>hkl_source_get_wavelength ()</h3> -<pre class="programlisting"><span class="returnvalue">double</span> -hkl_source_get_wavelength (<em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> const *self</code></em>);</pre> -<p>get the wave_length</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="hkl-source-get-wavelength.returns"></a><h4>Returns</h4> -<p> the wave_length</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="hkl-source-fprintf"></a><h3>hkl_source_fprintf ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -hkl_source_fprintf (<em class="parameter"><code><span class="type">FILE</span> *f</code></em>, - <em class="parameter"><code><a class="link" href="hkl-hkl-source-private.html#HklSource" title="struct HklSource"><span class="type">HklSource</span></a> const *self</code></em>);</pre> -<p>printf the source</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -</div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-source-private.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="HKL-SOURCE-DEFAULT-WAVE-LENGTH:CAPS"></a><h3>HKL_SOURCE_DEFAULT_WAVE_LENGTH</h3> -<pre class="programlisting">#define HKL_SOURCE_DEFAULT_WAVE_LENGTH (1.54) -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="HklSource"></a><h3>struct HklSource</h3> -<pre class="programlisting">struct HklSource { - double wave_length; - HklVector direction; -}; -</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.27</div> -</body> -</html>
\ No newline at end of file |