diff options
Diffstat (limited to 'Documentation/api/html/hkl-hkl-detector-private.html')
-rw-r--r-- | Documentation/api/html/hkl-hkl-detector-private.html | 153 |
1 files changed, 0 insertions, 153 deletions
diff --git a/Documentation/api/html/hkl-hkl-detector-private.html b/Documentation/api/html/hkl-hkl-detector-private.html deleted file mode 100644 index 6cbf88a..0000000 --- a/Documentation/api/html/hkl-hkl-detector-private.html +++ /dev/null @@ -1,153 +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-detector-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-axis-private.html" title="hkl-axis-private"> -<link rel="next" href="hkl-hkl-factory-private.html" title="hkl-factory-private"> -<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-detector-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-axis-private.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="hkl-hkl-factory-private.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="hkl-hkl-detector-private"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="hkl-hkl-detector-private.top_of_page"></a>hkl-detector-private</span></h2> -<p>hkl-detector-private</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="hkl-hkl-detector-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.html#HklDetector" title="HklDetector"><span class="returnvalue">HklDetector</span></a> * -</td> -<td class="function_name"> -<a class="link" href="hkl-hkl-detector-private.html#hkl-detector-new" title="hkl_detector_new ()">hkl_detector_new</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-detector-private.html#hkl-detector-attach-to-holder" title="hkl_detector_attach_to_holder ()">hkl_detector_attach_to_holder</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-detector-private.html#hkl-detector-compute-kf" title="hkl_detector_compute_kf ()">hkl_detector_compute_kf</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-detector-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="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector">HklDetector</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-detector-private.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="hkl-hkl-detector-private.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="hkl-detector-new"></a><h3>hkl_detector_new ()</h3> -<pre class="programlisting"><a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="returnvalue">HklDetector</span></a> * -hkl_detector_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Create a new default <a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="type">HklDetector</span></a></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> -<hr> -<div class="refsect2"> -<a name="hkl-detector-attach-to-holder"></a><h3>hkl_detector_attach_to_holder ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -hkl_detector_attach_to_holder (<em class="parameter"><code><a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="type">HklDetector</span></a> *self</code></em>);</pre> -<p>attach the <a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="type">HklDetector</span></a> to an <a class="link" href="hkl-hkl-geometry-private.html#HklHolder" title="struct HklHolder"><span class="type">HklHolder</span></a></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> -<hr> -<div class="refsect2"> -<a name="hkl-detector-compute-kf"></a><h3>hkl_detector_compute_kf ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -hkl_detector_compute_kf (<em class="parameter"><code><a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="type">HklDetector</span></a> const *self</code></em>, - <em class="parameter"><code><a class="link" href="hkl-hkl.html#HklGeometry" title="HklGeometry"><span class="type">HklGeometry</span></a> *g</code></em>);</pre> -<p>Compute the kf vector of the <a class="link" href="hkl-hkl.html#HklDetector" title="HklDetector"><span class="type">HklDetector</span></a></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-detector-compute-kf.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>g</p></td> -<td class="parameter_description"><p>the diffractometer <a class="link" href="hkl-hkl.html#HklGeometry" title="HklGeometry"><span class="type">HklGeometry</span></a> use to compute kf. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>kf</p></td> -<td class="parameter_description"><p>the <a class="link" href="hkl-hkl.html#HklVector" title="struct HklVector"><span class="type">HklVector</span></a> fill with the kf coordinates. </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 class="refsect3"> -<a name="hkl-detector-compute-kf.returns"></a><h4>Returns</h4> -<p> HKL_SUCCESS if everythongs goes fine. HKL_FAIL otherwise.</p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="hkl-hkl-detector-private.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="HklDetector"></a><h3>HklDetector</h3> -<pre class="programlisting">typedef struct { - size_t idx; - HklHolder const *holder; -} HklDetector; -</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.27</div> -</body> -</html>
\ No newline at end of file |